【Python程序开发系列】教你将python项目(程序)打包发布到Pypi
这是我的第324篇原创文章。
一、引言
当逐渐在用python开发项目或者日常使用时,一般需要大量使用别人提供的包,这些包能高效的帮助我们快速高效的完成指定任务或者需求,不过有时也会想,自己如果能够把自己的代码打包并上传到PyPi,后续其他人也可以通过pip进行安装,在为Python做出贡献的同时,对自己也是一件很牛的事情,本文章便详细介绍如何将自己的代码打包并上传到PyPi。
二、实现过程
2.1 组织项目的目录结构
设计项目目录结构:
<my_project>/ # 项目根目录
|-- <qwq_package> # 包package的根目录
| |-- __init__.py
| |-- mymodule.py # 代码模块
|-- README.md
|-- LICENSE
|-- setup.cfg
|-- setup.py
包名qwq_package,核心代码模块mymodule实现一个求两数之和:
2.2 编写配置说明文件
README.md:是关于项目的描述文件,一般包含怎样安装项目,怎样使用项目等。
LICENSE:是开源License,如MIT,Apache license 2.0等。
setup.cfg:是一个配置信息文件,运行setup.py程序打包的时候会用到里面的配置,作为setup.py的命令行参数。
setup.py:用来描述我们的项目,之后打包的时候会用到这个文件。它告诉PyPI我们的项目叫什么名字,是什么版本,依赖哪些库,支持哪些操作系统,可以在哪些版本的Python上运行,等等。
2.3 打包项目
安装打包工具:
pip3 install setuptools
pip3 install wheel
进行打包:
python3 setup.py sdist bdist_wheel
上面的命令会在dist/目录下生成一个tar.gz的源码包和一个.whl的Wheel包:
此时,其实可以直接将该文件转发给朋友,朋友保存到本地,就可通过pip进行安装,不过这样还没达到我们的目的。
2.4 创建PyPI账户
首先注册一个test环境的PyPi账号,可通过链接 https://test.pypi.org/account/register/ 进行注册。
注册成功后,我们需要生成token用于上传pypi,注册成功登录后,需要从用户名点击,选择【Account Settings】找到【API tokens】,点击后,输入Token名称,和选择Token范围。
2.5 上传项目(软件包)
安装上传工具:
pip3 install twine
将dist/目录下生成一个tar.gz的源码包和一个.whl的Wheel包进行上传:
twine upload dist/* 或 twine upload --username __token__ --password your-api-token dist/*
当运行以上命令后,一般会出现Enter your username和Enter your password提示,其中username输入__token__,password输入token值(使用正式环境的token值),然后按Enter即可。上传完成之后,可以在https://pypi.org/project/里面搜索qwq-packages:
2.6 从PyPi中用pip命令安装
安装:
pip install qwq_package
使用:
from qwq_package import mymodule
print(mymodule.add(1, 2))
结果:
后续,如果需要对自己的包发布新版本,照以上步骤完成即可,别忘了修改setup.py文件内的版本号信息。
作者简介: 读研期间发表6篇SCI数据算法相关论文,目前在某研究院从事数据算法相关研究工作,结合自身科研实践经历持续分享关于Python、数据分析、特征工程、机器学习、深度学习、人工智能系列基础知识与案例。关注gzh:数据杂坛,获取数据和源码学习更多内容。
原文链接: