RestyClient is a simple, easy-to-use Python library for interacting with REST APIs using Pydantic's powerful data validation and deserialization tools.
Project description
Resty-Client
Resty-Client is a simple, easy-to-use Python library for interacting with REST APIs using Pydantic's powerful data validation and deserialization tools. This library provides an intuitive API that makes it easy to make HTTP requests and handle data on the client side.
Features
- Middleware system, which allows you to implement any pagination, filtering or authentication.
- Powerful data validation & deserialization using Pydantic
- Easy-to-Use
Installation
Using pip:
pip install resty-client
Using Poetry:
poetry add resty-client
Getting-Started
Schema
from pydantic import BaseModel
class Product(BaseModel):
id: int | None = None
name: str
description: str
code: str
Serializer
from resty.serializers import Serializer
class ProductSerializer(Serializer):
schema = Product
Manager
from resty.enums import (
Endpoint,
Field
)
from resty.managers import Manager
class ProductManager(Manager):
serializer = ProductSerializer
endpoints = {
Endpoint.CREATE: '/products/',
Endpoint.READ: '/products/',
Endpoint.READ_ONE: '/products/{pk}/',
Endpoint.UPDATE: '/products/{pk}/',
Endpoint.DELETE: '/products/{pk}/',
}
fields = {
Field.PRIMARY: 'id',
}
CRUD
from httpx import AsyncClient
from resty.clients.httpx import RESTClient
async def main():
xclient = AsyncClient(base_url='http://localhost:8000/')
rest_client = RESTClient(xclient=xclient)
product = Product(
name='First prod',
description='My Desc',
code='123W31Q'
)
# Create
created = await ProductManager.create(rest_client, product)
# Read
my_product = await ProductManager.read_one(rest_client, created.id)
for prod in await ProductManager.read(rest_client):
print(prod.name)
# Update
my_product.description = 'QWERTY'
await ProductManager.update(rest_client, my_product)
# Delete
await ProductManager.delete(rest_client, my_product.id)
Status
0.0.4
- RELEASED
Licence
Resty-Client is released under the MIT License. See the bundled LICENSE file for details.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
resty_client-0.0.4.tar.gz
(8.6 kB
view hashes)
Built Distribution
Close
Hashes for resty_client-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c1ab45c8b42852ff1a96237f8046c959eb08a56bb1f739b1201644fa60fa1e42 |
|
MD5 | 320c2369c45c46e781c3189a32562985 |
|
BLAKE2b-256 | 42d646f766d81e7fec42212124502ef07d36458d6dd535824afe74454b744a6f |