rfproto


Namerfproto JSON
Version 0.0.18 PyPI version JSON
download
home_pageNone
SummaryPython for RF and SDR prototyping.
upload_time2025-07-20 19:29:51
maintainerNone
docs_urlNone
authorNone
requires_python>=3.8
licenseNone
keywords rf sdr prototyping
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # rfproto

[![CI Pipeline](https://github.com/JohnnyGOX17/rfproto/actions/workflows/ci.yml/badge.svg)](https://github.com/JohnnyGOX17/rfproto/actions/workflows/ci.yml)
[![PyPI - Version](https://badge.fury.io/py/rfproto.svg)](https://badge.fury.io/py/rfproto)
![PyPI - License](https://img.shields.io/pypi/l/rfproto)
[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](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/d2/d0/61edf71e0664e6632fd77cc97e679e16a24866d01dffb1a0d4e0f30ecade/rfproto-0.0.18.tar.gz",
    "platform": null,
    "description": "# rfproto\n\n[![CI Pipeline](https://github.com/JohnnyGOX17/rfproto/actions/workflows/ci.yml/badge.svg)](https://github.com/JohnnyGOX17/rfproto/actions/workflows/ci.yml)\n[![PyPI - Version](https://badge.fury.io/py/rfproto.svg)](https://badge.fury.io/py/rfproto)\n![PyPI - License](https://img.shields.io/pypi/l/rfproto)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](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.18",
    "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": null,
            "digests": {
                "blake2b_256": "59c5f2e8d3f56d497ba35909a558009520a04f8b5302163879a6925df6e9db61",
                "md5": "4124a2b7918e302745a0ba6f3dfa4f36",
                "sha256": "e7889da533ffa0100d558b58ac57d0606cff077d3d785c600c37a8a02a387d23"
            },
            "downloads": -1,
            "filename": "rfproto-0.0.18-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "4124a2b7918e302745a0ba6f3dfa4f36",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 31918,
            "upload_time": "2025-07-20T19:29:50",
            "upload_time_iso_8601": "2025-07-20T19:29:50.207074Z",
            "url": "https://files.pythonhosted.org/packages/59/c5/f2e8d3f56d497ba35909a558009520a04f8b5302163879a6925df6e9db61/rfproto-0.0.18-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "d2d061edf71e0664e6632fd77cc97e679e16a24866d01dffb1a0d4e0f30ecade",
                "md5": "bad5cc3a68363f1a9c5e5372947e6e1b",
                "sha256": "95b760a14f4d80633324eafb2ba438288dd464a3b487195b9fc6583d7c5845ac"
            },
            "downloads": -1,
            "filename": "rfproto-0.0.18.tar.gz",
            "has_sig": false,
            "md5_digest": "bad5cc3a68363f1a9c5e5372947e6e1b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 30269,
            "upload_time": "2025-07-20T19:29:51",
            "upload_time_iso_8601": "2025-07-20T19:29:51.240142Z",
            "url": "https://files.pythonhosted.org/packages/d2/d0/61edf71e0664e6632fd77cc97e679e16a24866d01dffb1a0d4e0f30ecade/rfproto-0.0.18.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-07-20 19:29:51",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "JohnnyGOX17",
    "github_project": "rfproto",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "rfproto"
}
        
Elapsed time: 1.01368s