A simple Python 3 library for Notion Home Monitoring
Project description
📟 aionotion: a Python3, asyncio-friendly library for Notion® Home Monitoring
aionotion
is a Python 3, asyncio-friendly library for interacting with Notion
home monitoring sensors.
Installation
pip install aionotion
Python Versions
aionotion
is currently supported on:
- Python 3.9
- Python 3.10
- Python 3.11
Usage
import asyncio
from aiohttp import ClientSession
from aionotion import async_get_client
async def main() -> None:
"""Create the aiohttp session and run the example."""
client = await async_get_client("<EMAIL>", "<PASSWORD>", session=session)
# Get all "households" associated with the account:
response = await client.system.async_all()
# >>> response -> systems=[System(...), ...]
# Get a system by ID:
response = await client.system.async_get(12345)
# >>> response -> system=System(...)
# Create a system (with associated parameters):
response = await client.system.async_create({"system_id": 12345, "name": "Test"})
# >>> response -> system=System(...)
# Update a system with new parameters:
response = await client.system.async_update(12345, {"name": "Test"})
# >>> response -> system=System(...)
# Delete a system by ID:
await client.system.async_delete(12345)
# Get all bridges associated with the account:
response = await client.bridge.async_all()
# >>> response -> bridges=[Bridge(...), ...]
# Get a bridge by ID:
response = await client.bridge.async_get(12345)
# >>> response -> bridge=Bridge(...)
# Create a bridge (with associated parameters):
response = await client.bridge.async_create({"system_id": 12345, "name": "Test"})
# >>> response -> bridge=Bridge(...)
# Update a bridge with new parameters:
response = await client.bridge.async_update(12345, {"name": "Test"})
# >>> response -> bridge=Bridge(...)
# Reset a bridge (deprovision its WiFi credentials):
response = await client.bridge.async_reset(12345)
# >>> response -> bridge=Bridge(...)
# Delete a bridge by ID:
await client.bridge.async_delete(12345)
# Get all devices associated with the account:
response = await client.device.async_all()
# >>> response -> devices=[Device(...), ...]
# Get a device by ID:
response = await client.device.async_get(12345)
# >>> response -> Device(...)
# Create a device (with associated parameters):
response = await client.device.async_create({"id": 12345})
# >>> response -> Device(...)
# Delete a device by ID:
await client.device.async_delete(12345)
# Get all sensors:
response = await client.sensor.async_all()
# >>> response -> sensors=[Sensor(...), ...]
# Get a sensor by ID:
response = await client.sensor.async_get(12345)
# >>> response -> Sensor(...)
# Get "listeners" (conditions that a sensor is monitoring) for all sensors:
response = await client.sensor.async_listeners()
# >>> response -> listeners=[Listener(...), ...]
# Get "listeners" (conditions that a sensor is monitoring) for a specific sensor;
# note that unlike other sensor endpoints, this one requires the sensor UUID, *not*
# the sensor ID:
response = await client.sensor.async_listeners_for_sensor(
"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
)
# >>> response -> listeners=[Listener(...), ...]
# Create a sensor (with associated parameters):
response = await client.sensor.async_create({"sensor_id": 12345, "name": "Test"})
# >>> response -> Sensor(...)
# Update a sensor with new parameters:
response = await client.sensor.async_update(12345, {"name": "Test"})
# >>> response -> Sensor(...)
# Delete a sensor by ID:
await client.sensor.async_delete(12345)
# Get user preferences:
user_preferences = await client.user.async_preferences()
asyncio.run(main())
By default, the library creates a new connection to Notion with each coroutine. If you
are calling a large number of coroutines (or merely want to squeeze out every second of
runtime savings possible), an aiohttp
ClientSession
can be used for
connection pooling:
import asyncio
from aiohttp import ClientSession
from aionotion import async_get_client
async def main() -> None:
"""Create the aiohttp session and run the example."""
async with ClientSession() as session:
# Create a Notion API client:
client = await async_get_client("<EMAIL>", "<PASSWORD>", session=session)
# Get to work...
asyncio.run(main())
Check out the examples, the tests, and the source files themselves for method signatures and more examples.
Contributing
Thanks to all of our contributors so far!
- Check for open features/bugs or initiate a discussion on one.
- Fork the repository.
- (optional, but highly recommended) Create a virtual environment:
python3 -m venv .venv
- (optional, but highly recommended) Enter the virtual environment:
source ./.venv/bin/activate
- Install the dev environment:
script/setup
- Code your new feature or bug fix on a new branch.
- Write tests that cover your new functionality.
- Run tests and ensure 100% code coverage:
poetry run pytest --cov aionotion tests
- Update
README.md
with any new documentation. - Submit a pull request!
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
aionotion-2023.5.4.tar.gz
(12.1 kB
view hashes)
Built Distribution
Close
Hashes for aionotion-2023.5.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1fc8f300da863b039242a4d7a2a70fd1af0f879dc195f8eca6cd15f4ffae9d8 |
|
MD5 | d81c876654ec2ef5cb0bac8b985135bb |
|
BLAKE2b-256 | 08a40e5fd02df066d315b18a953d6f83bfa380867f9f92ede7760ea814018e12 |