===== Bonzo

.. image:: https://bonzo.readthedocs.org/en/latest/_images/bonzo_sigil.png :align: center :alt: John Bonham's sigil three intersecting circles

About

Bonzo is a Python SMTP Server using the asynchronous network library of Tornado_. And it's actually a port of Python's smtpd_ module.

.. image:: https://travis-ci.org/puentesarrin/bonzo.png :target: https://travis-ci.org/puentesarrin/bonzo :alt: Travis CI status

.. image:: https://coveralls.io/repos/puentesarrin/bonzo/badge.png :target: https://coveralls.io/r/puentesarrin/bonzo :alt: Coveralls status

.. image:: https://pypip.in/v/bonzo/badge.png :target: https://pypi.python.org/pypi/bonzo :alt: Latest PyPI version

.. image:: https://pypip.in/d/bonzo/badge.png :target: https://pypi.python.org/pypi/bonzo :alt: Number of PyPI downloads

Hello, world

Here is a simple "Hello, world" example SMTP server for Bonzo:

.. code-block:: python

import tornado.ioloop import bonzo.smtp

class Handler(bonzo.smtp.RequestHandler):

   def data(self):
       print(self.request.message)

application = bonzo.smtp.Application(Handler)

if name == 'main': application.listen(2525) tornado.ioloop.IOLoop.current().start()

Installation

You can to use pip_ to install Bonzo:

.. code-block:: bash

$ pip install bonzo

Or using last source:

.. code-block:: bash

$ pip install git+https://github.com/puentesarrin/bonzo.git

Documentation

Sphinx_ is needed to generate the documentation. Documentation can be generated by issuing the following commands:

.. code-block:: bash

$ cd docs $ make html

Or simply:

.. code-block:: bash

$ python setup.py doc

Also, the current documentation can be found at ReadTheDocs_.

License

Bonzo is available under the |apache-license|_.

.. note::

Logo credits: Image created by Freakofnurture_ (Wikimedia user), released into the public domain (|image-source|_).

.. _Tornado: http://tornadoweb.org .. _smtpd: http://docs.python.org/library/smtpd.html .. _pip: http://pypi.python.org/pypi/pip .. _Sphinx: http://sphinx-doc.org .. _ReadTheDocs: https://bonzo.readthedocs.org .. _apache-license: http://www.apache.org/licenses/LICENSE-2.0.html .. |apache-license| replace:: Apache License, Version 2.0 .. _Freakofnurture: http://commons.wikimedia.org/wiki/User:Freakofnurture .. _image-source: http://commons.wikimedia.org/wiki/File:Zoso_John_Bonham_sigil_three_intersecting_circles.svg .. |image-source| replace:: source