Using pmp

You can use pmp twofold. If core functionalities satisfy your needs, simply install pmp with pip. Use it as other python modules. For more details please check instructions.

Developing pmp

During development of your projects you may need to extend or modify pmp code.

We strongly encourage you to use virtualenv during development.

Install virtualenv and test installation.

pip install virtualenv
virtualenv --version

Clone project and enter it’s directory, then create virtual environment for pmp.

git clone https://github.com/Koozco/pmp.git
cd pmp
virtualenv pmp_venv

In order to use this venv please remember to use: source pmp_venv/bin/activate

And for deactivation deactivate

Install pmp in editable mode, so all changes you make in code will be reflected in module’s behaviour.

pip install -e .

Virtual env will allow you to separate this installation and it’s dependencies from your globaly installed python.

Enjoy!

Working with docs

As a documentation tool we use Sphinx, however we stay open for any ideas suggestions, which may improve our current setup. Main file format of Sphinx is reStructuredText, but it is also possible to render Markdown in .rst files.

If you want to extend documentation, a place to start is docs/source, where are stored all sources. After adding sources, compile them with Sphinx Makefile.

cd docs
make clean html

Check the result in _build/html/index.html

Note: Depending on your OS it may be necessary not only to install sphinx by pip, but also by OS package manager.