如何在 `setup.py` 中设置 bin 脚本入口点？

Question

我正在尝试创建一个可以使用pip 安装的包（在 Mac 上）。这个包在存储库中包含一个名为mycode.py 的主要可执行文件，我可以按如下方式在本地运行它：

python mycode.py --help

例如。

鉴于一些关于如何为可执行文件创建入口点的文档，我在setup.py 的setup 函数中添加了以下内容：

setup(
    name="mycode",
    author="bbp-ou-nse",
    author_email="me@email.ch",
    version="0.0.1",
    description="Some tool",
    long_description="later",
    long_description_content_type="text/x-rst",
    url="later",
    entry_points='''
        [console_scripts]
        mycode=mycode.py:main
    ''',
    install_requires=[],
    packages=find_packages(),
    python_requires=">=3.6",
)

并安装它

pip install .

安装似乎成功了，但是当我现在在命令行上运行以下命令时

mycode.py --hekp

我得到了ImageMagick 的帮助！不是开玩笑！输出以

开头

Version: ImageMagick 7.0.10-34 Q16 x86_64 2020-10-09 https://imagemagick.org
Copyright: © 1999-2020 ImageMagick Studio LLC
License: https://imagemagick.org/script/license.php
Features: Cipher DPC HDRI Modules OpenMP(3.1) 
Delegates (built-in): bzlib freetype gslib heic jng jp2 jpeg lcms lqr ltdl lzma openexr png ps tiff webp xml zlib
Usage: import [options ...] [ file ]

Image Settings:
  -adjoin              join images into a single multi-image file
  -border              include window border in the output image
  -channel type        apply option to select image channels

我做错了什么？如何修复它以便我可以理想地运行

mycode --help

在命令行上，它执行了代码mycode.py?

Answer 1

我会为 setup.py 文件做这样的事情

然后 setup.cfg 被创建，内容如下。

[metadata]
name = mycode
version = attr: mycode.__version__
description = mycode desc
long_description = file: README.md
long_description_content_type = text/markdown
author = mycode

[flake8]
exclude = .git,.venv,.env,venv,env,__pycache__,docs/source/conf.py,build,dist

[options.entry_points]
console_scripts =
    mycode=mycode.main:main

mycode 文件夹将有一个 main.py，其中 main 函数在入口处被调用！

Answer 2

正确的语法应该是这样的

setup(
    # ...
    entry_points={'console_scripts': ['mycode=mycode.py:main']}
    # ...
)

Answer 3

我想通了，它似乎非常复杂并且没有记录！

这是我在setup.py 的setup 函数中插入的内容：

entry_points={
    'console_scripts': ['mycode=mycode:foo']},
py_modules=['mycode'],

您不仅必须使用entry_points 定义入口点（请参阅HERE），还必须定义指向您的可执行文件（？）的py_modules 参数（未记录）。