From 6abd8407af7f8aa10c5f0436d7864a6c6e446774 Mon Sep 17 00:00:00 2001 From: Merlin Unterfinger Date: Wed, 21 Aug 2024 18:00:42 +0200 Subject: [PATCH] DOC: NAV-145 - Update README --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f4e5e50..09d359e 100644 --- a/README.md +++ b/README.md @@ -27,12 +27,14 @@ print(response) See the integration tests for more examples. -## Testing +## Development + +### Testing This project uses pytest for both unit and integration testing. The tests are organized into separate folders to ensure clarity and separation of concerns. -## Running Unit Tests +### Unit Tests Unit tests are designed to test individual components in isolation. To run the unit tests, simply execute: @@ -40,7 +42,7 @@ Unit tests are designed to test individual components in isolation. To run the u poetry run pytest -m unit ``` -## Running Integration Tests +### Integration Tests Integration tests ensure that the components work together as expected in a more realistic environment. These tests require the service to be running, usually within a Docker container.