python data_error ai_generated true

error: README.md not found

ID: python/setuptools-readme-file-not-found

Also available as: JSON · Markdown · 中文
80%Fix Rate
86%Confidence
0Evidence
2024-06-25First Seen

Version Compatibility

VersionStatusIntroducedDeprecatedNotes
3.6 active — — —
3.7 active — — —
3.8 active — — —

Root Cause

The long_description in setup.py references a file that doesn't exist in the project directory.

generic

中文

setup.py 中的 long_description 引用了项目目录中不存在的文件。

Workarounds

  1. 90% success 
    touch README.md
  2. 95% success 
    from pathlib import Path; this_directory = Path(__file__).parent; long_description = (this_directory / 'README.md').read_text()

Dead Ends

Common approaches that don't work:

  1. 20% fail

    May work but hides missing documentation.

  2. 40% fail

    May lose PyPI description; not always necessary.