Skip to main content

JAPI client

Project description

pyjapi - Python JAPI Client

Using Hatch Code style: black Ruff

Getting Started

pip install pyjapi

Alternatively, you might want to clone the project and go from there:

git clone git@github.com:Fraunhofer-IIS/pyjapi.git
pip install -e pyjapi/.

Usage

japi [--host HOSTNAME] [--port N] [--format FORMAT_NAME] [-v] (list|listen|request)

Examples

Issue individual JAPI commands

  • japi request <JAPI_COMMAND>

    $ japi request get_temperature
    > get_temperature() #2a96d8
    < get_temperature() #2a96d8 --> temperature=17.0
    
  • japi request <COMMAND> [PARAMETERS]

    $ japi request get_temperature unit=kelvin
    > get_temperature(unit="kelvin") #02c6fa
    < get_temperature(unit="kelvin") #02c6fa --> temperature=290.0
    

List available push services

  • japi list

    $ japi list
    > japi_pushsrv_list() #4fae82
    < japi_pushsrv_list() #4fae82 --> services=["push_temperature"]
    

Listen to JAPI push services

  • japi listen <PUSH_SERVICE_NAME> <N_PACKAGES>

    $ japi listen push_temperature 3
    > japi_pushsrv_subscribe(service="push_temperature") #b71d22
    < push_temperature() --> temperature=24.833269096274833
    < push_temperature() --> temperature=25.414709848078964
    < push_temperature() --> temperature=25.912073600614352
    

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

pyjapi-0.6.1.tar.gz (1.2 MB view details)

Uploaded Source

Built Distribution

pyjapi-0.6.1-py3-none-any.whl (10.5 kB view details)

Uploaded Python 3

File details

Details for the file pyjapi-0.6.1.tar.gz.

File metadata

  • Download URL: pyjapi-0.6.1.tar.gz
  • Upload date:
  • Size: 1.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.24.1

File hashes

Hashes for pyjapi-0.6.1.tar.gz
Algorithm Hash digest
SHA256 ed2f5519c7c73d54d80f3d66ec8a34f5d8265e7eff9196b89245e2984663ea1a
MD5 5c266a5c65bc360e20f2f2a5281acefc
BLAKE2b-256 3f1b734fa38610d008fb0f964fe30620104c90b5def668816fac7ee9634a8523

See more details on using hashes here.

File details

Details for the file pyjapi-0.6.1-py3-none-any.whl.

File metadata

  • Download URL: pyjapi-0.6.1-py3-none-any.whl
  • Upload date:
  • Size: 10.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.24.1

File hashes

Hashes for pyjapi-0.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 72e810d56b6e3639fa00a6b9559f77005889267f952594593ae1aa7de894ddee
MD5 607b82d18eb685a71c43e49e0bde73bb
BLAKE2b-256 0a128f1997c000b46e2b36e1d95d524fe96d03dcdedfcb5514f85d4c3fee130a

See more details on using hashes here.

Supported by

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