NOTE: Version 0.6.x is backward-compatible with 0.5.x for the most part, with some caveats. The first few releases will be removing a bunch of obsolete and deprecated code and replacing some of the internals of the base worker. While this will almost certainly not break the majority of things built on vumi, old code or code that relies too heavily on the details of worker setup may need to be fixed.

Documentation available online at http://vumi.readthedocs.org/ and in the docs directory of the repository.

To build the docs locally:

$ virtualenv --no-site-packages ve/
$ source ve/bin/activate
(ve)$ pip install Sphinx
(ve)$ cd docs
(ve)$ make html

You'll find the docs in docs/_build/index.html

You can contact the Vumi development team in the following ways:

• via email by joining the the [email protected] mailing list
• on irc in #vumi on the Freenode IRC network

Issues can be filed in the GitHub issue tracker. Please don't use the issue tracker for general support queries.