A simple python plugin framework
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
docs
src/livetribe
tests
.gitignore
.travis.yml
LICENSE.txt
MANIFEST.in
NOTICE.txt
README.rst
requirements.txt
setup.cfg
setup.py

README.rst

LiveTribe Plugins

LiveTribe's simple Python plugin framework.

https://secure.travis-ci.org/maguro/livetribe-plugins.png?branch=master

See the LiveTribe site for more information. See github for the latest source.

About

The LiveTribe Plugins distribution contains a simple Python plugin framework. It defines no classes that need to be implemented nor imposes arbitrary lifecycle events or special plugin information files.

Inspired by Calvin Spealman's straight plugin, https://github.com/ironfroggy/straight.plugin.

Issues / Questions / Feedback

Any issues with, questions about, or feedback for LiveTribe Plugins should be sent to the livetribe-user list on LiveTribe's Mailing Lists. For confirmed issues or feature requests, open a case on jira. Please do not e-mail any of the LiveTribe developers directly with issues or questions - you're more likely to get an answer on the list.

Installation

If you have distribute installed you should be able to do easy_install livetribe-plugins to install LiveTribe Plugins. Otherwise you can download the project source and do python setup.py install to install.

Dependencies

The LiveTribe Plugins distribution is supported and tested on Python 2.x (where x >= 6) and Python 3.x (where x >= 2).

Additional dependencies are:

  • (to generate documentation) sphinx
  • (to auto-discover tests) nose

Examples

Here's a basic example (for more see the examples section of the docs):

from livetribe.plugins import collect_plugin_classes
from acme.framework import Factory

for plugin in collect_plugin_classes('acme.plugins', subclasses_of=Factory, recurse=True):
    instance = plugin()
    instance.work()

Documentation

Full Documentation: http://readthedocs.org/docs/livetribe-plugins.

You will need sphinx installed to generate the documentation. Documentation can be generated by running python setup.py doc. Generated documentation can be found in the doc/build/html/ directory.

Testing

The easiest way to run the tests is to install nose (easy_install nose) and run nosetests or python setup.py test in the root of the distribution. Tests are located in the tests/ directory.