Using SimplePlugin
==================

To use SimplePlugin in your plugin, first you need to install SimplePlugin module addon in Kodi.
An installable ZIP can be downloaded from `Releases`_ tab of this repository.
I also plan to submit SimplePlugin module addon to the Kodi official repo.

Then you need to add the module in the `requires`_ section of your plugin's :file:`addon.xml` file as a dependency:

.. code-block:: xml

  <requires>
    ...
    <import addon="script.module.simpleplugin" version="1.6"/>
    ...
  </requires>

After that you can import SimplePlugin classes in your plugin's Python code and use them as necessary.

Alternatively, you can simply include :file:`simpleplugin.py` module into your addon.
The module is self-contained and has no external dependencies, except the Python standard library
and Kodi Python API modules.

If you are developing an addon based on SimplePlugin, you can install ``simpleplugin``
module into your development virtual environment using pip::

  $ pip install git+https://github.com/romanvm/script.module.simpleplugin.git#egg=SimplePlugin


.. _Releases: https://github.com/romanvm/script.module.simpleplugin/releases/latest
.. _requires: http://kodi.wiki/view/Addon.xml#.3Crequires.3E