Skip to main content

FastAPI Class Views and utilities

Project description

fastapi-views

CI Build License Python Format PyPi Mypy Code Style security: bandit

FastAPI Class Views and utilities


Version: 0.0.7

Documentation: https://performancemedia.github.io/fastapi-views/

Repository: https://github.com/performancemedia/fastapi-views


Installation

pip install fastapi-views

Usage

from typing import Optional
from uuid import UUID

from fastapi_views import Serializer, ViewRouter
from fastapi_views.views.viewsets import AsyncAPIViewSet


class ItemSchema(Serializer):
    id: UUID
    name: str
    price: int


items = {}


class MyViewSet(AsyncAPIViewSet):
    api_component_name = "Item"
    serializer = ItemSchema
    
    async def list(self):
        return list(items.values())

    async def create(self, item: ItemSchema) -> ItemSchema:
        items[item.id] = item
        return item

    async def retrieve(self, id: UUID) -> Optional[ItemSchema]:
        return items.get(id)

    async def update(self, item: ItemSchema):
        items[item.id] = item

    async def destroy(self, id: UUID) -> None:
        items.pop(id, None)

router = ViewRouter(prefix="/items")
router.register_view(MyViewSet)
# in app.py
# app.include_router(router)

Features

  • Class Based Views
    • APIViews
    • GenericViews
    • ViewSets
  • Both async and sync function support
  • No dependencies on ORM
  • Openapi id simplification
  • 'Smart' and fast serialization using orjson
  • Http Problem Details implementation
  • Automatic prometheus metrics exporter
  • Pluggable healthcheck helper

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

fastapi_views-0.0.7.tar.gz (18.8 kB view details)

Uploaded Source

Built Distribution

fastapi_views-0.0.7-py3-none-any.whl (24.9 kB view details)

Uploaded Python 3

File details

Details for the file fastapi_views-0.0.7.tar.gz.

File metadata

  • Download URL: fastapi_views-0.0.7.tar.gz
  • Upload date:
  • Size: 18.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.18

File hashes

Hashes for fastapi_views-0.0.7.tar.gz
Algorithm Hash digest
SHA256 c57040ae41823754459053be80d65eddb702a20e7ff0cca6c68be2924e7fc556
MD5 a9b9acf2af756797abe91c41c476913e
BLAKE2b-256 01be50ba942d4c93fc1316915b58cd2fd27ae97bc48298a3c0c5430b63ba4f17

See more details on using hashes here.

File details

Details for the file fastapi_views-0.0.7-py3-none-any.whl.

File metadata

File hashes

Hashes for fastapi_views-0.0.7-py3-none-any.whl
Algorithm Hash digest
SHA256 847194a4845c736bfe80d1d30ce2f27bed0334bc4f860ec839d4edfce68b1616
MD5 f0c4f75e442c49e3580d528a0a1c78f6
BLAKE2b-256 a4b71b5310dc244db889894fcfbd676b6c3804f13c0b7b804f67fe99169e23ac

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