FG
🤖 AI & LLMsAnthropic

Source distribution tarballs on pypi do not contain README.md, causing hatch-fancy-pypi-readme plugin to fail

Freshabout 21 hours ago
Mar 14, 20260 views
Confidence Score48%
48%

Problem

The source distributions published to pypi presently cannot be built; attempts fail with: [code block] Inspecting the tarball to list non-`.py` content shows only: [code block] Notably, there is indeed no README.md file present.

Error Output

Error: ["Fragment file 'README.md' not found."]

Unverified for your environment

Select your OS to check compatibility.

1 Fix

Canonical Fix
Unverified Fix
New Fix – Awaiting Verification

Ensure README.md is included in source distributions for PyPI

Medium Risk

The source distribution tarballs published to PyPI do not include the README.md file due to misconfiguration in the setup script. This omission prevents the hatch-fancy-pypi-readme plugin from functioning correctly, as it relies on the presence of the README.md file to generate the package's documentation.

Awaiting Verification

Be the first to verify this fix

  1. 1

    Update setup.py to include README.md

    Modify the setup.py file to ensure that README.md is included in the source distribution. This can be done by adding the README.md file to the 'packages' or 'package_data' argument.

    python
    from setuptools import setup, find_packages

setup(
    name='your_package_name',
    version='0.1',
    packages=find_packages(),
    include_package_data=True,
    package_data={'': ['README.md']},
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
)
  2. 2

    Rebuild the source distribution

    After updating the setup.py file, rebuild the source distribution using the following command. This will create a new tarball that includes the README.md file.

    bash
    python setup.py sdist
  3. 3

    Upload the new source distribution to PyPI

    Upload the newly created source distribution to PyPI using Twine. This ensures that the updated tarball, which now includes the README.md file, is available for users.

    bash
    twine upload dist/*
  4. 4

    Verify the uploaded package

    Check the uploaded package on PyPI to confirm that the README.md file is included in the source distribution. You can download the tarball and inspect its contents to ensure the README.md is present.

    bash
    pip download your_package_name --no-binary :all:
# Then extract and check the contents

Validation

To confirm the fix worked, download the new source distribution from PyPI and extract it. Ensure that the README.md file is present in the extracted contents. Additionally, verify that the hatch-fancy-pypi-readme plugin functions correctly with the updated package.

Sign in to verify this fix

Environment

Submitted by

AC

Alex Chen

2450 rep

Tags

claudeanthropicllmapi