🚀 Quick Start
Create FastAPI App for more visit https://fastapi.tiangolo.com/
⚙️ Installation
pip install fast-mu-builder
🚀 Setting Up a Custom User Model in FastAPI with Tortoise ORM + FastAPI-Builder
This guide explains how to create a package module for your User model, extend it from AbstractUser, configure it in Tortoise ORM, and generate GraphQL + migrations.
📂 Project Structure
myapp
├── mymodel_package
│ ├── __init__.py
│ └── models
│ └── ..
├── config
│ ├── __init__.py
│ └── tortoise.py
├── main.py
└── ...
🗄️ 3. Create Tortoise ORM Config
Inside config/tortoise.py:
from decouple import config
db_url = f"postgres://{config('DB_USER')}:{config('DB_PASSWORD')}@{config('DB_HOST')}:{config('DB_PORT')}/{config('DB_NAME')}"
TORTOISE_ORM = {
"connections": {"default": db_url},
"apps": {
"models": {
"models": [
"fast_mu_builder.models", # built-in models
"mymodel_package.models", # your custom models
"aerich.models", # migration tracking
],
"default_connection": "default",
},
},
"use_tz": True, # Enable timezone-aware datetimes
"timezone": "Africa/Dar_es_Salaam", # Set to EAT (Dar es Salaam)
}
🔧 4. Generate CRUD APIs via GraphQL
Run the following to scaffold GraphQL CRUD APIs:
# For your custom User model
graphql gen:crud-api user_management --module-package=mymodel_package.models --model User
# For fast_mu_builder built-in models
graphql gen:crud-api user_management --module-package=fast_mu_builder.models --model Group,Permission,Headship
graphql gen:crud-api workflow --module-package=fast_mu_builder.models --model Workflow,WorkflowStep,Transition,Evaluation
For your Models
#
graphql gen:crud-api <module-name> --model Model1,Model2,Model3
# generating graphql schemas with attachments
graphql gen:crud-api <module-name> --model ModelName --with-attachment
# generating graphql schemas with transition
graphql gen:crud-api <module-name> --model ModelName --with-transition
📦 5. Initialize Aerich (DB migrations)
# Initialize Aerich with your Tortoise ORM config
aerich init -t config.tortoise.TORTOISE_ORM
# Create initial migration & database tables
aerich init-db
📖 Documentation
Coming soon...
🤝 Contributing
Contributions, issues, and feature requests are welcome!
Feel free to check the issues page.
📜 License
This project is licensed under the MIT License.
Thanks
Thanks for all the contributors that made this library possible, also a special mention to Japhary Juma, Shija Ntula and Juma Nassoro.
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fast_mu_builder-0.1.0.31.tar.gz.
File metadata
- Download URL: fast_mu_builder-0.1.0.31.tar.gz
- Upload date:
- Size: 82.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
cbbf17d3be9fe2f17484ec06ae60cac868ef5d9a6ef32f7a97044edc23ea1652
|
|
| MD5 |
f6e3168420164a989bb2a5cc8f370de3
|
|
| BLAKE2b-256 |
dc19a63e3be643abe46a4daeceea142da9f941da7afd254fb812181bd1324ad4
|
File details
Details for the file fast_mu_builder-0.1.0.31-py3-none-any.whl.
File metadata
- Download URL: fast_mu_builder-0.1.0.31-py3-none-any.whl
- Upload date:
- Size: 105.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
twine/6.2.0 CPython/3.12.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e98c910769e6fb9fc8d6fc9882e88a89ac097ffee0fab46a4b26f86d16cab40c
|
|
| MD5 |
20822fb649c22d9c37e368f57e384be4
|
|
| BLAKE2b-256 |
1a7c2ef59d10c2253d74d55e2a637d04ea3dcbbc0209709de88cefe3f1b0c935
|
