Python3 如何开发带命令行的软件包

PyPi（Python Package Index）是一个用于存储 Python 写成的软件包的软件存储库，我们平时用pip安装的库就是来自于 PyPi。

我们先来写一个最简单的包，整体代码结构如下：

.
├── README.md
├── demo
│   └── __init__.py
└── setup.py

代码结构中有一个 demo 目录、README.md 文件和 setup.py 文件，demo 目录下只有一个 __init__.py 文件。

__init__.py

 print('Hello World！')

setup.py

#!/usr/bin/env python3
# -*- coding: UTF-8 -*-

from os import path
from setuptools import setup, find_packages

# read the contents of your README file
this_directory = path.abspath(path.dirname(__file__))
with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
    long_description = f.read()

setup(
    name='requestsLib',
    version='1.0.0',
    author='GeekDot',
    author_email='***@***.com',
    description='demo',
    long_description=long_description,
    long_description_content_type='text/markdown',
    classifiers=[
        "Programming Language :: Python :: 3",
        "License :: OSI Approved :: MIT License",
        "Operating System :: OS Independent",
    ],
    packages=find_packages(),
    python_requires='>=3.7',
    install_requires=[],
    scripts=[],
    project_urls={}
)

打包的功能由 setuptools.setup 函数实现，我们只需要修改对应的参数即可。

主要的参数说明，详细信息参考文档：

• name: 库名，也就是 pip install xxx 时的名称。

• version: 版本，我们这里是复用了库代码里的版本号。

• author: 作者，同上。

• author_email: 作者邮箱。

• description: 库说明，在pip search xxx的时候可以看到。

• long_description: 库详细说明，显示在PyPI完整上，我们这里从README.md文件中读取具体内容。

• long_description: 库详细说明的格式，这里使用markdown。

• classifiers: 库的类别信息，所有可选值参考。

• packages: 库包含的python包，通过find_packages自动添加。

• py_modules: 库包含的顶级Python模块，我们这里没有。

• python_requires: 支持的Python版本。

• install_requires: 依赖的其他库，格式与pip freeze输出的格式相同。

• project_urls: 项目的一些链接信息，可选值列表。

• scripts: 项目命令行工具

如果想为项目添加命令行工具，需要在项目中新增一个目录，例如：bin 目录，然后写我们的工具脚本。

工具脚本可以使用 bash、Python 或者其他语言，如果用 Python 写，有一个非常好用的模块叫做 argparse 。

import argparse

APP_DESC="""
描述
"""
print(APP_DESC)
parser = argparse.ArgumentParser()
parser.add_argument('-v','--verbose', default=0,help="版本")
parser.add_argument('-s','--store',help="保存")
parser.add_argument('-c','--config',default=0,help="配置")
args = parser.parse_args()

然后，在 setup.py 中添加 scripts 项即可。

最后，对进行项目进行打包：

python setup.py sdist bdist_wheel

参考文章：

http://ponder.work/2020/09/10/develop-python-library-and-upload-it-to-pypi-guide/
https://zhuanlan.zhihu.com/p/56922793