|
2 | 2 | Basic script to generate a wheel for a third-party distribution in typeshed. |
3 | 3 |
|
4 | 4 | This generates a PEP 561 types stub package using METADATA.toml file for a given |
5 | | -distribution in typeshed stubs. Such package |
6 | | -can be used by type-checking tools like |
7 | | -[mypy](https://github.com/python/mypy/), |
8 | | -[pyright](https://github.com/microsoft/pyright), |
9 | | -[pytype](https://github.com/google/pytype/), |
10 | | -PyCharm, etc. to check code that uses |
11 | | -the corresponding runtime Python package. |
| 5 | +distribution in typeshed stubs. Such package can be used by type checkers |
| 6 | +to check code that uses the corresponding runtime Python package. |
12 | 7 |
|
13 | 8 | The generated wheel includes all type stubs (*.pyi files) and the METADATA.toml |
14 | 9 | itself, no other files can be included. |
|
102 | 97 | DESCRIPTION_INTRO_TEMPLATE = """ |
103 | 98 | ## Typing stubs for {distribution} |
104 | 99 |
|
105 | | -This is a [PEP 561](https://peps.python.org/pep-0561/) |
106 | | -type stub package for the {formatted_distribution} package. |
107 | | -It can be used by type-checking tools like |
108 | | -[mypy](https://github.com/python/mypy/), |
109 | | -[pyright](https://github.com/microsoft/pyright), |
110 | | -[pytype](https://github.com/google/pytype/), |
111 | | -[Pyre](https://pyre-check.org/), |
112 | | -PyCharm, etc. to check code that uses `{distribution}`. This version of |
| 100 | +This is a [PEP 561](https://peps.python.org/pep-0561/) type stub package for |
| 101 | +the {formatted_distribution} package. It can be used by type checkers |
| 102 | +to check code that uses `{distribution}`. This version of |
113 | 103 | `{stub_distribution}` aims to provide accurate annotations for |
114 | 104 | `{distribution}{typeshed_version_spec}`. |
115 | 105 | """.strip() |
|
122 | 112 | [`stubs/{distribution}`](https://github.com/python/typeshed/tree/main/stubs/{distribution}) |
123 | 113 | directory. |
124 | 114 |
|
125 | | -This package was tested with |
126 | | -mypy {ts_data.mypy_version}, |
127 | | -pyright {ts_data.pyright_version}, |
128 | | -and pytype {ts_data.pytype_version}. |
| 115 | +This package was tested with the following type checkers: |
| 116 | +* [mypy](https://github.com/python/mypy/) {ts_data.mypy_version} |
| 117 | +* [pyright](https://github.com/microsoft/pyright) {ts_data.pyright_version} |
129 | 118 | It was generated from typeshed commit |
130 | 119 | [`{commit}`](https://github.com/python/typeshed/commit/{commit}). |
131 | 120 | """.strip() |
|
0 commit comments