在学习和编写Python代码的过程中我们经常会用到pip
来安装一些其他包,用pip
下载很方便的,那么如果我们自己写了Python的代码包,如何能让别人也试用pip
来进行安装呢?真巧,我这几天就打包了一个自己写的程序发布到了pypi.org
,写个上传记录供大家参考。
安装依赖包
whell
用来打包,twine
用来上传包到pypi.org
pip install whell
pip install twine
如果无法下载,请尝试更换下载源,也可能会遇到pip版本太低需要升级的情况,升级后在试试安装。
pip install wheel
改为:
pip install wheel -i http://pypi.douban.com/simple/ --trusted-host pypi.douban.com
打包项目配置
需要打包的项目结构图如下:
PrimarySchoolMath
目录就是我们要打包的项目目录(这个名称和setup.py里的项目名称要一致,也是pip install XXXX 的名字是一样的)。
LICENSE
是软件的开源协议,如果不知道怎么选可以到https://choosealicense.com 这里选择一下。
readme.md
是软件或包的说明,可以写一些仓库地址简要说明。
setup.py
打包的配以文件,后边详细说明。
setup.py打包配置文件说明
setup.py
:
import setuptools
with open("README.md", "r") as fh:
long_description = fh.read()
setuptools.setup(
name="PrimarySchoolMath",# 项目名称,保证它的唯一性,不要跟已存在的包名冲突即可
version="1.0.4",#程序版本
author="J.sky", # 项目作者
author_email="bosichong@qq.com",#作者邮件
description="小学生口算题的小应用", # 项目的一句话描述
long_description=long_description,#加长版描述?
long_description_content_type="text/markdown",#描述使用Markdown
url="https://github.com/bosichong/PrimarySchoolMathematics",# 项目地址
packages=setuptools.find_packages(),#无需修改
classifiers=[
"Programming Language :: Python :: 3",#使用Python3
"License :: OSI Approved :: Apache Software License",#开源协议
"Operating System :: OS Independent",
],
)
至此,所有打包的准备工作都已经准备好了,接下来就是利用命令来打包上传了。
打包
项目目录下打开终端:
python3 setup.py sdist bdist_wheel
打包完毕,此时的项目目录如下:
dist
下就是要上传的打包文件了。
上传到pypi.org
这里的上传可以使用测试上传或是直接上传。
测试上传会将包传到https://test.pypi.org/
,所以你需要在这个地址下注册一个测试账号,然后使用一下命令进行上传,这里不再介绍了。
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*
直接上传到pypi.org
,使用命令:
python3 -m twine upload dist/*
然后输入在pypi.org
注册的账号密码就可以上传了。
python3 -m twine upload dist/*
Uploading distributions to https://upload.pypi.org/legacy/
Enter your username: bosichong
Enter your password:
如果没有什么错误就可以上传成功了!登录网站就可以看到刚刚上传的软件包了
然后使用pip install XXXX
安装测试吧。
其他注意事项
如果需要更新软件包,修改完代码后记得修改setup.py
中的软件版本,这样才能正常上传。
至此,一次Python软件包的上传就搞定了,简单吧?