python config_error ai_generated true

error: Cannot find file 'README.md' referenced by long_description_content_type in setup.cfg

ID: python/setuptools-sdist-missing-readme

Also available as: JSON · Markdown · 中文
80%Fix Rate
83%Confidence
0Evidence
2024-09-03First Seen

Version Compatibility

VersionStatusIntroducedDeprecatedNotes
3.8 active — — —
3.9 active — — —
3.10 active — — —
3.11 active — — —
3.12 active — — —

Root Cause

Metadata refers to a README or long description file that is absent or named differently (case-sensitive on Linux), so the build fails when reading it.

generic

中文

元数据引用了不存在或名称不同的 README/长描述文件（Linux 上区分大小写），构建读取时失败。

Workarounds

  1. 92% success 
    Ensure the referenced file exists with exact case and is included in the sdist (e.g. add `include README.md` to MANIFEST.in).
  2. 88% success 
    Use dynamic metadata in pyproject.toml: `[project] readme = "README.md"` and verify the path relative to the project root.

Dead Ends

Common approaches that don't work:

  1. 60% fail

    Case changes may not match the reference and break on case-sensitive filesystems.

  2. 50% fail

    Loses PyPI description; the underlying missing-file issue remains for other references.