Skip to main content

The python framework, providing fast and robust way to build client-side API wrappers.

Project description

sensei

Logo Banner


Python versions PyPi Version PyPI Downloads

The python framework, providing fast and robust way to build client-side API wrappers.

Source code is made available under the MIT License.

Quick Overview

Here is example of OOP style.

from typing import Annotated, Any, Self
from sensei import Router, Query, Path, APIModel, Header, Args, pascal_case, format_str, RateLimit

router = Router('https://reqres.in/api', rate_limit=RateLimit(5, 1))


@router.model()
class BaseModel(APIModel):
    def __finalize_json__(self, json: dict[str, Any]) -> dict[str, Any]:
        return json['data']

    def __prepare_args__(self, args: Args) -> Args:
        args.headers['X-Token'] = 'secret_token'
        return args

    def __header_case__(self, s: str) -> str:
        return pascal_case(s)


class User(BaseModel):
    email: str
    id: int
    first_name: str
    last_name: str
    avatar: str

    @classmethod
    @router.get('/users')
    def query(
            cls,
            page: Annotated[int, Query(1)],
            per_page: Annotated[int, Query(3, le=7)],
            bearer_token: Annotated[str, Header('secret', le=10)],
    ) -> list[Self]:
        ...

    @classmethod
    @router.get('/users/{id_}')
    def get(cls, id_: Annotated[int, Path(alias='id')]) -> Self:
        ...

    @router.delete('/users/{id_}')
    def delete(self) -> Self:
        ...

    @delete.prepare
    def _delete_in(self, args: Args) -> Args:
        url = args.url
        url = format_str(url, {'id_': self.id})
        args.url = url
        return args


users = User.query(per_page=7)
user_id = users[0].id
user = User.get(user_id)
print(user == users[0])

Example of functional style.

from typing import Annotated
from sensei import Router, Path, APIModel

router = Router('https://pokeapi.co/api/v2/')


class Pokemon(APIModel):
    name: str
    id: int
    height: int
    weight: int
    types: list


@router.get('/pokemon/{pokemon_name}')
def get_pokemon(
        pokemon_name: Annotated[str, Path()],
) -> Pokemon:
    ...


pokemon = get_pokemon(pokemon_name="pikachu")
print(pokemon)

Installing sensei

To install sensei from PyPi, you can use that:

pip install sensei

To install sensei from GitHub, use that:

pip install git+https://github.com/CrocoFactory/sensei.git

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

sensei-0.1.0rc1.tar.gz (23.9 kB view details)

Uploaded Source

Built Distribution

sensei-0.1.0rc1-py3-none-any.whl (31.1 kB view details)

Uploaded Python 3

File details

Details for the file sensei-0.1.0rc1.tar.gz.

File metadata

  • Download URL: sensei-0.1.0rc1.tar.gz
  • Upload date:
  • Size: 23.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for sensei-0.1.0rc1.tar.gz
Algorithm Hash digest
SHA256 adff5eef06a9d2f1afd76c1a16d007eb60defdfd45f42f6a33ef45792da6060a
MD5 165603dd2279b033880036edd145db14
BLAKE2b-256 4c379cef58b7e3c8da5252164259a32aa5ba702b301ac3b7b5db18c40566aeb4

See more details on using hashes here.

File details

Details for the file sensei-0.1.0rc1-py3-none-any.whl.

File metadata

  • Download URL: sensei-0.1.0rc1-py3-none-any.whl
  • Upload date:
  • Size: 31.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for sensei-0.1.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 0db21e5ef16ff93f2a8c5e65ad11ea5c7f1020a35e45a7ec285d9bfe1c6aac7d
MD5 c998b20f07b8992c7f43a8bc4a41444d
BLAKE2b-256 6b7855d25811480ef6e12caaa83d01663ba74a51af6de8f1efe762edca31a2c2

See more details on using hashes here.

Supported by

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