Skip to content

Commit

Permalink
Update actively supported type checker list in readme (python#9472)
Browse files Browse the repository at this point in the history
- Added pyright mention in readme
- Add links to help navigate away readers looking for type-checkers
- Add missing code-block
  • Loading branch information
Avasam authored Jan 6, 2023
1 parent b5048a0 commit e584337
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,14 +24,18 @@ Typeshed supports Python versions 3.7 and up.

## Using

If you're just using mypy (or pytype or PyCharm), as opposed to
If you're just using a type checker ([mypy](https://github.com/python/mypy/),
[pyright](https://github.com/microsoft/pyright),
[pytype](https://github.com/google/pytype/), PyCharm, ...), as opposed to
developing it, you don't need to interact with the typeshed repo at
all: a copy of standard library part of typeshed is bundled with mypy.
all: a copy of standard library part of typeshed is bundled with type checkers.
And type stubs for third party packages and modules you are using can
be installed from PyPI. For example, if you are using `six` and `requests`,
you can install the type stubs using

$ pip install types-six types-requests
```bash
$ pip install types-six types-requests
```

These PyPI packages follow [PEP 561](http://www.python.org/dev/peps/pep-0561/)
and are automatically released (multiple times a day, when needed) by
Expand Down

0 comments on commit e584337

Please sign in to comment.