Skip to content

Commit fcf293d

Browse files
authored
Update README.md
1 parent 4c4020b commit fcf293d

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,24 @@
11
<img src="http://mypy-lang.org/static/mypy_light.svg" alt="mypy logo" width="300px"/>
22

3-
# PyTest plugin for testing mypy custom plugins
3+
# pytest plugin for testing mypy types, stubs, and plugins
44

55
[![Build Status](https://travis-ci.org/typeddjango/pytest-mypy-plugins.svg?branch=master)](https://travis-ci.org/typeddjango/pytest-mypy-plugins)
66
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
77

8+
9+
## Installation
10+
11+
```bash
12+
pip install pytest-mypy-plugins
13+
```
14+
15+
16+
## Usage
17+
818
Examples of a test case:
919

1020
```yaml
21+
# typesafety/test_request.yml
1122
- case: request_object_has_user_of_type_auth_user_model
1223
disable_cache: true
1324
main: |
@@ -24,7 +35,14 @@ Examples of a test case:
2435
pass
2536
```
2637
27-
Options:
38+
Running:
39+
40+
```bash
41+
pytest
42+
```
43+
44+
45+
## Options
2846

2947
```
3048
mypy-tests:
@@ -37,3 +55,13 @@ mypy-tests:
3755
Some debuggers cannot attach to subprocess, so enable this flag to make mypy check happen in the same process.
3856
(Could cause cache issues)
3957
```
58+
59+
60+
## Further reading
61+
62+
- [Testing mypy stubs, plugins, and types](https://sobolevn.me/2019/08/testing-mypy-types)
63+
64+
65+
## License
66+
67+
[MIT](https://github.com/typeddjango/pytest-mypy-plugins/blob/master/LICENSE)

0 commit comments

Comments
 (0)