From 6c1e87c8a008d3f00afb71c9f7acd01d2c9433e8 Mon Sep 17 00:00:00 2001 From: Klaas Schoute Date: Sun, 17 Nov 2024 00:22:13 +0100 Subject: [PATCH] Update development section in docs --- README.md | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 861f116..15c1ad0 100644 --- a/README.md +++ b/README.md @@ -158,37 +158,35 @@ 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_. -```bash -poetry shell -exit -``` +### Pre-commit -Setup the pre-commit check, you must run this inside the virtual environment: +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 -pre-commit install +poetry run pre-commit install ``` -*Now you're all set to get started!* - -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: +And to run all checks and tests manually, use the following command: ```bash poetry run pre-commit run --all-files ``` -To run just the Python tests: +### Testing + +It uses [pytest](https://docs.pytest.org/en/stable/) as the test framework. To run the tests: ```bash poetry run pytest