Metadata-Version: 1.0
Name: livetribe-plugins
Version: 1.0.0dev
Summary: A simple Python plugin framework.
Home-page: http://github.com/livetribe/livetribe-plugins/
Author: Alan D. Cabrera
Author-email: dev@livetribe.codehaus.org
License: Apache Software License (http://www.apache.org/licenses/LICENSE-2.0)
Description: =================
        LiveTribe Plugins
        =================
        
        .. rubric:: LiveTribe's simple Python plugin framework.
        
        .. image:: https://secure.travis-ci.org/maguro/livetribe-plugins.png?branch=master
           :target: http://travis-ci.org/maguro/livetribe-plugins
        
        See `the LiveTribe site <http://www.livetribe.org>`_ for more information.
        See `github <http://github.com/livetribe/livetribe-plugins/tree>`_ 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
        <http://www.livetribe.org/Mailing+Lists>`_. For confirmed issues or feature
        requests, open a case on `jira <http://jira.codehaus.org/browse/LIVETRIBE>`_.
        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
        <http://packages.python.org/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 <http://somethingaboutorange.com/mrl/projects/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
        <http://somethingaboutorange.com/mrl/projects/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.
        
        .. _sphinx: http://sphinx.pocoo.org/
        
Platform: any
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.6
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.2
Classifier: Programming Language :: Python :: 3.3
Classifier: Topic :: Software Development :: Libraries :: Python Modules
