setuptools version
68.2.0
Python version
3.11.5
OS
Manjaro ARM Linux 23.02
Additional environment information
No special condition I would be aware of. I call pyproject-build and it happens, but it was already happening when I call directly ./setup.py.
Description
When I call pyproject-build --sdist in my project https://github.com/rdiff-backup/rdiff-backup, setuptools spits a warning:
warning: sdist: standard file not found: should have one of README, README.rst, README.txt, README.md
even though I have defined the readme key in my pyproject.toml:
readme = {file = "pyproject.readme.md", content-type = "text/markdown"}
Expected behavior
I expect the readme to be covered by the readme key, and not need to have a specific name, which can collide with the actual (wrong format, and too long for Python) README.adoc. With collide, I mean that GitHub would prefer to render it over our actual readme, but also that it would be confusing to have 2 readmes.
How to Reproduce
- clone https://github.com/rdiff-backup/rdiff-backup.git
- you'll need asciidoctor
- call pyproject-build --sdist or ./setup.py sdist
Output
warning: sdist: standard file not found: should have one of README, README.rst, README.txt, README.md
setuptools version
68.2.0
Python version
3.11.5
OS
Manjaro ARM Linux 23.02
Additional environment information
No special condition I would be aware of. I call pyproject-build and it happens, but it was already happening when I call directly
./setup.py.Description
When I call
pyproject-build --sdistin my project https://github.com/rdiff-backup/rdiff-backup, setuptools spits a warning:even though I have defined the
readmekey in my pyproject.toml:Expected behavior
I expect the readme to be covered by the readme key, and not need to have a specific name, which can collide with the actual (wrong format, and too long for Python) README.adoc. With collide, I mean that GitHub would prefer to render it over our actual readme, but also that it would be confusing to have 2 readmes.
How to Reproduce
Output
warning: sdist: standard file not found: should have one of README, README.rst, README.txt, README.md