Async Typed Python package for the nVent RAYCHEM SENZ RestAPI
Project description
aioSENZ package
An async Python wrapper for the nVent Raychem SENZ RestAPI.
Installation
pip install aiosenz
OAuth2
This package offers an AbstractSENZAuth
, where you should handle the OAuth2 tokens and provide a valid access token in get_access_token()
. You can use SENZAuth
if you don't want to handle the OAuth2 tokens yourself.
Grant type
SENZAuth
uses the Authorization Code grant type. This requires a Client ID and Client Secret, more information is available in the RestAPI documentation.
Scopes
AioSENZ uses the restapi
and offline_access
scope, this is set as default in SENZAuth and should be set in the OAuth2 client if you are using the AbstractSENZAuth class. The OpenID (openid
) and OpenID Profile (profile
) scopes are not supported, because nVent recommends to use the RestAPI Account instead.
Example
from asyncio import run
from aiosenz import SENZAuth, SENZAPI
import httpx
async def main():
async with httpx.AsyncClient() as httpx_client:
senz_auth = SENZAuth(
httpx_client,
"YOUR_CLIENT_ID",
"YOUR_CLIENT_SECRET",
redirect_uri="http://localhost:8080/auth/callback",
)
uri, state = await senz_auth.get_authorization_url()
print("Authorization URI: ", uri)
authorization_response = input("The authorization response URL: ")
await senz_auth.set_token_from_authorization_response(authorization_response)
senz_api = SENZAPI(senz_auth)
thermostats = await senz_api.get_thermostats()
for thermostat in thermostats:
print(f"{thermostat.name} temperature: {thermostat.current_temperatue}")
await senz_auth.close()
run(main())
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
Built Distribution
File details
Details for the file aiosenz-1.0.0.tar.gz
.
File metadata
- Download URL: aiosenz-1.0.0.tar.gz
- Upload date:
- Size: 18.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f078462bcd7170dc71abe4ea3bf21318ec0a946fdf4df4a354f1210d70c03ba0 |
|
MD5 | 00c90b10071901cb3be0a4bdfb8efa61 |
|
BLAKE2b-256 | de4b2616a878e3632437d836816ceb748ee936d7ef8a6238dba426d639cd1d5f |
File details
Details for the file aiosenz-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: aiosenz-1.0.0-py3-none-any.whl
- Upload date:
- Size: 21.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.5.0 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.1 CPython/3.9.7
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19b4098b1bbf759c7a19dbb65236e5ac737267cd8970835afe764ea8bed36a2f |
|
MD5 | 198a2dbff2e1eafb26fc30fb9442fd54 |
|
BLAKE2b-256 | ac805716f5902ac61dc1a65eff90672f7f3dbb7256f818153d1baf59193fb061 |