Skip to main content

A client for katportal.

Project description

katportalclient

Doc Status PyPI Version Python Versions

A client for simple access to katportal, via websocket and HTTP connections. The HTTP methods allow once-off requests, like the current list of schedule blocks. For continuous updates, use the Pub/Sub methods, which work over a websocket.

Dependencies

Details can be found in setup.py but basically it is only:

  • katversion
  • tornado is used as the web framework and for its asynchronous functionality.

Note: setup.py depends on katversion, so make sure that is installed before installing the package.

Install

pip install katportalclient

Example usage

See the examples folder for code that demonstrates some usage scenarios.

Changelog

Changelog

v0.2.2 (2020-04-30)

Full Changelog

Merged pull requests:

  • Generate documentation as part of CI build. #61 (mmphego)
  • Install latest ujson to fix float truncation #59 (lanceWilliams)
  • Changed build agent from Ubuntu Trusty to Bionic #58 (mmphego)
  • Automate code linting and reject PR if fails. #57 (mmphego)

v0.2.1 (2019-09-13)

Full Changelog

Merged pull requests:

v0.2.0 (2019-09-11)

Full Changelog

Merged pull requests:

v0.1.1 (2019-08-30)

Full Changelog

Merged pull requests:

  • add license and long_description to setup.py #50 (tockards)

v0.1.0 (2019-08-29)

Full Changelog

Closed issues:

  • Mixed messages on code reuse #28

Merged pull requests:

  • add initial changelog #48 (tockards)
  • Make katportalclient work on newer versions of Tornado #45 (bmerry)
  • Capture block ID usage in examples #44 (bngcebetsha)
  • Request a list of sb_ids associated with a given capture block ID #43 (bngcebetsha)
  • Trigger downstream publish #42 (sw00)
  • Doc strings updated #41 (rohanschwartz)
  • Add multiple sensor readings request #40 (lanceWilliams)
  • Add Python 3 compatibility #38 (ajoubertza)
  • Increase HTTP request timeout to 60 seconds #35 (ajoubertza)
  • Add sensor\_value function that returns latest sensor reading #34 (SKAJohanVenter)
  • Revert new katstore changes on master #32 (ajoubertza)
  • User/bulelani/cb 1824/add test for subarray sensor lookup #30 (bxaia)
  • Update license details to BSD #29 (ajoubertza)
  • Allow sensor subarray lookup for component names #27 (ajoubertza)
  • added a sensor_subarray_lookup method that calls a katportal endpoint… #26 (bxaia)
  • Fix sensor_detail request if duplicates found #25 (ajoubertza)
  • Improved usage of katpoint for better clarity #24 (fjoubert)
  • added example usage of the katpoint target and antenna objects #23 (fjoubert)
  • Added auth, userlogs, removed future targets details and many unit tests #22 (fjoubert)
  • Reconnection logic + resending jsonrpc requests on reconnect #21 (fjoubert)
  • Improve basic websocket subscription example #20 (ajoubertza)
  • Methods and example of how to get schedule block targets and target details from our catalogues #19 (fjoubert)
  • User/lize/cb 1498 fix retrieve sensor data #18 (lvdheever)
  • User/lize/cb 1498 #17 (lvdheever)
  • Allow simultaneous sensor history requests #16 (ajoubertza)
  • Allow historical sensor queries #15 (ajoubertza)
  • Add sensor list and sensor detail functions #14 (ajoubertza)
  • jenkinsfile tweaks to always checkout the correct head of the branch;… #13 (fjoubert)
  • Methods to get schedule block info #12 (ajoubertza)
  • Request sitemap from portal webserver on initialisation #11 (ajoubertza)
  • Flake8, docstring and copyright fixes #10 (ajoubertza)
  • improved debug logging call #9 (fjoubert)
  • better local branch checkout in Jenkinsfile #8 (fjoubert)
  • Indentation fix #7 (bxaia)
  • User/bulelani/jenkinsfile archive artifacts #6 (fjoubert)
  • Jenkinsfile & local version #5 (fjoubert)

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

katportalclient-0.2.2.tar.gz (35.3 kB view details)

Uploaded Source

Built Distribution

katportalclient-0.2.2-py3-none-any.whl (34.6 kB view details)

Uploaded Python 3

File details

Details for the file katportalclient-0.2.2.tar.gz.

File metadata

  • Download URL: katportalclient-0.2.2.tar.gz
  • Upload date:
  • Size: 35.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.6.8

File hashes

Hashes for katportalclient-0.2.2.tar.gz
Algorithm Hash digest
SHA256 317714db67e7effa5af0a6015c94cd94c61a338b8685fd53b67343d2508d1b9a
MD5 9688d8af126b2e69117d18e449d891ed
BLAKE2b-256 1f5433cc517088c29759249673699b200cd865abb66f9d28ede41fb809850294

See more details on using hashes here.

File details

Details for the file katportalclient-0.2.2-py3-none-any.whl.

File metadata

  • Download URL: katportalclient-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 34.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/46.0.0 requests-toolbelt/0.9.1 tqdm/4.39.0 CPython/3.6.8

File hashes

Hashes for katportalclient-0.2.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1564fefce94b49ca3e6ce2e128b8b5cbf4d2e5ca25ffa16deb03b4c3bd199a44
MD5 ca42526d5702946a21c2ab1a08ed69a4
BLAKE2b-256 185379670343f65107c969e18c868063b7e2cce9de50ae25f36ac412789b6bdd

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