如何快速制作开源pip模块

前言

本教程带你制作属于自己的开源模块并上传至PyPI官网，让别人可以通过pip命令来进行安装，例如：

pip install 模块名称

对于模块开发者本质上需要做3件事：

1、编写模块方法

2、将模块进行打包

3、上传至PyPI（需要提前注册PyPI账号）

对于模块使用者来说，只需要做2件事：

1、通过pip install 模块去安装模块

2、使用模块

假设，我们现在要做一个名称为faker的模块，跟着下面的步骤一步一步的操作

第一步 创建工程

faker
|—— LICENSE  # 模块声明，告知使用者是否可以免费用于商业用途
|—— README.md  # 模块介绍
|—— faker  # 模块代码
   └─ __init__.py
| —— setup.py  # 给setuptools提供信息的脚本

第二步 编写代码

1、在faker目录下，新建一个py文件，用于编写核心代码

 

2、在setuptools.py下编写提供信息的内容

第三步 打包工程

1、安装wheel工具

pip install wheel

2、进入项目根目录输入打包命令

python setup.py sdist bdist_wheel

第四步 上传工程

1、注册PyPI账号

2、安装上传工具，用于发布模块至PyPI

pip install twine

3、发布上传

python -m upload --repository-url https://upload.pypi.org/legacy/ dist/*

在上传过程中，会让你输入用户名和密码，即你注册的PyPI的用户名和密码，至此，工程上传成功

第四步 如何使用

1、使用很简单，跟正常安装python模块一致，通过pip进行安装，安装成功后即可导入模块使用

pip install faker