Installation

Required dependencies

archeryutils is a pure python package. It can be installed using pip by executing:

pip install archeryutils

To install as a developer you should clone the repository from the online repo and install as an editable package:

git clone git@github.com:jatkinson1000/archeryutils.git
cd archeryutils
pip install -e .[dev]

Note

If you are installing in zsh you will need to use quotes for the optional dependencies:

pip install -e '.[dev]'

The dev optional dependencies combine the test, lint, and docs subgroups detailed below.

The test suite for archeryutils makes use of pytest. To run tests on a development installation run:

pytest ./

from within the base directory.

archeryutils has a series of optional dependencies that can be installed:

For developing and running the test suite on the code:

pip install -e .[test]

For applying quality control to the code:

pip install -e .[lint]

For building documentation:

pip install -e .[docs]