From a71506ccd054cbf46684011ed43c52e3d1e94ebe Mon Sep 17 00:00:00 2001 From: wyattscarpenter Date: Fri, 3 Apr 2026 20:39:00 -0400 Subject: [PATCH 1/2] Use the actual readme as the readme Fixes https://github.com/python/mypy/issues/12456 Things to consider: Our current readme starts with "Got a question?". We could start with a short description instead, copying in our current description paragraph: Add type annotations to your Python programs, and use mypy to type check them. Mypy is essentially a Python linter on steroids, and it can catch many programming errors by analyzing your program, without actually having to run it. Mypy has a powerful type system with features such as type inference, gradual typing, generics and union types." Occasionally there is a relative link, like [CONTRIBUTING.md](CONTRIBUTING.md). Do those need to be changed? --- pyproject.toml | 12 +----------- 1 file changed, 1 insertion(+), 11 deletions(-) diff --git a/pyproject.toml b/pyproject.toml index 3f876316f042..84b15b05d698 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -19,17 +19,7 @@ build-backend = "setuptools.build_meta" [project] name = "mypy" description = "Optional static typing for Python" -readme = {text = """ -Mypy -- Optional Static Typing for Python -========================================= - -Add type annotations to your Python programs, and use mypy to type -check them. Mypy is essentially a Python linter on steroids, and it -can catch many programming errors by analyzing your program, without -actually having to run it. Mypy has a powerful type system with -features such as type inference, gradual typing, generics and union -types. -""", content-type = "text/x-rst"} +readme = "README.md" authors = [{name = "Jukka Lehtosalo", email = "jukka.lehtosalo@iki.fi"}] license = "MIT" license-files = ["LICENSE", "mypy/typeshed/LICENSE"] From e7f26e16fc79f1e53b2d2cc5721b7f550791486c Mon Sep 17 00:00:00 2001 From: wyattscarpenter Date: Fri, 3 Apr 2026 21:21:56 -0400 Subject: [PATCH 2/2] Update README.md: add the summary description to the readme, and fix the relative link --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 8040566b18ef..d1636e80f11d 100644 --- a/README.md +++ b/README.md @@ -12,6 +12,8 @@ Mypy: Static Typing for Python [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black) [![Linting: Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/charliermarsh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff) +Add type annotations to your Python programs, and use mypy to type check them. Mypy is essentially a Python linter on steroids, and it can catch many programming errors by analyzing your program, without actually having to run it. Mypy has a powerful type system with features such as type inference, gradual typing, generics and union types. + Got a question? --------------- @@ -168,7 +170,8 @@ Help in testing, development, documentation and other tasks is highly appreciated and useful to the project. There are tasks for contributors of all experience levels. -To get started with developing mypy, see [CONTRIBUTING.md](CONTRIBUTING.md). +To get started with developing mypy, see +[CONTRIBUTING.md](https://github.com/python/mypy/blob/master/CONTRIBUTING.md). Mypyc and compiled version of mypy ----------------------------------