Bitstream is developped on
To contribute, please open an issue or submit a pull request
for the code or documentation.
The following sections should help you to get started.
Follow the steps required to
install from sources
and make sure that you have installed all the developer dependencies
pip install -r requirements-dev.txt).
Run the Tests
To run all the tests, type
$ python test.py
If nothing happens, your version of bitstream is probably fine:
all the code snippets
in the documentation
have been checked by doctest and have correct outputs.
To find out more about these tests, run
$ python test.py -v
The bitstream project uses
to run all the tests on each new commit.
If you fork bitstream, make sure to activate Travis CI.
To add new tests, just update the documentation. Documentation
The documentation is built with
MkDocs and its
The documentation sources are markdown files located
directory and assembled according to the configuration file
Build the docs
$ mkdocs build
This command outputs HTML documentation into the