| Name | pcdr JSON |
| Version |
1.0.1
JSON |
| download |
| home_page | None |
| Summary | GNU Radio-based transmit and receive wrappers and more |
| upload_time | 2024-08-01 00:51:12 |
| maintainer | None |
| docs_url | None |
| author | james-pcdr |
| requires_python | >=3.8 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pcdr
pcdr module: https://pypi.org/project/pcdr/
### Installation
```sh
pip install pcdr
```
Note that much of the functionality also depends on GNU Radio. However, `gnuradio` is not listed in the dependencies as it is not pip-installable (as far as the author knows).
### Example usage
```python3
from pcdr.unstable.flow import OsmoSingleFreqReceiver
tuned_freq = 103.9e6
receiver = OsmoSingleFreqReceiver("hackrf=0", tuned_freq)
receiver.start()
strength = receiver.get_strength()
print(f"Strength of {tuned_freq} Hz: {strength}")
receiver.stop_and_wait()
```
-->
### Current status
We launched version 1.0.0 with nothing marked as stable (i.e., everything marked as unstable). We admit that this is unconventional, but we hope that it will allow us to improve incrementally based on experimentation, and eventually (perhaps by early to mid 2025) begin to mark some parts as stable.
### Version history; breaking changes policy
In the v1.x series, we adhere to the following:
- Everything in `pcdr._internal` should be ignored by users of this module.
- Everything in `pcdr.unstable` is in the experimentation phase and is subject to breaking changes between minor version updates.
- Everything in `pcdr.v0_compat` should be considered deprecated. As the name implies, it is kept for version 0 compatibility. It will not be changed.
- Everything else is stable. We will not intentionally make any breaking changes during the v1.x version series.
We made a significant amount of breaking changes when moving from version 0.x to version 1.0.0. If you have trouble migrating your code, please [submit an issue](https://github.com/python-can-define-radio/pcdr/issues), and we'd be happy to provide guidance.
### Repository history
The pcdr module's source used to be hosted as [a subfolder of the sdr-course repo](https://github.com/python-can-define-radio/sdr-course/tree/main/classroom_activities/Chx_Misc/Python_curric_2). On 2024 April 15, we migrated it to [its own repository](https://github.com/python-can-define-radio/pcdr). See the old repo if you'd like to refer to the commit history.
Raw data
{
"_id": null,
"home_page": null,
"name": "pcdr",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": "james-pcdr",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/e6/43/a0353ab2abcedff4585351bc741984084591520ff01daacd3634d6e86399/pcdr-1.0.1.tar.gz",
"platform": null,
"description": "# pcdr\n\npcdr module: https://pypi.org/project/pcdr/\n\n### Installation\n\n```sh\npip install pcdr\n```\n\nNote that much of the functionality also depends on GNU Radio. However, `gnuradio` is not listed in the dependencies as it is not pip-installable (as far as the author knows).\n\n### Example usage\n\n```python3\nfrom pcdr.unstable.flow import OsmoSingleFreqReceiver\ntuned_freq = 103.9e6\nreceiver = OsmoSingleFreqReceiver(\"hackrf=0\", tuned_freq)\nreceiver.start()\nstrength = receiver.get_strength()\nprint(f\"Strength of {tuned_freq} Hz: {strength}\")\nreceiver.stop_and_wait()\n```\n-->\n\n### Current status\n\nWe launched version 1.0.0 with nothing marked as stable (i.e., everything marked as unstable). We admit that this is unconventional, but we hope that it will allow us to improve incrementally based on experimentation, and eventually (perhaps by early to mid 2025) begin to mark some parts as stable.\n\n### Version history; breaking changes policy\n\nIn the v1.x series, we adhere to the following: \n\n- Everything in `pcdr._internal` should be ignored by users of this module.\n- Everything in `pcdr.unstable` is in the experimentation phase and is subject to breaking changes between minor version updates.\n- Everything in `pcdr.v0_compat` should be considered deprecated. As the name implies, it is kept for version 0 compatibility. It will not be changed.\n- Everything else is stable. We will not intentionally make any breaking changes during the v1.x version series.\n\nWe made a significant amount of breaking changes when moving from version 0.x to version 1.0.0. If you have trouble migrating your code, please [submit an issue](https://github.com/python-can-define-radio/pcdr/issues), and we'd be happy to provide guidance.\n\n### Repository history\n\nThe pcdr module's source used to be hosted as [a subfolder of the sdr-course repo](https://github.com/python-can-define-radio/sdr-course/tree/main/classroom_activities/Chx_Misc/Python_curric_2). On 2024 April 15, we migrated it to [its own repository](https://github.com/python-can-define-radio/pcdr). See the old repo if you'd like to refer to the commit history.\n",
"bugtrack_url": null,
"license": null,
"summary": "GNU Radio-based transmit and receive wrappers and more",
"version": "1.0.1",
"project_urls": {
"Bug Tracker": "https://github.com/python-can-define-radio/pcdr/issues",
"Homepage": "https://github.com/python-can-define-radio/pcdr"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "c3e91810ab9abb86acc199fd3fd184f29d2c12c21c0f88aa2d55af97d889c304",
"md5": "3aa0a22c2ea930f45462a85ac50e736a",
"sha256": "433a0e38ad1135fefb87c9dffa33d744db94cc4003895ad57d8a77a63fe71933"
},
"downloads": -1,
"filename": "pcdr-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3aa0a22c2ea930f45462a85ac50e736a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 67622,
"upload_time": "2024-08-01T00:51:10",
"upload_time_iso_8601": "2024-08-01T00:51:10.785815Z",
"url": "https://files.pythonhosted.org/packages/c3/e9/1810ab9abb86acc199fd3fd184f29d2c12c21c0f88aa2d55af97d889c304/pcdr-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e643a0353ab2abcedff4585351bc741984084591520ff01daacd3634d6e86399",
"md5": "a2f3a7faaff2d816b922f50b8671b761",
"sha256": "1ce748cbc59654df57898f3fa998a2d7505dbf54e27e6eff43ae91e1c5b9ad8b"
},
"downloads": -1,
"filename": "pcdr-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "a2f3a7faaff2d816b922f50b8671b761",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 60233,
"upload_time": "2024-08-01T00:51:12",
"upload_time_iso_8601": "2024-08-01T00:51:12.387149Z",
"url": "https://files.pythonhosted.org/packages/e6/43/a0353ab2abcedff4585351bc741984084591520ff01daacd3634d6e86399/pcdr-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-01 00:51:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "python-can-define-radio",
"github_project": "pcdr",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "pcdr"
}
