如何为CLI类Python应用编写可pip安装的命令行工具包

实现该效果的核心逻辑是通过包构建工具在安装阶段自动将你指定的代码入口注册到当前Python环境的可执行路径中，只要用户的Python环境已加入系统PATH（绝大多数场景下都是默认配置），安装完即可直接调用命令，无需额外操作，和pip、Rasa的使用体验完全一致。

前置准备 #

首先在你的包中编写命令行入口函数，示例如下：

# 假设你的包名为my_python_package，新建cli.py作为命令行逻辑入口
# my_python_package/cli.py
def main():
    # 这里可自行集成argparse、Click、Typer等工具处理命令参数
    import sys
    args = sys.argv[1:]
    if args and args[0] == "run":
        print("命令执行成功")
    else:
        print("可用命令：run")

配置方案 #

方案1：使用setup.py配置（传统setuptools模式） #

在你的setup.py的setup()参数中新增entry_points配置项即可：

from setuptools import setup, find_packages

setup(
    name="your_package_name",
    version="0.1.0",
    packages=find_packages(),
    # 核心配置
    entry_points={
        "console_scripts": [
            # 格式为：[自定义命令名] = [包路径.模块名]:[入口函数名]
            "your_command = my_python_package.cli:main"
        ]
    }
)

方案2：使用pyproject.toml配置（符合PEP 621标准，推荐） #

如果是使用现代包管理规范，直接在pyproject.toml中添加对应配置即可：

• 原生setuptools配置：

[project.scripts]
your_command = "my_python_package.cli:main"

• Poetry工具配置：

[tool.poetry.scripts]
your_command = "my_python_package.cli:main"

本地验证方法 #

在你的项目根目录执行pip install -e .安装可编辑模式的包，安装完成后直接在终端执行your_command run即可验证效果，无需打包上传到PyPI测试。

小提示：如果你的命令行逻辑较为复杂，推荐使用Click或Typer类的第三方库开发，可快速实现子命令、参数校验、自动帮助文档等能力，效率更高

内容的提问来源于stack exchange，提问作者Saikat Bhattacharya