前言

由于发现python的第三方包中没有自己想要用的一款，所以打算自己手写一个，顺便放在上面（为开源做贡献

Need

python 3.7
一个能写python的IDE
一个PyPI账户
没了

过程

文件路径

一下内容以 sister_xie这个包名为例：

由于此项目是一个简单的示例项目，因此它的文件路径为：

Z:.                             
│  setup.py                     
│                               
└─sister_xie
        __init__.py

其中，文件夹下的 sister_xie名字要与后面安装文件中 name保持一致

配置安装文件

其中，setup.py为python的安装文件，在使用pip安装的时候，会使用到这个文件。文件配置以及详细说明如下：

#!/usr/bin/env python
# coding: utf-8

from setuptools import setup

with open("README.rst", "r") as f:
  long_description = f.read()
setup(
    name='sister_xie', # 软件名称
    version='0.0.1', # 软件版本号
    author='ZHYCarge', # 软件作者
    long_description = long_description, # 长描述，显示在pypi上的介绍
    author_email='ZHYCarge@126.com', # 作者的联系方式
    url='https://github.com/ZHYCarge/sister_xie', # 软件的源地址
    description=u'写给妹妹的一个小软件（确信）', # 软件说明
    packages=['sister_xie'], # 指定最终发布的包中要包含的packages
    install_requires=[], # 需要使用到的前置库
)

编写主要代码

在 sister_xie文件夹中的 __init__.py文件进行编写即可

测试

为防止代码编写过程中出现相关问题，因此可以使用 python setup.py check命令进行检查

1
2
3

(base) PS Z:\test_python> python .\setup.py check
running check
(base) PS Z:\test_python>

当出现如上内容代表检查无误

打包与发布

之后使用python setup.py sdist build命令进行打包，成功打包之后会在当前目录的dist文件夹下,创建你的包名

然后输入 pip install twine下载 twine来将你文件上传到PyPI中。

安装完成 twine后，输入twine upload dist/*来将你的打包文件进行上传，其中会要求你输入用户名和密码

最后会显示上传成功，并返回一个地址：

Uploading sister_xie-0.0.1.tar.gz
100% ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.9/3.9 kB • 00:00 • ?

View at:
https://pypi.org/project/sister-xie/0.0.1/
(base) PS Z:\test_python>

至此，项目便成功发布到PyPI上面

尾言

由于操作问题，在PyPI上面包名更改为 xyqsister，如需了解此项目可以直接点击此处

Reference

排名不分先后

ZHYCarge的博客

如何在PyPI上发布自己开发的包

前言