通过 pip 安装自己的代码包
以前通过 pip 安装的时候总是很羡慕,别人的代码使用起来好方便啊,那时候觉得代码要提交到 pip 平台去管理肯定需要审核吧? 后来了解到自己的代码要可以 pip 安装不需要审核,只需要遵循几个步骤就能轻松实现:
- 准备代码包
- 通过 setuptools 打包
- 通过 twine 上传 (需要 pypi 账号密码)
重点操作:
- setup.py 的编写
- python setup.py sdist 打包
- twine upload dist/* 上传
准备代码包
首先准备好代码目录,一般需要包含以下几部分:
- 代码包
- setup.py
- README.md
- LICENSE
整体的目录结构类似于这样:
setup.py 主要是打包时候需要运行的程序,可以在 官方文档 查看具体用法。
里面的内容是这样的:
long_description 表示上传的包的使用说明,上传完成以后会在 pypi 网站上显示出来。
通过 setuptools 打包
准备好文件之后,就可以通过 setuptools 打包了。先进入项目目录下,能找到 setup.py 这个文件, 执行:
python3 setup.py build sdist
如果需要校验自己的包是否正确,在build文件夹下查看即可,若需要重新打包,则将图片中红框部分删掉,重新执行打包命令
通过 twine 上传
步骤1:先在 pypi网站 注册账号。
直接点这个链接注册:https://pypi.org/account/register/。
注册好之后,生成一个 token:https://pypi.org/manage/account/#api-tokens。由于我们是要上传新项目,所以不要限制 scope 到特定的项目。
⚠️注意:token 生成出来以后不要马上关掉页面,不然就没了!!!把 token 复制粘贴保存到个本地的文件里(你要手抄我不反对,一百多位,别抄错就行)。
然后,创建一个纯文本文件 $HOME/.pypirc
,在里面写:
[pypi]
username = __token__
password = pypi-CDFMLR66666kLTI1NjQzZGUJXsgElwaS576OnvGVIshizhegedeshisabiJz
步骤2:通过 pip install twine,安装好 twine 包。 twine 是把代码上传到 pypi 的工具。
步骤3:进入项目目录,twine upload dist/* 上传 dist 文件
如果报错,择执行这条命令:python3 -m twine upload dist/*
成功之后,可以在 pypi 搜索到你的包了: