如何设置 python CLI 应用程序，以便在不直接引用解释器的情况下使用它？

Question

我想构建一个应用程序，假设它名为 helloworld，带有 python 命令行界面。我的应用程序作为多个嵌套模块和一个顶级模块 main.py。

假设布局是：

helloworld/
   helloworld/
      __init__.py
      module1/
      module2/
      module3/
   setup.py
   main.py

此时，一旦安装了我的项目，我就可以使用运行它 <代码>#> python path/to/helloworld/main.py arg1 arg2 arg3

我希望能够使用以下命令与程序进行交互： <代码>#> helloworld arg1 arg2 arg3，以类似的方式，Flask 框架附带了一个命令行应用程序，我可以与 #> 一起使用烧瓶运行。

我环顾四周，发现了一些建议使用 shebang 的问题。据我所知，这不是我想要的。

我想要一个独立的应用程序，我可以使用 pip 安装，然后直接启动，而不需要任何 python 解释器的引用。

我该怎么办？

编辑

对我来说，一个重要的要求是可以使用 pip 安装该软件包并且命令行界面立即可用。 Shebangs/手动修改路径/创建额外的 shell 脚本并不能解决我的问题。

Answer 1

您应该将 main.py 添加到您的 PATH 中。当您运行 Flask run 时，您的终端会在 PATH 中查找命令 Flask 并运行它指向的程序。您可以将其视为 Flask 程序的一种快捷方式。

通过将程序添加到 PATH，您可以告诉计算机，如果您在终端中输入 helloworld，终端应该运行 /my/path/to/helloworld.py 。

我不知道您使用的是什么操作系统，因此这里是有关如何添加 PATH 变量的最常见操作系统的链接。

Windows

Linux

Mac OSX< /a>

编辑：在您给出更多解释后，setuptools 就是您要寻找的。请查看此参考以了解如何使用它。

Answer 2

有一个解释这里 如何告诉 setuptools 在 pip 安装期间将脚本添加到 Python Scripts 文件夹中。然后，您可以将该脚本设置为调用 Python 脚本的 bat 文件。通过这种方式，您无需编写 .py 即可运行脚本，并且它会自动发生。

Answer 3

我知道这个问题已经得到了回答，但以防万一将来有人遇到这个问题。

以下是我在从许多不同来源阅读此内容后正在开发的新包的工作原理。

太棒了；使用 setuptools 并将命令添加为 setup.cfg 中 [options.entry_points] 下的 console_scripts 选项。

您还需要 setup.cfg 或 setup.py 中的一些其他字段才能进行包发现。请查看 setuptools 文档。

示例入口点：

[options.entry_points]
console_scripts =
    mycmd = mypackage.mymodule:myfunc

对于本地开发，您可以使用 pip install -e 以可编辑（开发）模式安装软件包。 这将允许您像 pip intall 一样测试命令。代码>编辑它。

或者，您可以创建一个 __main__.py，当您从根运行 python -m mypackage 时，它会初始化您的模块。

from mypackage import app


if __name__ == '__main__':
    app.main()

我个人选择了两者。通常，您的 main.py （或我的示例中的 app.py）属于您的包而不是项目级别目录。然后您也可以在那里创建__main__.py。