setup.py 并将文件添加到 /bin/

Question

我不知道如何让setup.py 向用户的/bin 或/usr/bin 或其他任何内容添加脚本。

例如，我想将myscript.py 添加到/usr/bin，以便用户可以从任何目录调用myscript.py。

Answer 1

Python 文档在 installing scripts 部分对其进行了解释。

脚本是包含 Python 源代码的文件，旨在从命令行启动。

setup(...,
      scripts=['scripts/xmlproc_parse', 'scripts/xmlproc_val']
)

如here所说，除了脚本，还有entry_points机制，更跨平台。

使用entry_points，您可以将命令行工具名称与您选择的函数连接起来，而scripts 可以指向任何文件（例如，shell 脚本）。

Answer 2

如果你愿意构建和安装整个 python 包，我会这样做：

• 编辑 setup.py 中的 setup() 函数以包含一个名为 scripts 的参数，并将其参数设置为您希望从任何地方运行的文件的位置。例如

setup(name='myproject',author='',author_email='',scripts=['bin/myscript.py'])

• 在包含 setup.py 的目录中，通过键入 mkdir bin 创建一个 bin 目录
• 将 myscript.py 添加到这个新创建的 bin 目录（并确保它是可执行的！）
• cd 再次进入包含 setup.py 的目录，并通过键入 python setup.py install 安装整个 python 包
• 安装软件包后，您应该可以从系统上的任何位置运行 myscript.py！

Answer 3

考虑使用console_scripts：

from setuptools import setup
setup(name='some-name',
      ...
      entry_points = {
              'console_scripts': [
                  'command-name = package.module:main_func_name',                  
              ],              
          },
)

main_func_name 是主模块中的主要功能。 command-name 是一个名称，它将被保存在 /usr/local/bin/ 中（通常）

Answer 4

有两种方法可以从 setuptools 和 PyPI 基础架构中获得一个工作命令行工具：

1. The "scripts" Keyword Argument
   这允许命令行执行您想要的一切，它可以是 Python 脚本、shell 脚本或完全不同的东西。
2. The "console_scripts" Entry Point
   这允许将 Python 函数（不是脚本！）直接注册为命令行可访问的工具。