fastack is an intuitive framework based on FastAPI
Project description
Fastack
⚡ Fastack makes your FastAPI much easier 😎
fastack is an intuitive framework based on FastAPI, for creating clean and easy-to-manage REST API project structures. It's built for FastAPI framework ❤️
WARNING 🚨
This is an early development, lots of changes with each release. Also this is an experimental project, as I'm currently studying asynchronous environments.
FYI, this isn't the only intuitive framework project I've made. I've also made with different framework bases, including:
- zemfrog - Based on Flask framework
- falca - Based on Falcon framework
Features 🔥
- Project layout (based on cookiecutter template)
- Pagination support
- Provide a
Controller
class for creating REST APIs - Provides command line to manage app
- Support to access
app
,request
,state
, andwebsocket
globally! - and more!
Plugins 🎉
List of official plugins:
- fastack-sqlmodel - SQLModel integration for fastack.
- fastack-migrate - Alembic integration for fastack.
- fastack-mongoengine - MongoEngine integration for fastack.
- fastack-cache - Caching plugin for fastack
Installation 📦
pip install -U fastack
Example 📚
Create a project
fastack new awesome-project
cd awesome-project
Install pipenv & create virtual environment
pip install pipenv && pipenv install && pipenv shell
Run app
fastack runserver
Documentation 📖
For the latest documentation, see the feature/docs branch.
Build the latest documentation locally:
mkdocs serve
Or alternatively, you can visit https://fastack.readthedocs.io/en/latest/
Tests 🔬
Run tests with tox
, maybe you need to install python version 3.7
, 3.8
and 3.9
first.
tox
All components have not been fully tested, feel free if anyone wants to help make unit tests :)
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.