当我们通过pip install XXX来安装某个包的时候，总是感觉这个包特别的高达上，特别的正式。其实，将你自己的包上传到Pypi并没有那么困难。本篇教程就是简单几步教你将你的包上传到Pypi。

准备结构

首先你需要一个文件夹，这里起名叫package_example。在这个文件夹里建立一个setup.py，一个LICENSE，一个README.md，和一个文件夹。前面的三个文件都是文本文件，我们待会会逐一讲解。后面的文件夹我起名叫my_pkg，你可以按照你的喜好为它起名。在这个文件夹里，再新建一个__init__.py，也是一个空的文本文件。你的结构完成后应该如下所示。

1
2
3
4
5
6
7
.
└── package_example
    ├── LICENSE
    ├── my_pkg
    │   └── __init__.py
    ├── README.md
    └── setup.py

而你自己写好的XXX.py文件，应该放在my_pkg文件夹里。

我将分文件介绍它们的作用。

init.py

当我们执行import XXX的时候，我们实际上就是调用了这个包的__init__.py函数。所以我们的__init__.py就是一个类似于头文件的东西。假如你在my_pkg上放了一个XXX.py文件，你想要导入包的时候就导入这个文件里的内容，那么你可以在__init__.py里这么写。

1
from .XXX import *

注意你自己写的PY文件前要加一个点。

LICENSE

即开源协议，我们通常用MIT的协议，最宽泛。在里面输入

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
Copyright (c) 2019 The Python Packaging Authority

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

README.md

就是普通的readme，介绍你这个包是干啥的。

setup.py

要写下打包的参数，稍微复杂一些。在里面写下

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
import setuptools

with open("README.md", "r") as fh:
    long_description = fh.read()

setuptools.setup(
    name="example-pkg-YOUR-USERNAME-HERE", # Replace with your own username
    version="0.0.1",
    author="Example Author",
    author_email="author@example.com",
    description="A small example package",
    long_description=long_description,
    long_description_content_type="text/markdown",
    url="https://github.com/pypa/sampleproject",
    packages=setuptools.find_packages(),
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    python_requires='>=3.6',
)

注意

  • name是包的分发名称。只要包含字母，数字_和，就可以是任何名称-。它也不能在pypi.org上使用。请务必使用您的用户名更新此内容，因为这可确保您在上传程序包时不会遇到任何名称冲突。
  • version 每次更新应调整
  • author和author_email是标记作者的。
  • url 是项目的主页
  • 别的看情况改，通常不需要动了。

开始打包

东西准备好了，可以打包了。

首先安装一下两个包，严格来说第二个是用于上传的步骤的。

1
2
python3 -m pip install --user --upgrade setuptools wheel
python3 -m pip install --user --upgrade twine

然后在package_example的目录下执行

1
python3 setup.py sdist bdist_wheel

这样就生成了打包好的文件。

开始上传

首先需要Pypi的帐号。如果只是玩一玩的话，可以用test.pypi的账户，即测试账户。然后使用如下指令上传。

1
python3 -m twine upload dist/*

如果只是玩一玩的话，上传到test的网站上。

1
python3 -m twine upload --repository-url https://test.pypi.org/legacy/ dist/*

会提示输入用户名和密码。

更新

以后每次更新的时候，要更新 setup.py 里的版本号。然后执行

1
2
3
rm -r build dist
python3 setup.py sdist bdist_wheel
python3 -m twine upload dist/*

即可。

使用你的包

就像其他流行的包一样。你只需要pip install XXX就可以安装了！然后通过import XXX导入包。

是不是很酷？