Skip to main content

Proof of concept Axia Pathfinder API/SDK.

Project description

axia-pathfinder-client

This is an early start at writing a python client/sdk for the the telnet based API on Axia Pathfinder software/appliances from the Telos Alliance.

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.

Please raise an issue if you would like to collaborate with Radio Bern RaBe 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
    • 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 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

python -mvenv venv
. venv/bin/activate

pip install poetry

poetry install

pre-commit hook

pip install pre-commit
pre-commit run -a

Testing

poetry run pytest

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

axia_pathfinder_client-0.2.5.tar.gz (15.6 kB view details)

Uploaded Source

Built Distribution

axia_pathfinder_client-0.2.5-py3-none-any.whl (17.8 kB view details)

Uploaded Python 3

File details

Details for the file axia_pathfinder_client-0.2.5.tar.gz.

File metadata

  • Download URL: axia_pathfinder_client-0.2.5.tar.gz
  • Upload date:
  • Size: 15.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.10.12 Linux/6.5.0-1022-azure

File hashes

Hashes for axia_pathfinder_client-0.2.5.tar.gz
Algorithm Hash digest
SHA256 e574aca8ac6897ef0ace8ee80fbc3229cfd2cb64b256524e47a00c4dbce45e1a
MD5 3452431b719c54b963f39d5fd1404b12
BLAKE2b-256 6ac0909b02e3344c1ed7694db88137349146e525005aa303fc4159f5b0c4cfca

See more details on using hashes here.

File details

Details for the file axia_pathfinder_client-0.2.5-py3-none-any.whl.

File metadata

File hashes

Hashes for axia_pathfinder_client-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 6424fe43eb3feec0f6b4306d0349d5a9c7592efca3716467256efc9d24bc8240
MD5 7228fada19868321cdeb7ff1028f50d1
BLAKE2b-256 68a28b8700ac06d63f68e6c22035c39c6697b7baa7bb73d107ce9008c7a924d0

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page