一个基本的python package应该含有如下两个大内容:
- 一个包含软件包名称的文件夹,其中又包含:
- 组成程序包的Python代码
- 一个README.md 文件
- 一个 init.py
- license.txt
- setup.cfg
- setup.py文件
具体如下图,首先从最外层应该含有:
image.png
其中setup.py,是安装package的主要信息文件,详情请看如何编写setup.py文件
-
其中的package_name文件夹下又包含如下:
image.png
- init文件是package的初始化文件,可以为空
- license.txt是package的license声明信息
- python_code是主程序,当然如果文件数过多也可以放在一个文件夹中
- README.md是package的使用说明,和安装说明
- setup.cfg是package的配置文件,详情请看如何编写配置文件
上传package
将package文件准备好后,为了以后可以通过pip install <package_name>
安装package,需要进行如下三步:
- step 1: 在
pypi
上注册账号 -
step 2: 切换到如下图的目录下
image.png - step 3: 运行如下命令
python setup.py sdist
pip install twine
twine upload dist/*
最后,上传成功后,可以尝试安装该package,以检测是否安装成功
pip install <package_name>