Metadata-Version: 2.1
Name: pydantic-client
Version: 0.1.13
Summary: Http client base pydantic, with requests or aiohttp
Home-page: https://github.com/ponytailer/pydantic-client
Author: ponytailer
Author-email: huangxiaohen2738@gmail.com
Requires-Python: >=3.8,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Provides-Extra: aiohttp
Provides-Extra: all
Provides-Extra: httpx
Requires-Dist: aiohttp ; extra == "aiohttp" or extra == "all"
Requires-Dist: httpx[http2] ; extra == "httpx" or extra == "all"
Requires-Dist: pydantic (>=2.1)
Requires-Dist: requests
Description-Content-Type: text/markdown

# pydantic-client
[![codecov](https://codecov.io/gh/ponytailer/pydantic-client/branch/main/graph/badge.svg?token=CZX5V1YP22)](https://codecov.io/gh/ponytailer/pydantic-client)

Http client base pydantic, with requests or aiohttp

### How to install

1. only support requests:

   `pip install pydantic-client`
2. support aiohttp and requests:

   `pip install pydantic-client[aiohttp]`

3. support httpx and requests:

   `pip install pydantic-client[httpx]`

4. support all:

   `pip install pydantic-client[all]`

### How to use

```python
from pydantic import BaseModel

from pydantic_client import delete, get, post, put
from pydantic_client.clients.requests import RequestsClient


class Book(BaseModel):
   name: str
   age: int


class R(RequestsClient):

   @get("/books/{book_id}?query={query}")
   def get_book(self, book_id: int, query: str) -> Book:
      ...

   @post("/books", form_body=True)
   def create_book_form(self, book: Book) -> Book:
      """ will post the form with book"""
      ...

   @put("/books/{book_id}")
   def change_book(self, book_id: int, book: Book) -> Book:
      """will put the json body"""
      ...

   @delete("/books/{book_id}")
   def change_book(self, book_id: int) -> Book:
      ...


my_client = R("http://localhost/v1")
get_book: Book = my_client.get_book(1)
```

The Group
```python

from pydantic_client import Group
from pydantic_client.clients.requests import RequestsClient

group = Group("/book")
person_group = Group("/person")


class GroupClient(RequestsClient):
   def __init__(self):
      super().__init__("http://localhost")

   @group.get("/{book_id}")
   def get(self, book_id: int) -> Book:  # type: ignore
      ...
   
   @person_group.get("/{person_id}")
   def get_person(self, person_id: int) -> Person:  # type: ignore
      ...
   
client = GroupClient()
book = client.get(1)
person = client.get_person(1)


```
