Add syrupy library for snapshot tests

.github/workflows/tests.yaml

@@ -35,7 +35,7 @@ jobs:
       - name: 🏗 Install dependencies
         run: poetry install --no-interaction
       - name: 🚀 Run pytest
-        run: poetry run pytest --cov src tests
+        run: poetry run pytest -v --cov src tests
       - name: ⬆️ Upload coverage artifact
         uses: actions/upload-artifact@v4.3.1
         with:

README.md

@@ -173,6 +173,12 @@ To run just the Python tests:
 poetry run pytest
 ```
 
+To update the [syrupy](https://github.com/tophat/syrupy) snapshot tests:
+
+```bash
+poetry run pytest --snapshot-update
+```
+
 ## License
 
 MIT License

pyproject.toml

@@ -50,6 +50,7 @@ pytest-cov = "4.1.0"
 pytest-freezer = "0.4.8"
 pytz = "2024.1"
 ruff = "0.2.1"
+syrupy = "4.6.1"
 types-pytz = "2024.1.0.20240203"
 yamllint = "1.34.0"