| Name | rfproto JSON |
| Version |
0.0.15
JSON |
| download |
| home_page | None |
| Summary | Python for RF and SDR prototyping. |
| upload_time | 2024-10-15 00:00:35 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
rf
sdr
prototyping
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# rfproto
[](https://github.com/JohnnyGOX17/rfproto/actions/workflows/ci.yml)
[](https://badge.fury.io/py/rfproto)
[](https://github.com/psf/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](https://john-gentile.com/kb/programming_languages/python.html#virtual-environments-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](https://squidfunk.github.io/mkdocs-material/), preview with `$ mkdocs serve -a localhost:8888`. Publishes with GitHub action as well.
## TODO
See auto-generated [TODO.md](./TODO.md).
- [ ] Look at https://github.com/veeresht/CommPy since its unmaintained
- [ ] Filtering/convolution kernels like https://joht.github.io/johtizen/algorithm/2022/10/22/a-different-approach-to-convolution.html and https://dsp.stackexchange.com/questions/15412/fir-filters-direct-form-transposed-fir
Raw data
{
"_id": null,
"home_page": null,
"name": "rfproto",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "RF, SDR, prototyping",
"author": null,
"author_email": "John Gentile <johncgentile17@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/fa/7c/e1df5fa1b4353c00fbf0ee3d570d540c2f8f488b90a83dc9612a71be3949/rfproto-0.0.15.tar.gz",
"platform": null,
"description": "# rfproto\n\n[](https://github.com/JohnnyGOX17/rfproto/actions/workflows/ci.yml)\n[](https://badge.fury.io/py/rfproto)\n\n[](https://github.com/psf/black)\n\nPython 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.\n\n\n## Developing\n\n### Building & CI\n\n* Install editable local version (preferably within a [venv](https://john-gentile.com/kb/programming_languages/python.html#virtual-environments-venv)) with all optional packages for testing with `$ pip install --upgrade -e .[docs,test]` (add `--user` if not in `venv`).\n* Install pre-commit checks with `$ ln -sf ../../scripts/pre-commit ./.git/hooks/pre-commit`\n* 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.\n\n### Testing\n\nRun test suite with `$ ./scripts/run-tests.sh`\n\n### Documentation\n\nDocumentation uses [mkdocs-material](https://squidfunk.github.io/mkdocs-material/), preview with `$ mkdocs serve -a localhost:8888`. Publishes with GitHub action as well.\n\n## TODO\n\nSee auto-generated [TODO.md](./TODO.md).\n\n- [ ] Look at https://github.com/veeresht/CommPy since its unmaintained\n- [ ] Filtering/convolution kernels like https://joht.github.io/johtizen/algorithm/2022/10/22/a-different-approach-to-convolution.html and https://dsp.stackexchange.com/questions/15412/fir-filters-direct-form-transposed-fir\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python for RF and SDR prototyping.",
"version": "0.0.15",
"project_urls": {
"Documentation": "https://johnnygox17.github.io/rfproto/",
"Homepage": "https://github.com/JohnnyGOX17/rfproto",
"Issues": "https://github.com/JohnnyGOX17/rfproto/issues",
"Repository": "https://github.com/JohnnyGOX17/rfproto.git"
},
"split_keywords": [
"rf",
" sdr",
" prototyping"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "92a433aa6dd0cda552ad4f574ac2cf2caaa0a86e60dd274e6bfc52f6a21a492c",
"md5": "83e20b0e885138f06f5f26d62681cfde",
"sha256": "cc53424ddca03e307316a9a121e602a92dcc140b62211d93206f338d22c41d0c"
},
"downloads": -1,
"filename": "rfproto-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83e20b0e885138f06f5f26d62681cfde",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 31290,
"upload_time": "2024-10-15T00:00:33",
"upload_time_iso_8601": "2024-10-15T00:00:33.388642Z",
"url": "https://files.pythonhosted.org/packages/92/a4/33aa6dd0cda552ad4f574ac2cf2caaa0a86e60dd274e6bfc52f6a21a492c/rfproto-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa7ce1df5fa1b4353c00fbf0ee3d570d540c2f8f488b90a83dc9612a71be3949",
"md5": "5751859c0f4ec544237ad6aae9ff54fc",
"sha256": "76cce9b4dfbd945221e1488fdf6020f619da85eb7bff04bf36e93d32fe9d6e0b"
},
"downloads": -1,
"filename": "rfproto-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "5751859c0f4ec544237ad6aae9ff54fc",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 29695,
"upload_time": "2024-10-15T00:00:35",
"upload_time_iso_8601": "2024-10-15T00:00:35.127121Z",
"url": "https://files.pythonhosted.org/packages/fa/7c/e1df5fa1b4353c00fbf0ee3d570d540c2f8f488b90a83dc9612a71be3949/rfproto-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 00:00:35",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "JohnnyGOX17",
"github_project": "rfproto",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "rfproto"
}
