You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
A best attempt is made to support Python versions until they reach EOL, after which support will be formally dropped by the next minor or major release of this package, whichever arrives first. The status of Python versions can be found [here](https://devguide.python.org/versions/).
4
+
5
+
## Development Environment
6
+
7
+
Development of this project is done using the supported Python version most recently released. Note that tests are run against all supported versions of Python; see: [Testing & Coverage](#testing--coverage) for additional information.
8
+
9
+
This project uses [uv](https://docs.astral.sh/uv) to manage dependencies. With your fork cloned to your local machine, you can install the project and its dependencies to create a development environment using:
10
+
11
+
```text
12
+
$ uv venv
13
+
$ uv sync --all-extras --dev
14
+
```
15
+
16
+
A [`pre-commit`](https://pre-commit.com) configuration is also provided to create a pre-commit hook so linting errors aren't committed:
17
+
18
+
```text
19
+
$ pre-commit install
20
+
```
21
+
22
+
[`mypy`](https://mypy-lang.org/) is also used by this project to provide static type checking. It can be invoked using:
23
+
24
+
```text
25
+
$ mypy .
26
+
```
27
+
28
+
Note that `mypy` is not included as a pre-commit hook.
29
+
30
+
## Testing & Coverage
31
+
32
+
A [pytest](https://docs.pytest.org/en/latest/) suite is provided, with coverage reporting from [`pytest-cov`](https://github.com/pytest-dev/pytest-cov). A [`tox`](https://github.com/tox-dev/tox/) configuration is provided to test across all supported versions of Python. Testing will be skipped locally for Python versions that cannot be found; all supported versions are tested in CI.
33
+
34
+
```text
35
+
$ tox
36
+
```
37
+
38
+
Details on missing coverage, including in the test suite, is provided in the report to allow the user to generate additional tests for full coverage. Full code coverage is expected for the majority of code contributed to this project. Some exceptions are expected, primarily around code whose functionality relies on either user input or the presence of external drives; these interactions are currently not mocked, though this may change in the future.
Copy file name to clipboardExpand all lines: README.md
-28Lines changed: 0 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -206,31 +206,3 @@ Support is only provided for the following patterns:
206
206
*`import typing as <alias>; foo: <alias>.Any`
207
207
208
208
Nested dynamic types (e.g. `typing.Tuple[typing.Any]`) and redefinition (e.g. `from typing import Any as Foo`) will not be identified.
209
-
210
-
## Contributing
211
-
### Python Version Support
212
-
A best attempt is made to support Python versions until they reach EOL, after which support will be formally dropped by the next minor or major release of this package, whichever arrives first. The status of Python versions can be found [here](https://devguide.python.org/versions/).
213
-
214
-
### Development Environment
215
-
This project uses [Poetry](https://python-poetry.org/) to manage dependencies. With your fork cloned to your local machine, you can install the project and its dependencies to create a development environment using:
216
-
217
-
```bash
218
-
$ poetry install
219
-
```
220
-
221
-
Note: An editable installation of `flake8-annotations` in the developer environment is required in order for the plugin to be registered for Flake8. By default, Poetry includes an editable install of the project itself when `poetry install` is invoked.
222
-
223
-
A [pre-commit](https://pre-commit.com) configuration is also provided to create a pre-commit hook so linting errors aren't committed:
224
-
225
-
```bash
226
-
$ pre-commit install
227
-
```
228
-
229
-
### Testing & Coverage
230
-
A [pytest](https://docs.pytest.org/en/latest/) suite is provided, with coverage reporting from [pytest-cov](https://github.com/pytest-dev/pytest-cov). A [tox](https://github.com/tox-dev/tox/) configuration is provided to test across all supported versions of Python. Testing will be skipped for Python versions that cannot be found.
231
-
232
-
```bash
233
-
$ tox
234
-
```
235
-
236
-
Details on missing coverage, including in the test suite, is provided in the report to allow the user to generate additional tests for full coverage.
0 commit comments