如何发布使用Pyinquirer开发的Python CLI工具 支持用户直接命令调用
Python CLI工具公开发布及全局命令配置方案
你可以按照以下步骤实现需求:
1. 调整项目结构并配置命令映射入口
首先将你的项目调整为符合Python打包规范的结构,参考示例:
your_project_root/ ├── your_cli_core/ # 存放业务代码的目录 │ ├── __init__.py │ └── entry.py # CLI启动入口文件,内部实现启动函数比如main() ├── pyproject.toml # 官方标准打包配置文件 └── README.md # 工具说明文档
在pyproject.toml中配置全局命令和入口函数的映射关系,以setuptools打包为例,参考配置:
[project] name = "your-package-name" # 发布到PyPI的包名,不能和已有包重名 version = "0.1.0" authors = [ { name="你的名称", email="你的联系方式" } ] description = "CLI工具的功能描述" requires-python = ">=3.8" # 按需设置支持的最低Python版本 dependencies = [ "PyInquirer>=1.0.3", # 把你的工具所有依赖都列在此处 ] [project.scripts] COMMAND_NAME = "your_cli_core.entry:main" # 前面的COMMAND_NAME替换为你想要的用户调用命令名,后面指向你的入口函数
2. 本地验证功能
在项目根目录执行可编辑安装命令测试效果:
pip install -e .
安装完成后直接在终端执行COMMAND_NAME run,确认工具可以正常启动运行。
3. 打包项目
安装官方打包工具:
pip install build
在项目根目录执行打包命令:
python -m build
打包完成后会在dist目录下生成.tar.gz源码包和.whl安装包。
4. 公开发布
你可以选择两种发布方式:
- 公开给所有用户使用:注册PyPI账号后,安装twine工具执行
twine upload dist/*,按照提示输入账号信息即可上传到PyPI,所有用户都可以通过pip install your-package-name安装你的工具 - 小范围分发:直接把
dist目录下的.whl文件发给用户,用户执行pip install 包文件路径.whl即可完成安装
安装完成后用户无需额外配置,直接执行COMMAND_NAME run就能调用你的工具。如果用户终端提示找不到命令,可建议用户使用pipx安装CLI工具,pipx会自动处理环境变量路径问题,更适合CLI工具的安装场景。
内容的提问来源于stack exchange,提问作者Dhanush Eashwar
相关产品推荐
相关产品推荐

