rfproto

Python for RF and SDR prototyping.


Keywords
RF, SDR, prototyping
License
MIT
Install
pip install rfproto==0.0.13

Documentation

rfproto

CI Pipeline PyPI - Version PyPI - License Code style: black

Python library for RF and SDR prototyping. Helpful reuse methods for RF measurements, as well as experimenting with topics like communication systems, radar, antenna arrays, etc.

Developing

Building & CI

  • Install editable local version (preferably within a venv) with all optional packages for testing with $ pip install --upgrade -e .[docs,test] (add --user if not in venv).
  • Install pre-commit checks with $ ln -sf ../../scripts/pre-commit ./.git/hooks/pre-commit
  • Trigger GitHub action to publish to PyPI with a tagged commit (e.x. git tag -am "test auto versioning" 0.0.2) on main branch. Note versioning is also inferred from the git tag value, and this will only run on push on tag.

Testing

Run test suite with $ ./scripts/run-tests.sh

Documentation

Documentation uses mkdocs-material, preview with $ mkdocs serve -a localhost:8888. Publishes with GitHub action as well.

TODO

See auto-generated TODO.md.