Sample Python Project for creating a new Python Async Client for a new API
Project description
Python Async API Client
This have in mind to start developing API clients for Home Assistant to be 100% asynchronous
How to Use it?
Fork this repository by using it as a template.
Structure
This package provides good defaults for any API client code that is split on the following modules:
errors.py
: module that define the custom errors the API and/or client would be returning to their users.model.py
: definition of the API data model. All returned objects from the clients would be defined here.client.py
: the logic around calling the API
Development
To start developing with this package, fork it, create a virtual environment and install all the dependencies needed for development.
python3 -m venv .venv
source .venv/bin/activate
pip install '.[dev]'
Best Practices
This package provides already an skeleton with some best practices when starting developing your API client.
- 100% async from the start: Home Assistant runs its main logic using an asynchronous engine, and having 3rd party clients running async can have performance benefits and ease of integration on new and existing components.
- A
aiohttp.ClientSession
should always to be a constructor argument (so a session and connection pool can be shared between multiple clients). The template already provides a class constructor to create the Client without any initialClientSession
in case it is not available. - The output of each API endpoint is a typed
Model
that is build as a dataclass and can be parsed from a JSON response or a nested dictionary. This ensures the consumer of the API outputs can take benefits from the benefits dataclasses provide like readaibility on its structure and field types. - The whole library is annotated with Python types so type checkers can help us detect errors early on rather than at runtime.
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
Close
Hashes for project_async-0.0.1rc85.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2c4dd01b84babcab5f9fcc4cf8d6da92b1b910e50f9f2fd31294a855ca4e45cd |
|
MD5 | 7748a11e37b0511ed8fbc387e283d4a9 |
|
BLAKE2b-256 | fa7156b79503813daf9266192a98cb36cc8281425bc0595d8bfc6b1c70be4bab |
Close
Hashes for project_async-0.0.1rc85.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4c013030e90343ccb939a0a09f359ee948ee2cd07ba27b22dbc63cfc336ebe68 |
|
MD5 | 2075dc6e2c8bf5659519bf931f2b1a8d |
|
BLAKE2b-256 | 9561273b43acee0ef06bb2f1b4edcc189d8f67c0858fe49e4395debd7ce69f07 |