| Name | axia-pathfinder-client JSON |
| Version |
0.2.5
JSON |
| download |
| home_page | None |
| Summary | Proof of concept Axia Pathfinder API/SDK. |
| upload_time | 2024-07-08 06:51:02 |
| maintainer | None |
| docs_url | None |
| author | RaBe IT-Reaktion |
| requires_python | <4.0,>=3.11 |
| license | AGPLv3 |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# axia-pathfinder-client
This is an early start at writing a python client/sdk for the the telnet based API on [Axia Pathfinder](https://www.telosalliance.com/Axia/Pathfinder-Routing-Control) software/appliances from the [Telos Alliance](https://www.telosalliance.com).
Currently it is more a proof of concept rather than anything ready for production. We have plans to integrate it with our current [songticker glue code](https://github.com/radiorabe/nowplaying).
Please raise an [issue](https://github.com/radiorabe/axia-pathfinder-client/issues) if you would like to collaborate with [Radio Bern RaBe](https://www.rabe.ch) on this python/pathfinder integration effort. We plan on primarily focusing this library on our needs but contributions are always welcome and we would be happy to accomodate you!
## Features
* partially implements the "SAPv2" protocol as described in the [pathfinder manual](https://www.telosalliance.com/images/Axia%20Products/Pathfinder%20PC/Support%20Files/PathFinder%20PC%20Manual-5.00.pdf)
* only "LOGIN", "GET" and "SUB" operators are currently supported
* "INDI" responses to "GET" requests get parsed and returned in a timeout governed timeout fashion
* Also works with xNode Telnet interfaces
* GPO responses to "GPO" requests are currently parsed
* Uses a PEG-style parser-combinator based on [parsy](https://github.com/python-parsy/parsy) to parse responses from the telnet interfaces
## Contributing
Please let us know what you would like to contribute before you get invested! This is really a proof of concept at this stage.
### Development
```bash
python -mvenv venv
. venv/bin/activate
pip install poetry
poetry install
```
### pre-commit hook
```bash
pip install pre-commit
pre-commit run -a
```
### Testing
```bash
poetry run pytest
```
Raw data
{
"_id": null,
"home_page": null,
"name": "axia-pathfinder-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.11",
"maintainer_email": null,
"keywords": null,
"author": "RaBe IT-Reaktion",
"author_email": "it@rabe.ch",
"download_url": "https://files.pythonhosted.org/packages/6a/c0/909b02e3344c1ed7694db88137349146e525005aa303fc4159f5b0c4cfca/axia_pathfinder_client-0.2.5.tar.gz",
"platform": null,
"description": "# axia-pathfinder-client\n\nThis is an early start at writing a python client/sdk for the the telnet based API on [Axia Pathfinder](https://www.telosalliance.com/Axia/Pathfinder-Routing-Control) software/appliances from the [Telos Alliance](https://www.telosalliance.com).\n\nCurrently it is more a proof of concept rather than anything ready for production. We have plans to integrate it with our current [songticker glue code](https://github.com/radiorabe/nowplaying).\n\nPlease raise an [issue](https://github.com/radiorabe/axia-pathfinder-client/issues) if you would like to collaborate with [Radio Bern RaBe](https://www.rabe.ch) on this python/pathfinder integration effort. We plan on primarily focusing this library on our needs but contributions are always welcome and we would be happy to accomodate you!\n\n## Features\n\n* partially implements the \"SAPv2\" protocol as described in the [pathfinder manual](https://www.telosalliance.com/images/Axia%20Products/Pathfinder%20PC/Support%20Files/PathFinder%20PC%20Manual-5.00.pdf)\n * only \"LOGIN\", \"GET\" and \"SUB\" operators are currently supported\n * \"INDI\" responses to \"GET\" requests get parsed and returned in a timeout governed timeout fashion\n* Also works with xNode Telnet interfaces\n * GPO responses to \"GPO\" requests are currently parsed\n* Uses a PEG-style parser-combinator based on [parsy](https://github.com/python-parsy/parsy) to parse responses from the telnet interfaces\n\n## Contributing\n\nPlease let us know what you would like to contribute before you get invested! This is really a proof of concept at this stage.\n\n### Development\n\n```bash\npython -mvenv venv\n. venv/bin/activate\n\npip install poetry\n\npoetry install\n```\n\n### pre-commit hook\n\n```bash\npip install pre-commit\npre-commit run -a\n```\n\n### Testing\n\n```bash\npoetry run pytest\n```\n",
"bugtrack_url": null,
"license": "AGPLv3",
"summary": "Proof of concept Axia Pathfinder API/SDK.",
"version": "0.2.5",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "68a28b8700ac06d63f68e6c22035c39c6697b7baa7bb73d107ce9008c7a924d0",
"md5": "7228fada19868321cdeb7ff1028f50d1",
"sha256": "6424fe43eb3feec0f6b4306d0349d5a9c7592efca3716467256efc9d24bc8240"
},
"downloads": -1,
"filename": "axia_pathfinder_client-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7228fada19868321cdeb7ff1028f50d1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.11",
"size": 17764,
"upload_time": "2024-07-08T06:51:00",
"upload_time_iso_8601": "2024-07-08T06:51:00.331318Z",
"url": "https://files.pythonhosted.org/packages/68/a2/8b8700ac06d63f68e6c22035c39c6697b7baa7bb73d107ce9008c7a924d0/axia_pathfinder_client-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ac0909b02e3344c1ed7694db88137349146e525005aa303fc4159f5b0c4cfca",
"md5": "3452431b719c54b963f39d5fd1404b12",
"sha256": "e574aca8ac6897ef0ace8ee80fbc3229cfd2cb64b256524e47a00c4dbce45e1a"
},
"downloads": -1,
"filename": "axia_pathfinder_client-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "3452431b719c54b963f39d5fd1404b12",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.11",
"size": 15645,
"upload_time": "2024-07-08T06:51:02",
"upload_time_iso_8601": "2024-07-08T06:51:02.112465Z",
"url": "https://files.pythonhosted.org/packages/6a/c0/909b02e3344c1ed7694db88137349146e525005aa303fc4159f5b0c4cfca/axia_pathfinder_client-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 06:51:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "axia-pathfinder-client"
}
