CONTRIBUTING.md 520 Bytes
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
# Contributing

## Setting up for development

- Create and activate a new Python 3 virtual environment
- `pip install -e '.[dev]'`
- (Optional but recommended) Install the pre-commit hooks, which will
  format and lint your git staged files:

```
# The pre-commit CLI was installed above
pre-commit install
```

- To run tests:

```
pytest
```

- To run syntax checks:

```
tox -e lint
```

- (Optional) To run tests on Python 3.5, 3.6, and 3.7 virtual environments (must have each interpreter installed):

```
tox
```