Developers

This page is for developers of the sigmf-python module.

Install

To install the latest git release, build from source:

$ git clone https://github.com/sigmf/sigmf-python.git
$ cd sigmf-python
$ pip install .

This library contains many tests in the tests/ folder. These can all be run locally:

$ coverage run

Or tests can be run within a temporary environment on all supported python versions:

$ tox run

To run a single (perhaps new) test that may be needed verbosely:

$ pytest -rA tests/test_archive.py

To lint the entire project and get suggested changes:

$ pylint sigmf tests

To autoformat the entire project according to our coding standard:

$ black sigmf tests # autoformat entire project
$ isort sigmf tests # format imports for entire project

To build the docs and host locally:

$ cd docs
$ pip install -r requirements.txt
$ make clean
$ make html
$ python3 -m http.server --directory build/html/

Issues can be addressed by opening an issue or by forking the project and submitting a pull request.