toadr3
Tiny OpenADR3 Python Library
This Python library is a tiny OpenADR3 library that can be used to perform a minimal set of operations towards a VTN.
Currently, it supports the following operations:
- List events [GET]
- Filter by program id
- Filter by target type and target values
- Limit and skip for pagination
- List programs [GET]
- Filter by target type and target values
- Limit and skip for pagination
- List reports [GET]
- Filter by program id
- Filter by event id
- Filter by client name
- Limit and skip for pagination
- List subscriptions [GET]
- Filter by program id
- Filter by client name
- Filter by target type and target values
- Filter by objects
- Limit and skip for pagination
- Update a subscription [PUT]
- Delete a subscription [DELETE]
- Get a subscription by id [GET]
- Update a program [PUT]
- Delete a program [DELETE]
- Get a program by id [GET]
- Create a report [POST]
- Create a subscription [POST]
- Create a report object based on an initial event
Example
A small example of how to list programs and events and create a report:
import asyncio
import toadr3
OAUTH_CONFIG = toadr3.OAuthConfig(
token_url="", # URL to the OAuth2 token endpoint
grant_type="", # OAuth2 grant type
claims={"scope": ""}, # OAuth2 claims, for example 'scope'
client_id="", # OAuth2 client ID or set to None use environment variable
client_secret="", # OAuth2 secret or set to None use environment variable
)
VTN_URL = "" # URL to the VTN
async def main():
async with toadr3.ToadrClient(vtn_url=VTN_URL, oauth_config=OAUTH_CONFIG) as client:
programs = await client.get_programs()
for program in programs:
print(f"Program: ID={program.id}, Name={program.program_name}")
events = await client.get_events()
for event in events:
print(f"Event: ID={event.id}, Name={event.event_name}, Date={event.created_date_time}")
report = toadr3.models.Report.create_report(
event=events[0],
client_name="ReadmeClient",
report_type="README_REPORT",
report_values=[True],
)
try:
result = await client.post_report(report)
print(f"Report created with ID={result.id}")
except toadr3.ToadrError as e:
print(f"ToadrError: {e}")
if __name__ == '__main__':
asyncio.run(main())
1 maintainer
Metadata
1 maintainer
Release files for toadr3 0.29.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| toadr3-0.29.0.tar.gz | 25.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| toadr3-0.29.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 64.2 kB
Release files / toadr3-0.29.0.tar.gz
| Download URL | toadr3-0.29.0.tar.gz |
|---|---|
| Size | 25.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
6ddab74ca31efe01567dfd25c1675b2984f997eab7b80f761c2572ee3c97339e
|
|
BLAKE2b-256 checksum How to use checksums |
8198cdaaf130b4c82039e62a0d4f7bed4588e8e2f3ba370c26d7102cc0e9e39d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 25, 2025.
Transparency logRelease files / toadr3-0.29.0-py3-none-any.whl
| Download URL | toadr3-0.29.0-py3-none-any.whl |
|---|---|
| Size | 39.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b8b298205082f2c5d86d182bc0c58e237812f69e7aaeb07312d86ca578f81974
|
|
BLAKE2b-256 checksum How to use checksums |
f472ca452ec9b51ac77cbe1d15869fc0f270111e7a51d6f102daf0bb61bdbfa7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.13.7
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 25, 2025.
Transparency log
