initial commit

.gitignore

@@ -0,0 +1,15 @@
+# Local binaries (they are generated).
+bin/
+include/
+lib/
+
+# sphinx
+docs/build/
+
+# auto-generated
+*.pyc
+*.pyo
+*.egg-info
+.coverage
+.tox/
+build/

.travis.yml

@@ -0,0 +1,11 @@
+language: python
+python:
+  - "2.6"
+  - "2.7"
+  - "3.3"
+install:
+  - pip install --use-mirrors imapclient unittest2 flake8 mock
+  - python setup.py develop
+script:
+  - unit2 discover
+  - flake8 mailbot

CHANGELOG

@@ -0,0 +1,5 @@
+Changelog
+=========
+
+0.1 (unreleased)
+----------------

LICENSE

@@ -0,0 +1,33 @@
+#######
+License
+#######
+
+Copyright (c) 2013 Mathieu Agopian
+
+All rights reserved.
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+* Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+* Neither the name of the copyright holder nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

MANIFEST.in

@@ -0,0 +1,3 @@
+recursive-include mailbot *
+global-exclude *.pyc
+include VERSION README.rst CHANGELOG LICENSE

Makefile

@@ -0,0 +1,16 @@
+.PHONY: docs test clean
+
+bin/python:
+	virtualenv . --python python2
+	bin/python setup.py develop
+
+test: bin/python
+	bin/pip install tox
+	bin/tox
+
+docs:
+	bin/pip install sphinx
+	SPHINXBUILD=../bin/sphinx-build $(MAKE) -C docs html $^
+
+clean:
+	rm -rf bin .tox include/ lib/ man/ mailbot.egg-info/ build/

README.rst

@@ -0,0 +1,34 @@
+#######
+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

VERSION

@@ -0,0 +1 @@
+0.1dev

docs/Makefile

@@ -0,0 +1,155 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+ifndef SPHINXBUILD
+SPHINXBUILD   = sphinx-build
+endif
+PAPER         =
+BUILDDIR      = build
+
+# Internal variables.
+PAPEROPT_a4     = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+# the i18n builder cannot share the environment and doctrees with the others
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
+
+help:
+	@echo "Please use \`make <target>' where <target> is one of"
+	@echo "  html       to make standalone HTML files"
+	@echo "  dirhtml    to make HTML files named index.html in directories"
+	@echo "  singlehtml to make a single large HTML file"
+	@echo "  pickle     to make pickle files"
+	@echo "  json       to make JSON files"
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
+	@echo "  qthelp     to make HTML files and a qthelp project"
+	@echo "  devhelp    to make HTML files and a Devhelp project"
+	@echo "  epub       to make an epub"
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
+	@echo "  text       to make text files"
+	@echo "  man        to make manual pages"
+	@echo "  texinfo    to make Texinfo files"
+	@echo "  info       to make Texinfo files and run them through makeinfo"
+	@echo "  gettext    to make PO message catalogs"
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
+	@echo "  linkcheck  to check all external links for integrity"
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+	-rm -rf $(BUILDDIR)/*
+
+html:
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+	@echo
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+	@echo
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+	@echo
+	@echo "Build finished; now you can process the pickle files."
+
+json:
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+	@echo
+	@echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+	@echo
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+	@echo
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/mailbot.qhcp"
+	@echo "To view the help file:"
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/mailbot.qhc"
+
+devhelp:
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+	@echo
+	@echo "Build finished."
+	@echo "To view the help file:"
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/mailbot"
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/mailbot"
+	@echo "# devhelp"
+
+epub:
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+	@echo
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
+	      "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+	@echo "Running LaTeX files through pdflatex..."
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+	@echo
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+	@echo
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+texinfo:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
+	@echo "Run \`make' in that directory to run these through makeinfo" \
+	      "(use \`make info' here to do that automatically)."
+
+info:
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
+	@echo "Running Texinfo files through makeinfo..."
+	make -C $(BUILDDIR)/texinfo info
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
+
+gettext:
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
+	@echo
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
+
+changes:
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+	@echo
+	@echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+	@echo
+	@echo "Link check complete; look for any errors in the above output " \
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+	@echo "Testing of doctests in the sources finished, look at the " \
+	      "results in $(BUILDDIR)/doctest/output.txt."

docs/source/conf.py

@@ -0,0 +1,242 @@
+# -*- coding: utf-8 -*-
+#
+# django-mail-factory documentation build configuration file, created by
+# sphinx-quickstart on Wed Jan 23 17:31:52 2013.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'django-mail-factory'
+copyright = u'2013, Rémy HUBSCHER'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '0.1dev'
+# The full version, including alpha/beta/rc tags.
+release = '0.1dev'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+html_theme = 'default'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents.  If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar.  Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it.  The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'django-mail-factorydoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+latex_elements = {
+# The paper size ('letterpaper' or 'a4paper').
+#'papersize': 'letterpaper',
+
+# The font size ('10pt', '11pt' or '12pt').
+#'pointsize': '10pt',
+
+# Additional stuff for the LaTeX preamble.
+#'preamble': '',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+  ('index', 'django-mail-factory.tex', u'django-mail-factory Documentation',
+   u'Rémy HUBSCHER', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    ('index', 'django-mail-factory', u'django-mail-factory Documentation',
+     [u'Rémy HUBSCHER'], 1)
+]
+
+# If true, show URL addresses after external links.
+#man_show_urls = False
+
+
+# -- Options for Texinfo output ------------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+  ('index', 'django-mail-factory', u'django-mail-factory Documentation',
+   u'Rémy HUBSCHER', 'django-mail-factory', 'One line description of project.',
+   'Miscellaneous'),
+]
+
+# Documents to append as an appendix to all manuals.
+#texinfo_appendices = []
+
+# If false, no module index is generated.
+#texinfo_domain_indices = True
+
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
+#texinfo_show_urls = 'footnote'

docs/source/index.rst

@@ -0,0 +1,154 @@
+Welcome to MailBot's documentation!
+=======================================
+
+MailBot is a little python library that let's you execute previously registered
+callbacks on reception of emails.
+
+This allows you to do fancy things like doing API calls, running scripts,
+sending notifications, ...
+
+
+Features
+--------
+
+MailBot does its best to:
+
+* be fully tested
+* apply the pep8 recommendations
+* be lightweight, concise and readable
+
+MailBot connects to a SMTP server using the IMAP protocol, thanks to the
+excellent `IMAPClient from Menno Smits
+<http://imapclient.readthedocs.org/en/latest/>`_.
+
+
+Other resources
+---------------
+
+Fork it on: http://github.com/novagile/mailbot/
+
+Documentation: http://mailbot.rtfd.org/
+
+
+Installing
+----------
+
+From PyPI::
+
+    pip install mailbot
+
+From github::
+
+    pip install -e http://github.com/novagile/mailbot/
+
+
+Registering callbacks
+---------------------
+
+:file:`callbacks.py`:
+
+.. code-block:: python
+
+    from mailbot import register, Callback
+
+
+    class MyCallback(Callback):
+
+        def callback(self):
+            print("Mail received: {O}".format(self.subject))
+
+    register(MyCallback)
+
+By default, callbacks will be executed on each and every mail received, unless
+you specify it differently, either using the 'rules' parameter on the callback
+class, or by registering with those rules:
+
+
+Providing the rules as a parameter
+----------------------------------
+
+Here's a callback that will only be triggered if the subject matches the
+pattern 'Hello ' followed by a word:
+
+.. code-block:: python
+
+    from mailbot import register, Callback
+
+
+    class MyCallback(Callback):
+        rules = {'subject_patterns': [r'Hello (\w)']}
+
+        def callback(self):
+            print("Mail received for {0}".format(self.subject_matches[0]))
+
+    register(MyCallback)
+
+This callback will be triggered on a mail received with the subject "Hello
+Bryan", but won't if the subject is "Bye Bryan".
+
+
+Providing the rules when registering
+------------------------------------
+
+The similar functionality can be achieved using a set of rules when
+registering:
+
+.. code-block:: python
+
+    from mailbot import register, Callback
+
+
+    class MyCallback(Callback):
+
+        def callback(self):
+            print("Mail received for %s!" self.subject_matches[0])
+
+    register(MyCallback, rules={'subject_patterns': [r'Hello (\w)']})
+
+
+Specifying rules
+----------------
+
+Rules are regular expressions that will be tested against the various email
+data:
+
+* ``subject``: tested against the subject
+* ``from``: tested against the mail sender
+* ``to``: tested against each of the recipients in the "to" field
+* ``cc``: tested against each of the recipients in the "cc" field
+* ``bcc``: tested against each of the recipients in the "bcc" field
+* ``body``: tested against the (text) body of the mail
+
+If no rule are provided, for example for the "from" field, then no rule will be
+applied, and emails from any sender will potentially trigger the callback.
+
+For each piece of data (subject, from, to, cc, bcc, body), the callback class,
+once instantiated with the mail, will have a corresponding parameter
+``FOO_matches`` with all the matches from the given patterns.
+
+Here are example subjects for the subject rules:
+[``r'^Hello (\w), (.*)'``, ``r'[Hh]i (\w)!``]
+
+* 'Hello Bryan, how are you?': ``subject_matches`` == ['Bryan', 'how are you?']
+* 'Hi Bryan, how are you?': ``subject_matches`` == ['Bryan']
+* 'aloha, hi Bryan!': ``subject_matches`` == ['Bryan']
+* 'aloha Bryan': rules not respected, callback not triggered
+
+
+How does it work?
+-----------------
+
+When an email is received on the SMTP server the MailBot is connected to
+(using the IMAP protocol), it'll check all the registered callback classes and
+their rules.
+
+If each provided rule (either as a class parameter or using the register)
+matches the mail's subject, from, to, cc, bcc and body, the callback class will
+be instantiated, and its callback will be triggered.
+
+
+Contents
+--------
+
+.. toctree::
+   :maxdepth: 2

setup.py

@@ -0,0 +1,35 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+from os.path import abspath, dirname, join
+from setuptools import find_packages, setup
+
+
+def read_relative_file(filename):
+    """Returns contents of the given file, whose path is supposed relative
+    to this module."""
+    with open(join(dirname(abspath(__file__)), filename)) as f:
+        return f.read()
+
+
+if __name__ == '__main__':  # ``import setup`` doesn't trigger setup().
+    setup(name='mailbot',
+          version=read_relative_file('VERSION').strip(),
+          description="MailBot: execute callback on mail reception",
+          long_description=read_relative_file('README.rst'),
+          classifiers=['Development Status :: 3 - Alpha',
+                       'Environment :: Console',
+                       'Intended Audience :: Developers',
+                       'License :: OSI Approved :: BSD License',
+                       'Natural Language :: English',
+                       'Programming Language :: Python',
+          ],
+          keywords='mail callback',
+          author='Mathieu Agopian',
+          author_email='mathieu.agopian@gmail.com',
+          url='https://github.com/novagile/mailbot',
+          license='BSD Licence',
+          packages=find_packages(),
+          include_package_data=True,
+          zip_safe=False,
+          install_requires=['imapclient']
+    )

tox.ini

@@ -0,0 +1,16 @@
+
+[tox]
+envlist = py26, py27
+
+[testenv]
+commands =
+    python setup.py develop
+    coverage run --branch --source=mailbot unit2 discover
+    coverage report -m --omit=mailbot/tests/*
+    flake8 mailbot
+deps =
+    imapclient
+    unittest2
+    mock
+    flake8
+    coverage