Skip to content

Commit

Permalink
Update development section in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
klaasnicolaas committed Nov 16, 2024
1 parent 35b9f87 commit a5c8e47
Showing 1 changed file with 17 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -108,40 +108,44 @@ You need at least:
- Python 3.11+
- [Poetry][poetry-install]

### Installation

Install all packages, including all development requirements:

```bash
poetry install
```

Poetry creates by default an virtual environment where it installs all
necessary pip packages, to enter or exit the venv run the following commands:
_Poetry creates by default an virtual environment where it installs all
necessary pip packages_.

### Pre-commit

This repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. To setup the pre-commit check, run:

```bash
poetry shell
exit
poetry run pre-commit install
```

Setup the pre-commit check, you must run this inside the virtual environment:
And to run all checks and tests manually, use the following command:

```bash
pre-commit install
poetry run pre-commit run --all-files
```

*Now you're all set to get started!*
### Testing

As this repository uses the [pre-commit][pre-commit] framework, all changes
are linted and tested with each commit. You can run all checks and tests
manually, using the following command:
It uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests:

```bash
poetry run pre-commit run --all-files
poetry run pytest
```

To run just the Python tests:
To update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:

```bash
poetry run pytest
poetry run pytest --snapshot-update
```

## Trademark Legal Notices
Expand Down

0 comments on commit a5c8e47

Please sign in to comment.