Asynchronous client for MeteoSwiss 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 meteoswiss_async-0.1.0rc20.post1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c7895516f025fde7ef22095d057726beba68042b9675ac6cc7a161ce52ecd02c |
|
MD5 | 615da28b576bcafe2fb16088ace302b8 |
|
BLAKE2b-256 | 8d3a9496bd769df44f5d4fddde4dd07a64deb93be849e2a32b41cc55bf27a044 |
Close
Hashes for meteoswiss_async-0.1.0rc20.post1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0298d8c90bcc3b536fda3d935534a160b58d9cf8542879c21c6d95527ddcfbe |
|
MD5 | 1cd1b6754e6e569b5d04f27ebf013609 |
|
BLAKE2b-256 | 9df4dcc05659943b165426a0b2abeef7501783170ddfa2adc90f8fe64f799460 |