前言

用过python的人肯定对pip安装不陌生,pip安装的包的来源都是在Pypi上。为了能随时能使用自己的包,所以尝试一下将自己的包发布到Pypi上。

步骤

一、准备项目

一、创建目录结构
Pypi项目包发布_包名

二、准备文件

  • 1、README.rst
    关于项目的描述文件,一般包含怎样安装项目,怎样使用项目等。
  • 2、LICENSE.txt
    创建许可证,上传到Python Package Index的每个包都包含许可证,开源License,如MIT,Apache license 2.0等。可参考 https://choosealicense.com/
  • 3、setup.py
    是setuptools的构建脚本,包括定义包名、版本、包含哪些代码模块、依赖哪些库、在哪些Python版本上运行等
    参考链接:https://packaging.python.org/tutorials/packaging-projects/
  • 4、项目文件
    根据自己的需求,编写核心代码,包名要和setup.py配置保持一致!
    Pypi项目包发布_上传_02
    Pypi项目包发布_上传_03
  • 5、在上传之前,可以先通过命令校验 setup 写错了没有:
$ python setup.py check
running check

如果没有输出任何错误,则说明格式正确。

三、打包

打tar.gz格式的包:

python setup.py sdistbuild

Pypi项目包发布_包名_04

四、注册上传

链接:https://pypi.org/account/register/
Pypi项目包发布_python_05
安装上传包环境

Pip install twine

Pypi项目包发布_python_06
发布包到PyPi,输入创建的用户名和密码

twine upload dist/*

Pypi项目包发布_python_07

五、检查

Pypi项目包发布_迭代_08
安装使用

pip install ***(包名)

Pypi项目包发布_上传_09
卸载

pip uninstall ***(包名)

六、迭代更新

每次更新都需要修改不同的版本号才能发布
然后重复上面的命令

python setup.py sdist
twine upload dist/*

Pypi项目包发布_创建目录_10
检查
Pypi项目包发布_上传_11