If you’d like to develop
bruges, this page should help you get started.
For development, you will usually want to clone or fork the repo.
For running tests or building docs, the
dev option will install the extra dependencies.
pip install bruges[dev]
If you’d like to contribute pull requests back to the main
bruges project, please see
You can run the tests (requires
Most of the tests are
doctest tests, which are contained in the docstrings of this package’s functions. It is also possible to add test files to the
tests folder in the normal way.
Building the package#
This repo uses PEP 517-style packaging. Read more about this and about Python packaging in general.
Building the project requires
build, so first:
python -m pip install build
Then to build
python -m build
This builds both
.whl files, either of which you can install with
Building the docs#
You can build the docs with the following command in the
sphinx-build directly, because there are other commands in the
Makefile that would not run.
There is a continuous integration script to update welly’s docs on all published releases.
This repo has two GitHub ‘workflows’ or ‘actions’:
main: Run all tests on all version of Python. This is the Build and test workflow.
Publish a new release: Build and upload to PyPI. This is the Publish to PyPI workflow. Publish using the GitHub interface, for example (read more).