python packaging quickstart

https://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/index.html

1.项目结构
一个小的python工程包含两个文件.setup.py文件描述了项目的元信息,.py文件则则源代码.
在这个示例中,我们将增加__init__.py文件,预示着这个工程将来会有很多模块.

package_project
├── example_pkg # 要打包的package
│   └── __init__.py
├── setup.py # 打包的配置

其他文件
如果想要包含非.py文件则需要添加MANIFEST.in文件
创建README.txt描述整个工程的概况
创建LICENSE.txt描述声明

2.描述项目
setup.py是整个项目的核心,有三个字段来描述name,version,packages.如果想在pypi上发布,name必须是唯一的.packages描述源码在工程的哪个地方.

from setuptools import setup

setup(
    name='name', # 在PyPI上名字
    version='0.1dev',
    packages=['example_pkg',], # 指定要打的包
)

3.创建第一个发布版本
python setup.py bdist_wheel
将在setup.py的同级目录下创建一个dist文件夹,里面的name-0.0.1-py3-none-any.whl文件包含了所有的源代码.

4.使用pip install name-0.0.1-py3-none-any.whl来进行安装