patera-apiinterface
Declarative async HTTP clients for external APIs in Patera applications. Part of Patera, a modular async-first Python web framework.
Installation
pip install patera-apiinterface
# or, with uv
uv add "patera[apiinterface]"
Requires Python 3.13 or newer and patera>=0.121.
Usage
patera-apiinterface turns annotated methods into HTTP calls (with HTTPX):
from patera import HttpMethod
from patera.apiinterface import ApiInterface, AuthType, auth, headers, method, resource, service, timeout
@service("GITHUB_URL") # config key or literal URL
@auth(AuthType.BEARER, token="GITHUB_TOKEN") # config key or literal value
@headers({"X-Client": "my-app"})
@timeout(10)
class GithubApi(ApiInterface):
@method(HttpMethod.GET)
@resource("/repos/<repo_id>") # filled from the argument of the same name
async def get_repo(self, repo_id: int) -> Repo: ... # Pydantic return types are validated
@method(HttpMethod.POST)
@resource("/repos")
async def create_repo(self, name: str, private: bool) -> dict: ... # arguments become the JSON body
See the External APIs section of the Patera documentation for the full guide.
License
MIT. See LICENSE.
1 maintainer
Metadata
1 maintainer
Release files for patera-apiinterface 0.11.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 | |
|---|---|---|---|
| patera_apiinterface-0.11.0.tar.gz | 9.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| patera_apiinterface-0.11.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.1 kB
Release files / patera_apiinterface-0.11.0.tar.gz
| Download URL | patera_apiinterface-0.11.0.tar.gz |
|---|---|
| Size | 9.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0e1ea473b5c1d31c93925c46431e4d0c68221fa6966bcddd057aee97b5484234
|
|
BLAKE2b-256 checksum How to use checksums |
65de36133d89224ad7a43989caa40f2b826470c609d280af11a4466eaca30fad
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
Release files / patera_apiinterface-0.11.0-py3-none-any.whl
| Download URL | patera_apiinterface-0.11.0-py3-none-any.whl |
|---|---|
| Size | 11.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
059674d570c5e7576ad1baa8ba295b67be22a5259fb911903ffab423f5c7b4e4
|
|
BLAKE2b-256 checksum How to use checksums |
bc7204dc11b5740048ecb16c863fb71405ea473713c0f5ff75d347bbbd884586
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.11.14 {"installer":{"name":"uv","version":"0.11.14","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":null,"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}
|
