Merge branch 't3' into main

# Conflicts:
#	Makefile
#	README.md
#	conftest.py
#	example/example/settings.py
#	fast_tmp/admin/depends.py
#	fast_tmp/admin/endpoint.py
#	fast_tmp/admin/schema/__init__.py
#	fast_tmp/admin/schema/amis_json.py
#	fast_tmp/admin/schema/crud.py
#	fast_tmp/admin/schema/forms/__init__.py
#	fast_tmp/admin/server.py
#	fast_tmp/admin/templates/base.html
#	fast_tmp/admin/templates/index.html
#	fast_tmp/admin/templates/login.html
#	fast_tmp/amis/buttons.py
#	fast_tmp/amis/forms/enums.py
#	fast_tmp/amis/forms/widgets.py
#	fast_tmp/amis/page.py
#	fast_tmp/conf/__init__.py
#	fast_tmp/depends/auth.py
#	fast_tmp/depends/cas.py
#	fast_tmp/jinja_extension/tags.py
#	fast_tmp/models.py
#	fast_tmp/responses.py
#	fast_tmp/site/__init__.py
#	fast_tmp/utils/crud2.py
#	fast_tmp/utils/crud3.py
#	fast_tmp/utils/password.py
#	fast_tmp/utils/swagger_static_file.py
#	fast_tmp/utils/token.py
#	fast_tmp/utils/tortoise_dantic/__init__.py
#	fastapi_cli/__init__.py
#	fastapi_cli/tpl/project/{{cookiecutter.project_slug}}/.env
#	fastapi_cli/tpl/project/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/app.py
#	fastapi_cli/tpl/project/{{cookiecutter.project_slug}}/{{cookiecutter.project_slug}}/settings.py
#	poetry.lock
#	pyproject.toml
#	task.md
#	tests/test_example/pyproject.toml
#	tests/test_example/test_example/models.py
#	tests/test_example/test_example/schemas.py
#	tests/test_example/test_example/site.py
#	tests/testmodels.py

Author: Chise1

Makefile

@@ -1,6 +1,8 @@
-checkfiles = fast_tmp/ tests/
+checkfiles = fast_tmp/ tests/ conftest.py
 black_opts = -l 100 -t py38
 py_warn = PYTHONDEVMODE=1
+test_settings = SETTINGS_MODULE=tests.settings
+pytest_opts = -n auto --cov=fast_tmp --tb=native -q
 
 help:
 	@echo "fastapi-cli development makefile"
@@ -23,24 +25,18 @@ style: deps
 	isort -src $(checkfiles)
 	black $(black_opts) $(checkfiles)
 
-check:
+check: deps
 	black --check $(black_opts) $(checkfiles) || (echo "Please run 'make style' to auto-fix style issues" && false)
 	flake8 $(checkfiles)
-	bandit -x test -r $(checkfiles)
-	mypy $(checkfiles)
+	bandit -x test -r $(checkfiles) -c pyproject.toml
+	mypy fast_tmp/
 
 
-test:
-	pytest tests/ --cov-report=
+test: deps
+	$(py_warn) FASTAPI_SETTINGS_MODULE=tests.settings TORTOISE_TEST_DB=sqlite://:memory: pytest --cov-report html $(pytest_opts)
 
-cov: deps
-	coverage run -m pytest tests/
-	coverage report --show-missing -m --omit=tests/*,conftest.py
-	coverage xml
-	coverage html
+test_sqlite:
+	$(py_warn) FASTAPI_SETTINGS_MODULE=tests.settings TORTOISE_TEST_DB=sqlite://:memory: pytest --cov-report= $(pytest_opts)
 
 publish: check
-	poetry publish --build
-
-docs:
-	mkdocs build
+	poetry publish

README.md

@@ -1,137 +1,87 @@
-# fast-tmp
-
-[![Python package](https://github.com/Chise1/fast-tmp/actions/workflows/test.yml/badge.svg)](https://github.com/Chise1/fast-tmp/actions/workflows/test.yml)
-[![codecov](https://codecov.io/gh/Chise1/fast-tmp/branch/main/graph/badge.svg?token=7CZE532R0H)](https://codecov.io/gh/Chise1/fast-tmp)
-[![Documentation Status](https://readthedocs.org/projects/fast-tmp/badge/?version=latest)](https://fast-tmp.readthedocs.io/?badge=latest)
-![GitHub](https://img.shields.io/github/license/Chise1/fast-tmp)
-
-# 介绍
-
-fast-tmp项目受django-admin的影响，旨在实现一个基于sqlalchemy+fastapi+amis的通用后台管理平台。
-
-- sqlalchemy:python最受欢迎的数据库操作工具。
-- fastapi:新版本python最受欢迎的web框架之一。
-- amis:一款利用json数据生成页面的前端低代码项目。
-
-笔者前端能力比较弱，从实用主义出发，利用amis搭建后台管理的页面。这也为未来页面的功能拓展提供了无限可能。并摆脱前端开发的影响。（由于偷懒，登陆页面用的taber构建的。以后有时间了修改）
-更多内容查看[教程](https://fast-tmp.readthedocs.io/)
-## 示例
+[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
 
-## 该项目的存在意义
-
-fastapi是一款非常优秀的web框架，long2ice基于异步数据库访问库（tortoise-orm）构建了fastapi-admin项目，使用fastapi+tortoise-orm。
-笔者新项目需要使用到sqlalchemy，也没有找到合适的库，所以决定自己动手来实现自己需要的功能。
-
-## 页面展示
+# fast-tmp
 
-![登陆](./docs/static/img/login.png)
-![主页](./docs/static/img/home.png)
-![userinfo](./docs/static/img/userinfo.png)
-![create](./docs/static/img/create.png)
+项目模板
 
-## 入门
+## 概述
+本项目主要是方便快速构建fastapi的后端开发环境，依赖于```cookiecutter```，并提供方便快捷的生成路由的方法。
+主要使用的开发包：
 
-### 安装
+1. fastapi
+2. tortoise-orm
+3. cookiecutter
 
-通过pip进行安装：
+整个项目在开发过程中参考了django的一些实现方式，尽量做到简洁明了。
 
-```shell
-pip install fast-tmp
+## 安装fast-tmp
+使用pip
+```shell script
+pip3 install fast-tmp
 ```
-
-如果使用poetry,则
-
-```shell
+使用poetry
+```shell script
 poetry add fast-tmp
 ```
+## 项目指令
+目前包含的操作指令有两个:
+1. 创建项目
+2. 创建超级用户
 
-## 快速教程
+支持自定义指令并创建
 
-在项目启动的根目录先创建一个.env文件,主要内容如下：
-
-```text
-DATABASE_URL=sqlite:///example.db # 数据库
-SECRET_KEY=rtbhwaergvqerg # user加密用的密码
-DEBUG=False # 是否启动debug模式，debug模式会打印所有访问数据的的操作
+### 创建项目
+```shell script
+fast-tmp startproject
 ```
-
-如果你有这么一个model:
-
-```python
-# models.py
-from sqlalchemy import String, Boolean, Integer, DateTime, DECIMAL, Float, JSON, Text, Column
-from fast_tmp.models import Base
-
-
-class UserInfo(Base):
-    __tablename__ = "userinfo"
-    id = Column(Integer, primary_key=True)
-    name = Column(String(128), unique=True)
-    age = Column(Integer, default=10, )
-    birthday = Column(DateTime)
-    money = Column(DECIMAL(scale=3))
-    height = Column(Float)
-    info = Column(JSON)
-    tag = Column(Text)
-    is_superuser = Column(Boolean(), default=True)
-
-```
-
-那么，你只需要构建一个页面model:
-
+输入完所需的参数之后，就可以生成一个自己的项目。
+### 创建超级用户
+创建超级用户需要使用了fast-tmp自带的models，
+首先，在项目.settings的TORTOISE_ORM里面配置fast-tmp的model
 ```python
-# admin.py
-from fast_tmp.site import ModelAdmin
-from .models import UserInfo
-
-
-class UserInfoAdmin(ModelAdmin):
-    model = UserInfo
-    create_fields = [UserInfo.name, UserInfo.age, UserInfo.birthday, UserInfo.money, UserInfo.height, UserInfo.info,
-                     UserInfo.tag, UserInfo.is_superuser]
-    update_fields = create_fields
-    list_display = [UserInfo.id, UserInfo.name, UserInfo.age, UserInfo.birthday, UserInfo.money, UserInfo.height,
-                    UserInfo.info,
-                    UserInfo.tag, UserInfo.is_superuser]
+import os
+TORTOISE_ORM = {
+    'connections': {
+        'default': {
+            'engine': 'tortoise.backends.mysql',
+            'credentials': {
+                'host': os.getenv("DB_HOST"),
+                'port': os.getenv("DB_PORT"),
+                'user': os.getenv("DB_USER"),
+                'password': os.getenv("DB_PASSWORD"),
+                'database': os.getenv("DB_NAME"),
+            }
+        },
+    },
+    'apps': {
+        'fast_tmp': {
+            'models': ['fast_tmp.models', 'aerich.models'],  # 注册app.models
+            'default_connection': 'default',
+        }
+    }
+}
 ```
-
-然后进行注册：
-
-```python
-# main.py
-from fast_tmp.site import register_model_site
-from example.admin import UserInfoAdmin
-
-register_model_site({"Example": [UserInfoAdmin]})  # example是页面上标签名，对应是一个列表。
+然后，只需要执行：
+```shell script
+fast-tmp createsuperuser
 ```
+### 自定义指令
 
-可以把admin功能单独启动或者注册到现有项目上： 注册到项目上
-
-```python
-from fastapi import FastAPI
-
-from fast_tmp.admin.server import admin
-from fast_tmp.site import register_model_site
-from example.admin import UserInfoAdmin
-
-register_model_site({"Example": [UserInfoAdmin]})  # 注册页面
-app = FastAPI()
-app.mount("/admin", admin, name="admin", )  # 注册admin的app，注意暂时只能为/admin，以后会进行修改
-
-if __name__ == '__main__':  # 调试模式启动
-    import uvicorn
+在settings里面配置```EXTRA_SCRIPT```参数，就像配置django的参数一样，把脚本的相对导入路径写到这个字段列表里面，即可通过fast-tmp进行执行。
 
-    uvicorn.run(app, debug=True, port=8000, lifespan="on")
-```
+可以通过```fast-tmp --help```查看当前有哪些执行指令
 
-### 创建超级用户
+## 功能
+初始化项目之后，fast-tmp包里面有如下功能：
+1. 全局settings管理
+2. crud生成器
 
-```shell
-fast-tmp createsuperuser username password
-```
+### 全局settings管理
 
-### 自定义指令
-
-在settings里面配置```EXTRA_SCRIPT```参数，就像配置django的参数一样，把脚本的相对导入路径写到这个字段列表里面，即可通过fast-tmp进行执行。
+这个主要功能就是在所有地方都是通过```fast_tmp.conf.settings```获取设置值或环境变量。
 
-可以通过```fast-tmp --help```查看当前有哪些执行指令
+具体使用如下：
+```python
+from fast_tmp.conf import settings
+...
+```

conftest.py

@@ -1,23 +1,3 @@
-from typing import Generator
+import os
 
-from sqlalchemy import select
-from sqlalchemy.engine import ChunkedIteratorResult
-
-from fast_tmp.models import Base, User
-import tests.models
-import pytest
-from fast_tmp.db import engine, get_db_session
-
-
-@pytest.fixture(autouse=True, scope="function")
-def prepare_database() -> Generator[None, None, None]:
-    Base.metadata.create_all(engine)
-    session = next(get_db_session())
-    res: ChunkedIteratorResult = session.execute(select(User.username).where(User.username == "root"))
-    if len(res.fetchall()) == 0:
-        user = User(username="root")
-        user.set_password("root")
-        session.add(user)
-        session.commit()
-    yield
-    Base.metadata.drop_all(engine)
+os.environ.setdefault("FASTAPI_SETTINGS_MODULE", "tests.settings")

example/example/admin.py

@@ -1,25 +1,63 @@
+from test_example.models import Author, Book, FieldTesting
+
 from fast_tmp.site import ModelAdmin
-from .models import UserInfo, Author, Book
 
 
-class UserInfoAdmin(ModelAdmin):
-    model = UserInfo
-    create_fields = [UserInfo.name, UserInfo.age, UserInfo.birthday, UserInfo.money, UserInfo.height, UserInfo.info,
-                     UserInfo.tag, UserInfo.is_superuser]
-    update_fields = create_fields
-    list_display = [UserInfo.id, UserInfo.name, UserInfo.age, UserInfo.birthday, UserInfo.money, UserInfo.height,
-                    UserInfo.info,
-                    UserInfo.tag, UserInfo.is_superuser]
+class FieldTestingModel(ModelAdmin):
+    model = FieldTesting
+    list_display = (
+        "name",
+        "age",
+        "name_inline",
+        "age_inline",
+        "married",
+        "married_inline",
+        "degree",
+        "degree_inline",
+        "created_time",
+        "birthday",
+        "config",
+        "max_time_length",
+    )
+    inline = (
+        "name_inline",
+        "age_inline",
+        "married",
+        "married_inline",
+        "degree_inline",
+        "birthday",
+        "config",
+        "max_time_length",
+    )
+    create_fields = (
+        "name",
+        "age",
+        "desc",
+        "married",
+        "degree",
+        "degree_inline",
+        "gender",
+        "created_time",
+        "birthday",
+        "config",
+        "max_time_length",
+    )
 
 
-class AuthorAdmin(ModelAdmin):
-    model = Author
-    create_fields = [Author.name, Author.books]
-    list_display = create_fields
+from fast_tmp.site.filter import ContainsFilter
 
 
-class BookAdmin(ModelAdmin):
+class BookModel(ModelAdmin):
     model = Book
-    create_fields = [Book.name, Book.author]  # todo 增加提醒，可以为关系，可以为id
-    list_display = [Book.id, Book.name, Book.author]  # todo 增加检查，必须在listplay里面带主键
-    update_fields = create_fields
+    list_display = ("name", "author", "rating")
+    create_fields = ("name", "author", "rating")
+    update_fields = ("name", "author")
+    filters = (ContainsFilter("name"),)
+
+
+class AuthorModel(ModelAdmin):
+    model = Author
+    list_display = ("name",)
+    create_fields = ("name",)
+    inline = ("name",)
+    update_fields = ("name",)

example/example/settings.py

@@ -1,4 +1,6 @@
 import os
+from typing import List
+
 import dotenv
 
 dotenv.load_dotenv()
@@ -7,10 +9,26 @@
 # from sentry_sdk.integrations.redis import RedisIntegration
 
 BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+SECRET_KEY = "awdfawfqergqreef"
 
-DEBUG = os.getenv("DEBUG") == "True"
-
-EXTRA_SCRIPT = []  # 自定义执行脚本
+TORTOISE_ORM = {
+    "connections": {
+        "default": "sqlite://test_example.sqlite3",
+    },
+    "apps": {
+        "fast_tmp": {
+            "models": [
+                "test_example.models",
+                "fast_tmp.models",
+                # "aerich.models",
+            ],  # 注册app.models
+            "default_connection": "default",
+        }
+    },
+}
+STATIC_ROOT = "static"
+STATIC_PATH = "static"
+EXTRA_SCRIPT: List[str] = []  # 自定义执行脚本
 # redis配置
 # REDIS_HOST = os.getenv("REDIS_HOST", "127.0.0.1")
 # REDIS_PORT = os.getenv("REDIS_PORT", 6379)