Darren 1 年之前
父節點
當前提交
5962acf86d
共有 4 個文件被更改,包括 23 次插入3 次删除
  1. 1 0
      appmanage/api/utils/nginx.py
  2. 1 0
      appmanage/api/utils/sqlite.py
  3. 5 3
      appmanage/cli/README.md
  4. 16 0
      appmanage/docs/DEV-SETUP.md

+ 1 - 0
appmanage/api/utils/nginx.py

@@ -0,0 +1 @@
+# connect Nginx Proxy Manager and executive API commands

+ 1 - 0
appmanage/api/utils/sqlite.py

@@ -0,0 +1 @@
+# connect sqlite and CRUD

+ 5 - 3
appmanage/cli/README.md

@@ -1,3 +1,5 @@
-# auto convert to cli
-https://www.convertapi.com/doc/cli-library  
-https://github.com/apicollective/apibuilder-cli
+# Auto convert to cli
+
+* [Python Fire](https://github.com/google/python-fire)
+* https://www.convertapi.com/doc/cli-library  
+* https://github.com/apicollective/apibuilder-cli

+ 16 - 0
appmanage/docs/DEV-SETUP.md

@@ -1,5 +1,21 @@
 # Dev-Setup
 
+AppManage is based Python, and you should read the [Architecture docs](./architecture.md) if you want to contributing code for it.  
+
+## Code format
+
+You can refer to [PEP 8 – Style Guide for Python Code](https://peps.python.org/pep-0008/) and use fomatter tool [Black](https://github.com/psf/black):
+
+```
+pip install black
+black {source_file_or_directory}
+```
+
+## Test
+
+You can test function,class,module and unit by automatic tools []()
+
+
 ## Development runtime
 
 You can use Windows/Linux/Mac for AppMange development if you have Docker and Python3.8 on you machine.