python / python/mypy

Update PEP 561 examples with modern packaging

Open
#13,901 4 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation topic-pep-561
Dominant language
Python
Stars
20.6k
Forks
3.3k
PR merge metrics
PR metrics pending

Description

Documentation

https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages as noted in https://github.com/pypa/hatch/discussions/554 only mentions setup.py which is deprecated for simply defining metadata, see PEP 621

It would be nice to mention the Hatchling way as that is now the default in the official Python packaging tutorial.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the “Creating PEP 561-compatible packages” section at the linked mypy documentation page, then read the linked PEP 621, Hatchling discussion, and Python packaging tutorial. Update the examples to mention the modern Hatchling and metadata approach alongside or instead of setup.py, and verify that the documentation accurately reflects current packaging guidance.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.