Skip to content
This repository was archived by the owner on Feb 17, 2021. It is now read-only.

Commit 124c184

Browse files
authored
Merge pull request #164 from predictive-analytics-lab/update-readme
Update readme
2 parents 74cf0c8 + 54dfa27 commit 124c184

File tree

2 files changed

+18
-4
lines changed

2 files changed

+18
-4
lines changed

README.md

+18-4
Original file line numberDiff line numberDiff line change
@@ -92,15 +92,18 @@ pip install -e .[dev]
9292

9393
This will also install numpy, pandas and matplotlib to be able to run the tests.
9494

95-
### Pre-pull request checks
95+
### Running CI locally (recommended)
9696

97-
We also include a script that runs the CI checks that will be run when a PR is opened.
97+
We include a script that runs the CI checks that will be run when a PR is opened.
9898
To test these out locally, use the `check_all.sh` script.
9999

100100
```bash
101101
./check_all.sh
102102
```
103103

104+
Below we describe how to run the various checks individually,
105+
but `check_all.sh` should be easier to use.
106+
104107
### Checking compliance with Mypy
105108
The settings for Mypy are specified in the `mypy.ini` file in the repository.
106109
Just running
@@ -115,11 +118,22 @@ We use [Black][black] to format the stub files.
115118
First install `black` and then run
116119

117120
```
118-
black -l 100 -t py36 -S .
121+
black .
119122
```
120-
121123
from the base directory.
122124

125+
### Pytest
126+
127+
```
128+
python -m pytest -vv tests/
129+
```
130+
131+
### Flake8
132+
133+
```
134+
flake8 *-stubs
135+
```
136+
123137
## License
124138

125139
[Apache 2.0](LICENSE)
File renamed without changes.

0 commit comments

Comments
 (0)