search

pypa / hatch

Modern, extensible Python project management
https://hatch.pypa.io/latest/
MIT License
6.07k stars 306 forks source link

project.readme content-tyoe does not support specifying markdown flavors #1672

Open ThiefMaster opened 3 months ago

ThiefMaster commented 3 months ago

This is accepted by flit and setuptools:

[project.readme]
file = 'README.md'
content-type = 'text/markdown; variant=GFM'

However, hatch disallows this:

Field content-type in the project.readme table must be one of the following: text/markdown, text/x-rst, text/plain

While GFM is the default (so I can just avoid specifying it altogether), PyPI also supports e.g. the CommonMark dialect and it looks like there's no way to specify that right now when using hatch.

ofek commented 3 months ago

I guess that technically is allowed and I should fix it? https://packaging.python.org/en/latest/specifications/pyproject-toml/#readme