64 lines
1.4 KiB
ReStructuredText
64 lines
1.4 KiB
ReStructuredText
#######
|
|
MailBot
|
|
#######
|
|
|
|
.. image:: https://secure.travis-ci.org/novagile/mailbot.png?branch=master
|
|
:alt: Build Status
|
|
:target: https://travis-ci.org/novagile/mailbot
|
|
|
|
MailBot: register callbacks to be executed on mail reception.
|
|
|
|
* Authors: Mathieu Agopian and `contributors
|
|
<https://github.com/novagile/mailbot/contributors>`_
|
|
* Licence: BSD
|
|
* Compatibility: Django 1.4+, python2.6 up to python3.3
|
|
* Project URL: https://github.com/novagile/mailbot
|
|
* Documentation: http://mailbot.rtfd.org/
|
|
|
|
|
|
Hacking
|
|
=======
|
|
|
|
Setup your environment:
|
|
|
|
::
|
|
|
|
git clone https://github.com/novagile/mailbot.git
|
|
cd mailbot
|
|
|
|
Hack and run the tests using `Tox <https://pypi.python.org/pypi/tox>`_ to test
|
|
on all the supported python and Django versions:
|
|
|
|
::
|
|
|
|
make test
|
|
|
|
There's also a live test suite, that you may run using the following command:
|
|
|
|
::
|
|
|
|
make livetest
|
|
|
|
Please note that to run live tests, you need to create a
|
|
``livetest_settings.py`` file with the following content:
|
|
|
|
::
|
|
|
|
# mandatory
|
|
HOST = 'your host here'
|
|
USERNAME = 'your username here'
|
|
PASSWORD = 'your password here'
|
|
|
|
# optional
|
|
# check http://imapclient.readthedocs.org/en/latest/#imapclient.IMAPClient)
|
|
PORT = 143 # port number, usually 143 or 993 if ssl is enabled
|
|
USE_UID = True
|
|
SSL = False
|
|
STREAM = False
|
|
|
|
For convenience, you can copy the provided sample, and modify it:
|
|
|
|
::
|
|
|
|
$ cp livetest_settings.py.sample livetest_settings.py
|