fastapi-scaff 0.1.0__py3-none-any.whl → 0.5.5__py3-none-any.whl

{fastapi_scaff-0.1.0.dist-info → fastapi_scaff-0.5.5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-scaff
-Version: 0.1.0
+Version: 0.5.5
 Summary: This is a fastapi scaff.
 Author-email: axiner <atpuxiner@163.com>
 Project-URL: Homepage, https://github.com/atpuxiner/fastapi-scaff
@@ -25,16 +25,26 @@ Dynamic: license-file
         - auto register router
         - auto register middleware
         - ...
+        - integrated sqlalchemy
+        - integrated jwt\api-key
+        - integrated celery
+        - integrated docker deployment
+        - ...
+    - about structure:
+        - standard
+        - light
+        - tiny
+        - single
     - more documents: [请点击链接](https://blog.csdn.net/atpuxiner/article/details/144291336?fromshare=blogdetail&sharetype=blogdetail&sharerId=144291336&sharerefer=PC&sharesource=atpuxiner&sharefrom=from_link)
 
 ## Project structure
 
-- ASM: ASM模式
+- ASM: ASM mode
     - A api
-    - S service(&schema)
-    - M model
-- 调用过程: main.py(initializer) -> (middleware) - api - service(&schema) - (model)
-- 结构如下: (命名经过多次修改敲定，简洁易懂)
+    - S services(&schemas)
+    - M models
+- Calling process: main.py(initializer) -> (middleware) - api - services(&schemas) - (models)
+- Structure: (The naming has been finalized after multiple revisions, making it concise and easy to understand)
   ```
   └── fastapi-scaff
       ├── app                         (应用)
@@ -46,23 +56,33 @@ Dynamic: license-file
       │   │   ├── log                 │   ├── (日志)
       │   │   └── ...                 │   └── (...)
       │   ├── middleware              ├── (中间件)
-      │   ├── model                   ├── (数据模型)
-      │   ├── schema                  ├── (数据结构)
-      │   ├── service                 ├── (业务逻辑)
+      │   ├── models                  ├── (数据模型)
+      │   ├── schemas                 ├── (数据结构)
+      │   ├── services                ├── (业务逻辑)
       │   ├── utils                   ├── (utils)
       │   └── main.py                 └── (main.py)
+      ├── app_celery                  (应用-celery)
       ├── config                      (配置目录)
-      ├── deploy                      (部署目录)
       ├── docs                        (文档目录)
       ├── logs                        (日志目录)
       ├── tests                       (测试目录)
+      ├── .dockerignore
       ├── .gitignore
+      ├── .python-version
+      ├── build.sh
+      ├── docker-compose.yaml
+      ├── Dockerfile
       ├── LICENSE
       ├── README.md
       ├── requirements.txt
       └── runserver.py
   ```
 
+- 【Other structure】
+    - light：Please create and view (with `-e light`)
+    - tiny：Please create and view (with `-e tiny`)
+    - single：Please create and view (with `-e single`)
+
 ## Installation
 
 This package can be installed using pip (Python>=3.11):
@@ -74,9 +94,15 @@ This package can be installed using pip (Python>=3.11):
     - `fastapi-scaff -h`
 - 2）new project
     - `fastapi-scaff new <myproj>`
+    - *light structure*: `fastapi-scaff new <myproj> -e light`
+    - *tiny structure*: `fastapi-scaff new <myproj> -e tiny`
+    - *single structure*: `fastapi-scaff new <myproj> -e single`
 - 3）add api
     - `cd to project root dir`
     - `fastapi-scaff add <myapi>`
+- 4）integrated celery
+    - M1。`new` with `--celery`: `fastapi-scaff new <myproj> --celery`
+    - M2。`add` with `--celery`: `fastapi-scaff add <mycelery> --celery`
 
 ## Project run
 
@@ -85,8 +111,14 @@ This package can be installed using pip (Python>=3.11):
 - 3）`pip install -r requirements.txt`
 - 4）`python runserver.py`
     - more parameters see:
-      - about uvicorn: [click here](https://www.uvicorn.org/)
-      - about gunicorn: [click here](https://docs.gunicorn.org/en/stable/)
+        - about uvicorn: [click here](https://www.uvicorn.org/)
+        - about gunicorn: [click here](https://docs.gunicorn.org/en/stable/)
+- 5）docker, please see:
+    - project files:
+        - build.sh
+        - docker-compose.yaml | docker-compose.swarm.yaml[config/nginx.conf]
+        - Dockerfile | Dockerfile.slim
+    - [more click here](https://docs.docker.com/)
 
 ## License
 

fastapi_scaff-0.5.5.dist-info/RECORD

@@ -0,0 +1,10 @@
+fastapi_scaff/__init__.py,sha256=ZlCrnNJMbJKRhWiMC-TZqFKGr58ayvhgUtOpyTAkO6w,120
+fastapi_scaff/__main__.py,sha256=WHVC2ZOhymCgdgoVo08Fg-kBaLshAHp7ZxXlyrpvnTI,22998
+fastapi_scaff/_api_tpl.json,sha256=v9xp3DtgtmlmWgvXxOkt0kck4RrXG7inQDCZBgQimuk,7821
+fastapi_scaff/_project_tpl.json,sha256=G6GGLPwUBWAG7J1FJzLLPBG8YeMpd027ZKjOUD_ZtPk,127134
+fastapi_scaff-0.5.5.dist-info/licenses/LICENSE,sha256=A5H6q7zd1QrL3iVs1KLsBOG0ImV-t9PpPspM4x-4Ea8,1069
+fastapi_scaff-0.5.5.dist-info/METADATA,sha256=a_8oTKCvlnrfFBzrqmq4SCErVuo-LjoJWFTvSeHr7HE,4636
+fastapi_scaff-0.5.5.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+fastapi_scaff-0.5.5.dist-info/entry_points.txt,sha256=kzs28nmpRWVCmWmZav3X7u7YOIOEir3sCkLnvQKTJbY,62
+fastapi_scaff-0.5.5.dist-info/top_level.txt,sha256=LeyfUxMRhdbRHcYoH37ftfdspyZ8V3Uut2YBaTCzq2k,14
+fastapi_scaff-0.5.5.dist-info/RECORD,,

{fastapi_scaff-0.1.0.dist-info → fastapi_scaff-0.5.5.dist-info}/top_level.txt

@@ -1,2 +1 @@
 fastapi_scaff
-tests

fastapi_scaff-0.1.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-fastapi_scaff/__init__.py,sha256=n40GtUaNM5XhBd7sIO5zzcmLNztvk7C4ngCT1xMKp1Q,120
-fastapi_scaff/__main__.py,sha256=F9nXaL5P4pzj_I-Hkal204GVsJEqaYUPMlvgSf_nYbw,13378
-fastapi_scaff/_api_tpl.json,sha256=Xxqz5UmJYOr0EedQLm45tZlxJuq7hlRf7r-j9Mq9cJc,6810
-fastapi_scaff/_project_tpl.json,sha256=N65CzEn7836oRy_u4zwVaMBr6rbHwA8zqBLaGMe-SJM,72654
-fastapi_scaff-0.1.0.dist-info/licenses/LICENSE,sha256=A5H6q7zd1QrL3iVs1KLsBOG0ImV-t9PpPspM4x-4Ea8,1069
-tests/__init__.py,sha256=hL1sZ5kdrEFj8BqVmf98RgCrZAfXWNUhc122nk4hwuw,18
-fastapi_scaff-0.1.0.dist-info/METADATA,sha256=4wekLntgtRbUPVz7fBKB_v3yBvUAiOZd56jD312zFDU,3376
-fastapi_scaff-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-fastapi_scaff-0.1.0.dist-info/entry_points.txt,sha256=kzs28nmpRWVCmWmZav3X7u7YOIOEir3sCkLnvQKTJbY,62
-fastapi_scaff-0.1.0.dist-info/top_level.txt,sha256=GYgW8daqMJBN-Gv-z0JiFM2XWuSyBoEgXwqJW1wi0hg,20
-fastapi_scaff-0.1.0.dist-info/RECORD,,

tests/__init__.py

@@ -1,3 +0,0 @@
-"""
-测试
-"""