NSSurge HTTP API for Python
Project description
NSSurge Python API Client
Python implementation of the Surge HTTP API spec client using aiohttp
.
Installation
pip
$ pip install nssurge-api
Usage
# source: https://github.com/tddschn/nssurge-cli/blob/master/nssurge_cli/cap_commands.py
from nssurge_api import SurgeAPIClient
from nssurge_api.types import Capability
import asyncio
async def get_set_cap(
capability: Capability, on_off: OnOffToggleEnum | None = None
) -> bool | tuple[bool, bool]:
"""
Get or set a capability
"""
async with SurgeAPIClient(*get_config()) as client:
state_orig = await get_cap_state(client, capability)
match on_off:
case OnOffToggleEnum.on | OnOffToggleEnum.off:
await client.set_cap(capability, s2b(on_off))
case OnOffToggleEnum.toggle:
await client.set_cap(capability, not state_orig)
case _:
return state_orig
state_new = await get_cap_state(client, capability)
return state_orig, state_new
Develop
$ git clone https://github.com/tddschn/nssurge-api.git
$ cd nssurge-api
$ poetry install
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
nssurge_api-0.2.15.tar.gz
(5.5 kB
view hashes)
Built Distribution
Close
Hashes for nssurge_api-0.2.15-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 42fb2f99479ccd45bd19f4f720e4da7c16678538d5477a4f7759c794b4ed18c0 |
|
MD5 | 7f9cf98659bc778538169b79fb1d19a3 |
|
BLAKE2b-256 | b1503ec0c355afb9e543290a6885d0ad846b39577f1e3b9ff709db17f627c3e1 |