如何打包Python项目使其可在控制台命令行直接运行调用

按照以下步骤配置即可实现你需要的命令行调用效果，同时也不会影响包的导入能力：

1. 调整为标准项目结构 #

先把你的项目整理为如下结构，方便后续打包配置：

项目根目录/
├── my_program/          # 你的核心功能包文件夹
│   ├── __init__.py
│   ├── core.py          # 你的其他功能模块
│   ├── utils.py         # 你的其他依赖模块
│   └── cli.py           # 新增：命令行入口逻辑文件
│   └── 你需要读取的静态资源文件夹/  # 存放你要读取的固定文件夹内容
├── pyproject.toml       # 现代Python打包配置文件
└── README.md

2. 编写命令行入口逻辑 #

在cli.py中实现参数解析和功能调用逻辑，可直接用Python自带的argparse库，示例代码如下：

import argparse
from .core import 你的核心执行函数

def main():
    # 定义命令行参数
    parser = argparse.ArgumentParser(description="你的程序功能描述")
    parser.add_argument("-i", "--input", required=True, help="输入参数说明")
    parser.add_argument("-o", "--output", required=True, help="输出参数说明")
    args = parser.parse_args()
    # 调用你的核心业务逻辑
    你的核心执行函数(args.input, args.output)

if __name__ == "__main__":
    main()

3. 配置打包文件声明命令行入口 #

编辑pyproject.toml文件，配置打包规则和命令行映射关系：

[build-system]
requires = ["setuptools>=61.0"]
build-backend = "setuptools.build_meta"

[project]
name = "my_program"
version = "0.1.0"
authors = [
  { name="你的名称", email="你的联系方式" }
]
description = "你的程序功能描述"
requires-python = ">=3.8"

# 核心配置：命令行入口映射
[project.scripts]
my_program = "my_program.cli:main"

# 配置需要打包你的静态资源文件夹，避免打包时丢失你要读取的文件
[tool.setuptools.package-data]
my_program = ["静态资源文件夹/*"] # 按照你实际的文件夹名称修改路径修改

上述[project.scripts]配置的含义是：用户安装包后，在终端输入my_program命令时，会自动调用你写在cli.py里的main函数。

4. 本地测试与打包分发 #

• 本地测试：在项目根目录执行pip install -e .，即可在当前Python环境全局注册my_program命令，直接在终端输入my_program -i arg1 -o arg2即可验证功能是否正常
• 打包分发：先执行pip install build安装打包工具，再执行python -m build，会在项目根目录的dist文件夹下生成.whl和.tar.gz格式的安装包，用户拿到安装包后执行pip install 安装包名称.whl即可直接通过命令行调用你的程序。

如果你还需要支持python -m my_program的调用形式，只需要在my_program包下新增__main__.py文件，内容如下即可：

from .cli import main
if __name__ == "__main__":
    main()

内容的提问来源于stack exchange，提问作者GIOVANNI QUINONES VALDEZ