Fss aims to be one of top scaffold in PyWeb.
Project description
特性
- 开箱即用, 内置常见数据库、缓存([默认]Sqlite, PostgreSQL, MySQL, [默认]文件缓存, Redis)
- 自带单表的几乎所有操作
- 数据库迁移, 静态代码扫描, 接口文档等一众特性
快速开始
- 首先确保python的版本是3.8及以上的
- 克隆代码
git clone https://github.com/tyvekzhang/fastapi-sqlmodel-starter
cd fastapi-sqlmodel-starter/src
- [可选]创建虚拟环境, 本篇以venv为例, 类似的工具还有conda, virtualenv等
python3 -m venv .env_fss
- [可选]激活虚拟环境
- Windows: .env_fss\Scripts\activate
- macOS 或 Linux: source .env_fss/bin/activate
- 安装 Poetry并下载依赖
pip install poetry --trusted-host=mirrors.tuna.tsinghua.edu.cn --index-url=https://mirrors.tuna.tsinghua.edu.cn/pypi/web/simple
poetry install
- 数据库迁移
alembic upgrade head
- 启动
- Windows: python3 fss\apiserver.py
- macOS 或 Linux: python3 fss/apiserver.py
- 访问: http://127.0.0.1:9010/docs
文档
贡献
欢迎为 FastapiSqlmodelStarter 做出贡献!你可以通过以下方式参与:
- 提交 Bug 或功能需求到 Issue 追踪器
- 提交代码改进的 Pull Request
- 编写和改进文档
- 分享你使用 FastapiSqlmodelStarter 的经验和想法
许可证
FastapiSqlmodelStarter 采用 MIT 许可证开源。
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
Close
Hashes for fastapi_sqlmodel_starter-1.0.0b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5be3bc9b6b29312886b50c223e968fdd1a47465f5b36e23bf205ec0b421b46c |
|
MD5 | 77e84ccf87e431bd6d5f690a03346e94 |
|
BLAKE2b-256 | 67e38620686487d11183f8ea9665178c7d91a888aa3f8a23ea5f41dc54e57ded |
Close
Hashes for fastapi_sqlmodel_starter-1.0.0b0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 05db2864684ebb6d6ca2955b94e77b8b02d6239829f7335da1b59d91cdb77894 |
|
MD5 | 15e5d10121dfc335739b1d054d852111 |
|
BLAKE2b-256 | c86aaa7d715fcf67d01cf77ce416640cc192499055357c4bf9ae32af0cbea8db |