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

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.5.tar.gz (18.4 kB view details)

Uploaded Source

Built Distribution

fastapi_views-0.0.5-py3-none-any.whl (24.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for fastapi_views-0.0.5.tar.gz
Algorithm Hash digest
SHA256 d2faa8cf445d3b8d9d4fd232eaac8964c67aab9f3bbfe669387e6317725adb57
MD5 0064dbbf52e23056567a507479f5869b
BLAKE2b-256 779314cf672aeaa140235099aac5b586dc7c66c8f6905f9b5cd93305fca6f313

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for fastapi_views-0.0.5-py3-none-any.whl
Algorithm Hash digest
SHA256 4b0854f19e0c00604af335cc966ccabef2b07225cd1cfa51136fb4d414655df3
MD5 6d68a946710a8f107c83965f120d34ba
BLAKE2b-256 b0ac02ae4d56be08e3d9ba8bb87f60689fc1111e6d4a5b341d51da4c153ec0cf

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