python config_error ai_generated true

warning: sdist: standard file not found: should have one of README, README.rst, README.txt, README.md

ID: python/setuptools-license-file-missing

Also available as: JSON · Markdown · 中文
80%Fix Rate
84%Confidence
0Evidence
2024-08-01First Seen

Version Compatibility

VersionStatusIntroducedDeprecatedNotes
3.8 active — — —
3.9 active — — —
3.10 active — — —

Root Cause

The package is missing a README file, which setuptools expects for metadata.

generic

中文

包缺少 README 文件，setuptools 期望有该文件用于元数据。

Workarounds

  1. 95% success Create a README.md with basic project info 
    echo '# My Project' > README.md
  2. 80% success Specify readme in setup.py 
    from setuptools import setup; setup(..., long_description=open('README.md').read())

Dead Ends

Common approaches that don't work:

  1. Ignoring the warning 50% fail

    May cause issues in package distribution.

  2. Adding an empty file named README 40% fail

    Empty content doesn't provide proper documentation.