来源:Python 技术「ID: pythonall」 写 Python 程序的童鞋们都知道安装模块使用 pip install xxxx 命令,那么知道怎样将自己的代码发布到 PyPI 让全世界 Python 程序员使用吗?下面让我们开始一起学一下将代码上传到 PyPI 吧... PyPI 概念PyPI 全称 Python Package Index ,是一个 Python 的模块管理工具。提供对 Python 模块的查找、下载、安装、卸载等操作。 项目结构首先让我们来看看上传 PyPI 需要的项目结构,然后再慢慢填代码。 各个文件的详细介绍如下: - example:模块名,代码写法: from example import math
- __init__.py:这里可以写代码,也可以是空文件
- setup.py:setuptools 的构建脚本
- README.md:关于项目的描述,描述如何安装、使用等情况
- LICENSE:开源的 LICENSE,如:Apache License 2.0,MIT License 等等,在(https:///)选择,这里选择 MIT License
编写代码编写 math.pymath.py 里面只写了简单的加减乘除代码 def add(i, y): print(str(i) + " + " + str(y) + " = " + str((i + y)))
def sub(i, y): print(str(i) + " - " + str(y) + " = " + str((i - y)))
def mul(i, y): print(str(i) + " * " + str(y) + " = " + str((i * y)))
def div(i, y): print(str(i) + " / " + str(y) + " = " + str((i / y)))
编写 setup.pysetup.py 是一个 setuptools 的构建脚本,其中包含了项目和代码文件的信息 import setuptools
setuptools.setup( name="simple_pip_upload", version="0.0.2", author="moumoubaimifan", author_email="example@example.com", description="一个简单的四则运算 PyPI 上传例子", long_description="一个简单的 PyPI 上传测试", long_description_content_type="text/markdown", url="https://github.com/JustDoPython/justdopython.github.io", packages=setuptools.find_packages(), classifiers=[ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ], )
setuptools.setup 的参数信息如下: - author,author_email:作者和作者邮件
- long_description_content_type:表示用哪种方式显示long_description,一般是 md 方式
- packages:项目中包含的子包,find_packages() 是自动发现根目录中的所有的子包。
- classifiers:其他信息,这里写了使用 Python3,MIT License许可证,不依赖操作系统。
编译在上传代码之前,我们需要将代码编译,编译代码需要使用 setuptools 和 wheel 模块,安装它们 pip3 install --user --upgrade setuptools wheel
安装完成后使用如下命令编译 python3 setup.py sdist bdist_wheel
编译之后会在项目中会生成多个文件夹,其中一个 dist 文件夹中包含 simple_pip_upload-0.0.2.tar.gz 源码包 和 simple_pip_upload-0.0.2-py3-none-any.whl 文件 dist\ simple_pip_upload-0.0.2.tar.gz simple_pip_upload-0.0.2-py3-none-any.whl
上传到这里就只剩下上传代码了,我们需要注册(https:///account/register/)账号和创建一个 token(https:///manage/account/token/),并保存到 $HOME/.pypirc 文件里面。 PyPI 上传使用的是 Twine 模块,安装它 python3 -m pip install --user --upgrade twine
安装完成之后,使用如下命令上传 dist 文件夹里面的文件 python3 -m twine upload --repository pypi dist/*
最后让我们在网站(https:///)上查询 simple-pip-upload 项目是否被上传上去 使用模块使用 pip 命令安装 simple-pip-upload 项目 pip3 install simple-pip-upload
在 Python 终端中使用 simple-pip-upload 项目 >>> from example import math >>> math.add(1,2) 1 + 2 = 3 >>> math.sub(5,2) 5 - 2 = 3 >>>
总结将一个项目发布到 PyPI 很简单,就是步骤繁琐了一些。大家学会了吗? 参考https://packaging./tutorials/packaging-projects/
|