Using Virtualenv is recommended when evaluating or running locally.

Installation is simple with pip:

pip install plectrum

Installing from source

You can also build and install manually from the source for more control.

First obtain a copy of the source by either downloading or cloning the public repository:

$ git clone

Then build and install the package into your current Python environment:

pip install .

If actively developing, perform an editable install instead. This will link the installed package to the project source reflecting any local changes made:

pip install -e .


To also enable building documentation and running tests from source, use the following command to ensure that the relevant ‘extra’ packages are installed:

pip install -e ".[dev]"

Alternatively, just build locally and manage yourself:

python build

Building documentation from source

Ensure the ‘extra’ packages required for building the documentation are installed:

pip install -e ".[doc]"

Then build the documentation:

python build_sphinx

View the result in your browser:


Running tests against the source

Ensure the ‘extra’ packages required for running the tests are installed:

pip install -e ".[test]"

Then run the tests as follows:

python -q test

A coverage report can also be generated when running tests:

python -q test --addopts "--cov --cov-report=html"

View the generated report at: