Python项目标准结构，我推荐这个！

你好，我是zhenguo

这是我的 第503篇原创 。

这篇文章讲什么？

做数据分析习惯使用Jupyter notebook，编写几行代码，很方便得到结果。

但在真正项目中，一般使用PyCharm或VSCode开发。那有的小伙伴就问了，项目文件目录有没有一个标准的结构？

应该没有唯一的统一标准，但Python社区大佬Kenneth Reitz在2013年提出一个Python项目目录结构，推荐你日后项目中参考。

Python项目推荐结构

Kenneth推荐目录结构，如下所示：

samplemod-master
├── LICENSE
├── MANIFEST.in
├── Makefile
├── README.rst
├── docs
│   ├── Makefile
│   ├── conf.py
│   ├── index.rst
│   └── make.bat
├── requirements.txt
├── sample
│   ├── __init__.py
│   ├── core.py
│   └── helpers.py
├── setup.py
└── tests
    ├── __init__.py
    ├── context.py
    ├── test_advanced.py
    └── test_basic.py

一共3个文件夹，17个文件。

先来看看第一个文件夹 docs ，它是项目相关文档，包括依赖包安装的 Makefile 和 make.bat ，项目配置 conf.py ，项目介绍文档 index.rst ，是比 README.rst 更细化的一个文档， README.rst 更像一个项目总览。

第二个文件夹 sample ，在Python中一般叫做包( package )，它是项目核心代码，一般会有多个这种包， __init__.py 是Python包包括的文件。 core.py 和 helpers.py 是 sample 包里两个核心模块。

第三个包 tests ，是对应于 sample 包的单元测试包，里面的模块名称一般以 test 开头，测试 sample 里的每个模块。

setup.py是做什么的？

有了上面三个最主要的包外，文件最重要的有 setup.py ，这个文件是做什么的？

简单来说， setup.py 是和打包相关的配置模块，一般结合 setuptools 。

有了 setup.py ，我们就可以安装包到本地全局环境，或者上传到 PyPi ，这样全世界开发者都有机会搜索到你的包，并使用pip安装上你的包。

里面代码相对比较标准和固定，比如在这个项目里代码如下：

from setuptools import setup, find_packages
with open('README.rst') as f:
    readme = f.read()
with open('LICENSE') as f:
    license = f.read()
setup(
    name='sample',
    version='0.1.0',
    description='Sample package for Python-Guide.org',
    long_description=readme,