Skip to content

Update PyPI README instructions #971

Closed

Description

@bhrutledge

While reviewing #969, I noticed that making-a-pypi-friendly-readme.rst uses setup.py, while packaging-projects.rst recommends setup.cfg.

I think the README guide should be updated to use setup.cfg. I think it'd also be nice to link to making-a-pypi-friendly-readme from other relevant guides, such as packaging-projects and distributing-packages-using-setuptools.

Somewhat related: #887

Activity

  1. deleted a comment from danielgithub23 on Jun 29, 2022
  2. CAM-Gerlach commented on Jul 2, 2022

    @CAM-Gerlach
    Contributor

    Indeed. The "Include your readme in the package's metadata" section can be almost entirely elided and replaced with just a few lines instructing package authors how to set

    long_description = file: README.md
    long_description_content_type = text/markdown

    The repeated reminders to upgrade packaging tools to versions that are long-supported across the ecosystem is likewise no longer needed, especially since PEP 518 takes care of that anyway and packaging tools don't need to be installed in the user's working environment at all.

    The "Validating reST Markup" section could be simplified by using pipx to install and run Twine in one go, though that's somewhat more opinionated

  3. chrysle commented on Sep 28, 2023

    @chrysle
    Contributor

    After setup.cfg guidance has been entirely replaced with pyproject.toml in #1031 in the linked packaging projects guide,
    I think the README instructions should adapt to that.

  4. rgommers commented on Nov 10, 2026

    @rgommers
    Contributor

    Done in #2146, closing.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions