Getting started

Source code

This project’s sources can be found at Github: https://github.com/PyGithub/PyGithub

Coding style

PyGithub adopts the black coding style.

To manually format the code:

pre-commit run --all-files --show-diff-on-failure
mypy github tests

If you use tox:

tox -e lint

Pre-commit plugin

To forget about coding style and let pre-commit fix your flake8/isort/black issue:

pre-commit install

That’s it!

Build documentation locally

You can build the documentation with Sphinx:

pip install -r requirements/docs.txt
sphinx-build doc build

If you use tox:

tox -edocs