Py-notify Documentation

Tutorial, API Reference & an Example

Py-notify comes with a tutorial. It is not complete, but still is a good way to start. For more in-depth understanding of Py-notify, look at the API reference. Most methods and properties are already well-documented. Finally, there is one (but elaborate) example of Py-notify usage in ‘examples’ directory of the source distribution.

You can get the very same documentation as is available on the site by checking out the current Py-notify version from source code repository and running ‘generate-tutorial.py’ and/or ‘generate-reference.py’ scripts at the top level. Note, however, that the latter script has only been tested with recent 3.0 beta version of Epydoc and is not guaranteed to work with earlier versions. The former script should work with any non-ancient version of Docutils.

API reference is also available for download as a tarball.