FastaAPI's CRUD project generator for SQLALchemy.
Project description
Fastapi CRUD Project Generator
A code generator that help you to establish a fastapi project with CRUD router from your Sqlalchemy model. Which supports following api:
- Get one
- Get many
- Insert one
- Insert many
- Update one
- Update many
- Patch one
- Patch many
- Delete one
- Delete many
Quick Start with in-memory DB
Install
pip install fastapi-crud-code-generator
Prepare your Sqlalchemy schema
- You can use sqlacodegen to generate SQLAlchemy models for your table. This project is based on the model development and testing generated by sqlacodegen
from sqlalchemy import *
from sqlalchemy.orm import declarative_base
Base = declarative_base()
metadata = Base.metadata
class SampleTable(Base):
__tablename__ = 'test_build_myself_memory'
__table_args__ = (
UniqueConstraint('primary_key', 'int4_value', 'float4_value'),
)
primary_key = Column(Integer, primary_key=True, autoincrement=True)
bool_value = Column(Boolean, nullable=False, default=False)
bytea_value = Column(LargeBinary)
char_value = Column(CHAR(10, collation='NOCASE'))
date_value = Column(Date)
float4_value = Column(Float, nullable=False)
float8_value = Column(Float(53), nullable=False, default=10.10)
int2_value = Column(SmallInteger, nullable=False)
int4_value = Column(Integer, nullable=False)
int8_value = Column(BigInteger, default=99)
text_value = Column(Text)
varchar_value = Column(String)
class SampleTableTwo(Base):
__tablename__ = 'test_build_myself_memory_two'
primary_key = Column(Integer, primary_key=True, autoincrement=True)
bool_value = Column(Boolean, nullable=False, default=False)
bytea_value = Column(LargeBinary)
Use crud_router_builder()
to generate the project from the executing folder (using in-memory sqlite db here)
from fastapi_quickcrud_codegen import crud_router_builder, CrudMethods
crud_router_builder(
db_model_list=[
{
"db_model": SampleTable,
"prefix": "/my_first_api",
"tags": ["sample api"],
"exclude_columns": ['bytea_value'],
"crud_methods":[CrudMethods.FIND_ONE, CrudMethods.FIND_MANY, CrudMethods.CREATE_ONE, CrudMethods.UPDATE_MANY, CrudMethods.PATCH_MANY, CrudMethods.PATCH_ONE],
},
{
"db_model": SampleTableTwo,
"prefix": "/my_second_api",
"tags": ["sample api"],
"exclude_columns": ['bytea_value'],
}
],
#is_async=True,
#database_url="sqlite+aiosqlite://",
is_async=False,
database_url="sqlite://"
)
crud_router_builder args
-
db_model_list
[Required]
Model list of dict for code generate
List[]
Dict[]
- db_model
[Required[SQLALchemy Declarative Base Class]]
- prefix
[Required[str]]
prefix for Fastapi's end point
- tags
[Required[List[str]]]
list of tag for Fastapi's end point
- exclude_columns
[Optional[str]]
set the columns that not to be operated but the columns should nullable or set the default value)
- crud_methods
[Opional[str]]
- Create the following apis for that model, but default: [CrudMethods.FIND_MANY, CrudMethods.FIND_ONE, CrudMethods.CREATE_MANY, CrudMethods.PATCH_ONE, CrudMethods.PATCH_MANY, CrudMethods.PATCH_ONE, CrudMethods.UPDATE_MANY, CrudMethods.UPDATE_ONE, CrudMethods.DELETE_MANY, CrudMethods.DELETE_ONE]
- CrudMethods.FIND_ONE - CrudMethods.FIND_MANY - CrudMethods.UPDATE_ONE - CrudMethods.UPDATE_MANY - CrudMethods.PATCH_ONE - CrudMethods.PATCH_MANY - CrudMethods.CREATE_ONE - CrudMethods.CREATE_MANY - CrudMethods.DELETE_ONE - CrudMethods.DELETE_MANY
- db_model
-
is_async
[Required]
True for async; False for sync
-
database_url
[Optional (str)]
A database URL. The URL is passed directly to SQLAlchemy's create_engine() method so please refer to SQLAlchemy's documentation for instructions on how to construct a proper URL.
Known limitations
- ❌ If there are multiple unique constraints, please use composite unique constraints instead
- ❌ Composite primary key is not supported
- ❌ Sqlalchemy table tpye model schema is not supported
Design:
The model generation part and api router part refer to my another project; The code generation part is using Jinja
How to contribute more api?
It will be super excited if you have any idea with api router/ model template. then you can follow the step as below to try to contribute.
- Model generation
- Prepare Jinja template to
fastapi-crud-project-generator/src/fastapi_quickcrud_codegen/model/template
- Prepare model code generation method from
fastapi_quickcrud_codegen.utils.schema_builder.ApiParameterSchemaBuilder
- Generate the code from
fastapi_quickcrud_codegen/model/model_builder.py
- Prepare Jinja template to
- CRUD Method Generation
- After the model generation, you can try to build your own api by your own model
- Modify
fastapi_quickcrud_codegen.utils.sqlalchemy_to_pydantic.sqlalchemy_to_pydantic
,fastapi_quickcrud_codegen.misc.type.CrudMethods
andfastapi_quickcrud_codegen.misc.crud_model.CRUDModel
to let project supports your api - Prepare your api router Jinja template from
src/fastapi_quickcrud_codegen/model/template/route
- Generate the code from
fastapi_quickcrud_codegen/model/crud_builder.py
- Update the api_register from
src/fastapi_quickcrud_codegen/crud_generator.py
- use Sqlalchemy's sql.expression instead custom statement when building sql statement for your api
Road map
Current State: Beta
Will be changed t0 stable version when:
- Unit test coverage 100%
- Apply code style checking
- Typing
After stable version:
- Support foreign tree in find api
- Support foreign tree in insert api
- Support foreign tree in update api
- Support foreign tree in delete api
Good to have:
- Support Sqlalchemy Table type model
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for fastapi-crud-code-generator-0.0.1b14.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | cec284491ff5f48bd638a9c3ab644df36a028aa73691ec0091fa4a425eeef71a |
|
MD5 | becd0d9e77befe7e745f44c84606386e |
|
BLAKE2b-256 | f889e879884d71d13043c806d8791f4be87dfa0bf20715da6e9ae7dc9f154313 |
Hashes for fastapi_crud_code_generator-0.0.1b14-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2bda93e616017bedd2443abed3e5cda318ac90ddabc401b4fd5b0b5ef7aab7c4 |
|
MD5 | b1882d458c7b814329169dd353590856 |
|
BLAKE2b-256 | 2606929fa3f35437b44cd3ca1dfca7b49af6ff6daf6a66095b36420382075d85 |