Python 项目工程化开发指南

文档目标：

以通俗易懂结构清晰的文档向读者展示如何做 Python 工程化

受众目标：

指南主要包含以下主题：

如果您对文档有任何建议或意见，欢迎提交 issues 进行讨论。当然我们更期待与您共同协作开发，让文档变得更加完善。

使用方式

git clone https://github.com/pyloong/pythonic-project-guidelines

项目预览需要安装 Python 环境来启动 server，强烈建议使用 Python 3.9+ 的版本。如果本地没有 Python 环境，也可以使用 Docker预览服务器来启动。

创建虚拟环境：

python3 -m venv .venv
source .venv/bin/activate

安装依赖：

pip install -r requirements.txt

docker pull squidfunk/mkdocs-material:9.1.11

mkdocs serve

unix:

docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material:9.1.11

Windows:

docker run --rm -it -p 8000:8000 -v "%cd%":/docs squidfunk/mkdocs-material:9.1.11

文档使用 Markdown 编写，使用 mkdocs 配合 mkdocs-material 主题构建。