Skip to content

Commit

Permalink
readme: Change formatting
Browse files Browse the repository at this point in the history
To make it easier to copy and paste bash commands
  • Loading branch information
odscjames committed Nov 25, 2022
1 parent f1bba04 commit 120c868
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,25 +20,32 @@ pip install -e .

Call `libcoveofds` and pass --help to see options.

libcoveofds --help
libcoveofds jsontogeojson --help
```bash
libcoveofds --help
libcoveofds jsontogeojson --help
```

### Running tests

python -m pytest
```bash
python -m pytest
```

For writing tests, look in `make_expected_test_data.sh` for a helper script.

### Code linting

Make sure dev dependencies are installed in your virtual environment:

pip install -e .[dev]
```bash
pip install -e .[dev]
```

Then run:

isort libcoveofds/ libcove2/ tests/ setup.py
black libcoveofds/ libcove2/ tests/ setup.py
flake8 libcoveofds/ libcove2/ tests/ setup.py
mypy --install-types --non-interactive -p libcoveofds

```bash
isort libcoveofds/ libcove2/ tests/ setup.py
black libcoveofds/ libcove2/ tests/ setup.py
flake8 libcoveofds/ libcove2/ tests/ setup.py
mypy --install-types --non-interactive -p libcoveofds
```

0 comments on commit 120c868

Please sign in to comment.