Skip to main content

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

RestyClient

resty lib logo

GitHub GitHub release (latest by date) PyPI - Downloads Status

RestyClient 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.

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.1 - INDEV

Licence

RestyClient 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.1.tar.gz (7.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

resty_client-0.0.1-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file resty_client-0.0.1.tar.gz.

File metadata

  • Download URL: resty_client-0.0.1.tar.gz
  • Upload date:
  • Size: 7.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Windows/10

File hashes

Hashes for resty_client-0.0.1.tar.gz
Algorithm Hash digest
SHA256 e0513c706d02e1bb983689c8cc1d92d91eadf640da010c10274a2228cd9c18f0
MD5 660ee40356e6b655d8168ff354f723fa
BLAKE2b-256 d482f03f145470538a57566fa9b4b2036cb9c8d4ef560909298992a3a032cedc

See more details on using hashes here.

File details

Details for the file resty_client-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: resty_client-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.7.1 CPython/3.12.1 Windows/10

File hashes

Hashes for resty_client-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cd1d5ae82f952941cf8d311dcbe06654537bf01b443261a4d4e0ea40c7459606
MD5 90771e2d1e1baacf68077df84ca14474
BLAKE2b-256 c92c89e3304a886a6c5fbe2d69e94b62463a07752e66abe20a14063887c02bbe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page