Release Python Package to PyPI

平常用pip安装各种python包或应用程序,近期也把自己开发的一个工具发布到了PyPI(Python Package Index)上了。

准备工作

.pypirc文件

在用户目录下创建一个.pypirc文件(路径为~/.pypirc),其内容如下:

1
2
3
4
5
6
7
8
[distutils]
index-servers =
pypi

[pypi]
repository: https://upload.pypi.org/legacy/
username: your user name
password: your password

项目的setup文件

在项目里创建一个setup.py文件,然后通过这个文件来上传,文件内容如下:

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

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

setuptools.setup(
name="ndip_checker",
version="1.0.0",
author="Yarving Liu",
author_email="yarving@gmail.com",
description="check and fix errors in NDIP",
long_description=long_description,
long_description_content_type="text/markdown",
url="https://gitee.com/yarving/NdipChecker",
packages=setuptools.find_packages(),
entry_points={'console_scripts': [
'ncheck=ndip_checker:execute_from_command_line',
]},
install_requires=['MySQL-python'],
classifiers=[
"Programming Language :: Python :: 2.7",
"License :: OSI Approved :: MIT License",
"Operating System :: OS Independent",
],
)

其中entry_points定义了一个ncheck命令,可以通过这条命令执行。

上传至PyPI

  • 生成文件: python setup.py sdist bdist_wheel
  • 上传: twine upload dist/*
0%