Contribute

You want to add some code to pyphen, launch its tests or improve its documentation? Thank you very much! Here are some tips to help you play with pyphen in good conditions.

The first step is to clone the repository, create a virtual environment and install pyphen dependencies.

git clone https://github.com/CourtBouillon/pyphen.git
cd pyphen
python -m venv venv
venv/bin/pip install -e .[doc,test]

You can then launch Python to test your changes.

venv/bin/python

Code & Issues

If you’ve found a bug in pyphen, it’s time to report it, and to fix it if you can!

You can report bugs and feature requests on GitHub. If you want to add or fix some code, please fork the repository and create a pull request, we’ll be happy to review your work.

Tests

Tests are stored in the tests folder at the top of the repository. They use the pytest library.

You can launch tests (with code coverage and lint) using the following command:

venv/bin/pytest

Documentation

Documentation is stored in the docs folder at the top of the repository. It relies on the Sphinx library.

You can build the documentation using the following command:

venv/bin/sphinx-build docs docs/_build

The documentation home page can now be found in the docs/_build/index.html file. You can open this file in a browser to see the final rendering.