| Name | pyjapi JSON |
| Version |
0.7.0
JSON |
| download |
| home_page | None |
| Summary | JAPI client |
| upload_time | 2024-01-17 14:20:25 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
click
japi
libjapi
python
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# pyjapi - Python JAPI Client
[](https://github.com/pypa/hatch)
[](https://github.com/psf/black)
[](https://github.com/astral-sh/ruff)
## Getting Started
```sh
pip install pyjapi
```
Alternatively, you might want to clone the project and go from there:
```sh
git clone git@git01.iis.fhg.de:ks-ip-lib/software/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>`
```console
$ japi request get_temperature
> get_temperature() #2a96d8
< get_temperature() #2a96d8 --> temperature=17.0
```
- `japi request <COMMAND> [PARAMETERS]`
```console
$ 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`
```console
$ 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>`
```console
$ 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
```
Raw data
{
"_id": null,
"home_page": null,
"name": "pyjapi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "click,japi,libjapi,python",
"author": null,
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/b3/3e/c621c433e910b42b4ceefbc0c6d5a00962a46f3cb88b7da62f9991d37494/pyjapi-0.7.0.tar.gz",
"platform": null,
"description": "# pyjapi - Python JAPI Client\n\n[](https://github.com/pypa/hatch)\n[](https://github.com/psf/black)\n[](https://github.com/astral-sh/ruff)\n\n## Getting Started\n\n```sh\npip install pyjapi\n```\n\nAlternatively, you might want to clone the project and go from there:\n\n```sh\ngit clone git@git01.iis.fhg.de:ks-ip-lib/software/pyjapi.git\npip install -e pyjapi/.\n```\n\n## Usage\n\n`japi [--host HOSTNAME] [--port N] [--format FORMAT_NAME] [-v] (list|listen|request)`\n\n## Examples\n\n### Issue individual JAPI commands\n\n- `japi request <JAPI_COMMAND>`\n\n ```console\n $ japi request get_temperature\n > get_temperature() #2a96d8\n < get_temperature() #2a96d8 --> temperature=17.0\n ```\n\n- `japi request <COMMAND> [PARAMETERS]`\n\n ```console\n $ japi request get_temperature unit=kelvin\n > get_temperature(unit=\"kelvin\") #02c6fa\n < get_temperature(unit=\"kelvin\") #02c6fa --> temperature=290.0\n ```\n\n### List available push services\n\n- `japi list`\n\n ```console\n $ japi list\n > japi_pushsrv_list() #4fae82\n < japi_pushsrv_list() #4fae82 --> services=[\"push_temperature\"]\n ```\n\n### Listen to JAPI push services\n\n- `japi listen <PUSH_SERVICE_NAME> <N_PACKAGES>`\n\n ```console\n $ japi listen push_temperature 3\n > japi_pushsrv_subscribe(service=\"push_temperature\") #b71d22\n < push_temperature() --> temperature=24.833269096274833\n < push_temperature() --> temperature=25.414709848078964\n < push_temperature() --> temperature=25.912073600614352\n ```\n",
"bugtrack_url": null,
"license": null,
"summary": "JAPI client",
"version": "0.7.0",
"project_urls": {
"repository": "https://git01.iis.fhg.de/ks-ip-lib/software/pyjapi"
},
"split_keywords": [
"click",
"japi",
"libjapi",
"python"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "417dd2365449df14277d237ce5026374b292698a31e239a7193cab3c90c63e95",
"md5": "15df50ec9b9f3c55c2d5fdc65d17d135",
"sha256": "3fee67cf9be722b11e328478fa3753f371a50f16c623a02ffe0d12045390308f"
},
"downloads": -1,
"filename": "pyjapi-0.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "15df50ec9b9f3c55c2d5fdc65d17d135",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 10506,
"upload_time": "2024-01-17T14:20:21",
"upload_time_iso_8601": "2024-01-17T14:20:21.347223Z",
"url": "https://files.pythonhosted.org/packages/41/7d/d2365449df14277d237ce5026374b292698a31e239a7193cab3c90c63e95/pyjapi-0.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b33ec621c433e910b42b4ceefbc0c6d5a00962a46f3cb88b7da62f9991d37494",
"md5": "a786bf5f3269799303409b7a0dd11795",
"sha256": "3f3641cefce6ee71ac96427d1d785ba1b587bf5dd8560531664d6c1e75ffe916"
},
"downloads": -1,
"filename": "pyjapi-0.7.0.tar.gz",
"has_sig": false,
"md5_digest": "a786bf5f3269799303409b7a0dd11795",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 93132,
"upload_time": "2024-01-17T14:20:25",
"upload_time_iso_8601": "2024-01-17T14:20:25.356897Z",
"url": "https://files.pythonhosted.org/packages/b3/3e/c621c433e910b42b4ceefbc0c6d5a00962a46f3cb88b7da62f9991d37494/pyjapi-0.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-17 14:20:25",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "pyjapi"
}
