Skip to main content

The easiest way to create your Restful CRUD APIs

Project description

CrudAPI: The easiest way to create your CRUD APIs

codecov Code style: black PyPI version

Combining the power of FastAPI, Pydantic and SQLAlchemy, you'll only have to care about modeling your data and we'll take care of building up a RESTful API for it.

from crudapi import CrudAPI
from crudapi.models.api import BaseAPI
from crudapi.models.orm import BaseORM

from sqlalchemy import Column
from sqlalchemy import String


class BookORM(BaseORM):

    __tablename__ = "books"
    title = Column(String, nullable=False)


crud = CrudAPI(orm_model=BookORM)

you'll get, out of the box, a working crudapi with all these working REST endpoints:

  • GET: /books
  • POST: /books
  • GET: /books/<id>
  • PUT: /books/<id>
  • PATCH: /books/<id>
  • DELETE: /books/<id>

and because CrudAPI subclasses FastAPI you'll also get all the incredible features of this wonderful library.


Development

We use Poetry for packaging and dependency management:

poetry install

poetry shell

We use Pytest for testing:

pytest

You can start a testing server running:

uvicorn tests.server:app --reload

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

crudapi-0.1.1.tar.gz (6.3 kB view hashes)

Uploaded Source

Built Distribution

crudapi-0.1.1-py3-none-any.whl (10.1 kB view hashes)

Uploaded Python 3

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