_____        _____  _             _       
 |  __ \      |  __ \| |           (_)      
 | |__) |_   _| |__) | |_   _  __ _ _ _ __  
 |  ___/| | | |  ___/| | | | |/ _` | | '_ \ 
 | |    | |_| | |    | | |_| | (_| | | | | |
 |_|     \__, |_|    |_|\__,_|\__, |_|_| |_|
          __/ |                __/ |        
         |___/                |___/         

     a generic way to get plugins...
    


PyPlugin README
==============

Author
=======

Martin N. Alderete ( malderete<at>gmail<dot>com )
Feel free to send me emails with suggestion and comments!


Overview
========

Welcome to PyPlugin.
It is a small library to get a simple plugin architecture in your python programs.
It was developed because I think that plugin architecture is a excellent approach for many programs.
I do not like copy and paste code! because of that I created this library instead.
PyPlugin is developed using TDD (test driven development) process and DI (dependency injection)  pattern to get a better and more testeable source code.


Features
========

Configurable.
Extensible.
Event Logging.
Auto discover plugins.
Load and unload plugins.


Documentation
=============

The documentation is in the source, so you should check in the "doc" directory.
Developer *remember* run the tool for create documentation *after* commit changes.

PyPlugin's documentation is written using epydoc style, so you have to use the command below:

epydoc --html -o docs pyplugin



Installation
============

Untar the packages(if you have already downloaded it!), otherwise install from GIT repository.
  
  $ cd PyPlugin
  $ sudo python setup.py install

Check if the installation was ok.
  $ python
  $ import pyplugin


Get involve
===========

If you want to contribute, do not doubt on contact me for information about the source code.	
*Please* always keep in mind "Test driven development" and "Dependency injection", to produce a  better and more testeable source code.


Dependencies
============

Python 2.6 or newest

#EOF