打包要在控制台中运行的Python项目:pyproject.Toml文件结构

Question

我为一个Python项目准备了以下结构，我希望将其打包为控制台上的入口点。

example_prog
├── src
├   └── my_module_name
├       └── app.py
├       └── blueprint.py
├       └── cli.py
├       └── config.py
├       └── db.py
├       └── search.py
├       └── wsgi.py
├       └── static
├       └── templates
├── pyproject.toml
└── README.md

cli.py程序包含一个def main()函数，其开始如下:

def main():
parser = argparse.ArgumentParser(prog="my_module_name")

我遵循了这个链接中所述的内容，并拥有以下pyproject。

[project.scripts]
futdash = "futdash:cli:main"

但是当我使用twine(在testpypi上)构建时，如下所示(这是我通常为其他包构建所做的):

python3 -m build
python3 -m twine upload --repository testpypi dist/*

但是我得到以下错误:

* Creating venv isolated environment...
* Installing packages in isolated environment... (setuptools)
* Getting build dependencies for sdist...
configuration error: `project.scripts.my_module_name` must be python-entrypoint-reference
DESCRIPTION:
Reference to a Python object. It is either in the form
``importable.module``, or ``importable.module:object.attr``.
GIVEN VALUE:
"my_module_name:cli:main"
OFFENDING RULE: 'format'
DEFINITION:
{
"type": "string",
"format": "python-entrypoint-reference",
"$comment": "https://packaging.python.org/specifications/entry-points/"
}
..
..
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/build_meta.py", line 341, in get_requires_for_build_sdist
return self._get_build_requires(config_settings, requirements=[])
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/build_meta.py", line 320, in _get_build_requires
self.run_setup()
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/build_meta.py", line 335, in run_setup
exec(code, locals())
File "<string>", line 1, in <module>
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/__init__.py", line 87, in setup
return distutils.core.setup(**attrs)
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/_distutils/core.py", line 159, in setup
dist.parse_config_files()
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/dist.py", line 867, in parse_config_files
pyprojecttoml.apply_configuration(self, filename, ignore_option_errors)
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/config/pyprojecttoml.py", line 62, in apply_configuration
config = read_configuration(filepath, True, ignore_option_errors, dist)
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/config/pyprojecttoml.py", line 126, in read_configuration
validate(subset, filepath)
File "/tmp/build-env-g403qutw/lib/python3.9/site-packages/setuptools/config/pyprojecttoml.py", line 51, in validate
raise ValueError(f"{error}n{summary}") from None
ValueError: invalid pyproject.toml config: `project.scripts.my_module_name`.
configuration error: `project.scripts.my_module_name` must be python-entrypoint-reference
ERROR Backend subprocess exited when trying to invoke get_requires_for_build_sdist

这是文件结构的问题，是否意味着改变[project.scripts]中的路径?

Answer 1

尝试将第一个:冒号更改为.点。这应该适用于以下格式的结构:
<Project>.<File>:<Function>

来自:

[project.scripts]
futdash = "futdash:cli:main"

:

[project.scripts]
futdash = "futdash.cli:main"