使用 click 框架编写命令行工具

clikc 中文文档
clikc 英文文档

项目目录

简单小功能，计算 a + b 的值；做成命令行工具，直接通过命令行调用

├── main.py
├── requirements.txt
└── setup.py

具体代码

requirements.txt

click==8.1.3
colorama==0.4.4
numpy==1.24.2

注意: 文件名称是 requirements,规范的命名，在使用vscore 编写代码时，可自动创建相应的虚拟环境

main.py

import click
import numpy as np


@click.command()
@click.option('--a', default=1, type=int, help='number a')
@click.option('--b', default=0, type=int, prompt='number_b', help='number b')
def add(a, b):
    """两个数相加，求结果"""
    list = np.array([a, b])
    rum = np.sum(list)

    # 使用彩色输出结果
    click.secho(f"a is :{a},b is {b},sum is {rum}", fg='green')


if __name__ == '__main__':
    add()

setup.py

from setuptools import setup

setup(
    name='sum-a-b',
    version='1.0',
    author="rush_peng",
    description="求两个数的和",
    py_modules=['yourscript'],
    install_requires=['click', 'colorama', 'numpy'],
    entry_points={
        "console_scripts": [
            "sum-ab=main:add",
        ]
    },
)

如何使用

1.直接启动项目启动

python3 main.py --a 12 --b 14

2.使用脚本启动
先在本地安装

pip install -e .

运行脚本

sum-ab --a 23 --b 16

结果展示