Update markdown

Author: Martin Møldrup

CHANGELOG.md

@@ -1,27 +1,38 @@
 # Change log
 All notable changes to this project will be documented in this file.
-## [0.2.1]
+
+*NOTE:* Version 0.X.X might have breaking changes in bumps of the minor version number. This is because the project is still in early development and the API is not yet stable. It will still be marked clearly in the release notes.
+
+## [0.3.0]
+- Add snappylapy parametization functionality to snappylapy and allow it to be loaded in the load_snapshot fixture
+- Do reporting showing count of updated, created and deleted snapshots
+- **Breaking Changes**
+  - Change setting of path to only have a single path configurable and update such it is configured through the marker
+  - Make the folder names of __snapshots__ and __test_results__ enforced to be fixed (needed for cleanup and diffing)
+  - Rename output file names of snapshots to match [filename][testname][name].extention conversion
+
+## [0.2.1] - 13-01-2025
 - Added missing dependency for typer to make the CLI work
 
-## [0.2.0]
+## [0.2.0] - 13-01-2025
 - Better error messages by using pytest assertion rewriting
 - Allow users to set the snapshot directory when using the load_snapshot fixture
 - Add CLI for for init and clear commands
 - Added automated generation of documentation using mkdocs
 
-## [0.1.1]
+## [0.1.1] - 10-01-2025
 - Update dependencies with the lower bounds of package compatibility
 - Refactor to make code easier for users of package to modify and extend
 
-## [0.1.0]
+## [0.1.0] - 08-01-2025
 - Added fixture for loading snapshots from previous tests (load_snapshot fixture)
 - Added the snappylapy marker for tests that depend on previous tests (pytest.mark.snappylapy). This will be used for more advanced features in the future.
 
-## [0.0.2]
+## [0.0.2] - 07-01-2025
 - 🐞 Added fix for python 3.9, by refactoring incompatible type annotation
 - Loosened the version requirements for pytest (until the lower bound have been discovered, with automated testing)
 - Improved metadata for pypi
 
-## [0.0.1]
+## [0.0.1] - 06-01-2025
 - Initial release of Snappylapy
 - Implemented basic snapshot testing functionality for dict, list, bytes and str data types

README.md

@@ -3,7 +3,7 @@
 Welcome to **Snappylapy**, a powerful and intuitive snapshot testing tool for Python's pytest framework. Snappylapy simplifies the process of capturing and verifying snapshots of your data, ensuring your code behaves as expected across different runs. With Snappylapy, you can save snapshots in a human-readable format and deserialize them for robust integration testing, providing a clear separation layer to help isolate errors and maintain code integrity.  
 
 ## Installation
-To install Snappylapy, use the following command:
+To get started with Snappylapy, install the package via pip:  
 
 ```bash
 pip install snappylapy
@@ -49,22 +49,6 @@ def test_snapshot_dict(expect: Expect):
     expect.dict(data).to_match_snapshot()
 ```
 
-Allows users full control to select output location for snapshots so they can be stored together with testcases.
-
-```python
-import pytest
-import pathlib
-from snappylapy import Expect
-from mypackage import my_function
-
-@pytest.mark.parametrize('case_dir', list(pathlib.Path('test_cases').iterdir()))
-def test_my_function(case_dir: pathlib.Path, expect: Expect):
-    expect.snapshot_dir = case_dir / "__snapshots__"
-    expect.test_results_dir = case_dir / "__test_results__"
-    result = my_function(case_dir)
-    expect.dict(result).to_match_snapshot()
-```
-
 In this example, `snappylapy` captures the output of `my_function` and compares it against a stored snapshot. If the output changes unexpectedly, pytest will flag the test, allowing you to review the differences and ensure your code behaves as expected.
 
 Snappylapy can use the snapshots created for inputs in another test. You can think of it as automated/easier mock data generation and management.
@@ -88,16 +72,6 @@ def test_load_snapshot_from_file(load_snapshot: LoadSnapshot):
 
 This can be great for external dependencies, for example an AI service, that might change response over time. With this approach we can isolate the changes to the service and still make succeding tests pass.
 
-## Getting Started  
-   
-To get started with Snappylapy, install the package via pip:  
-   
-```bash  
-pip install snappylapy  
-```  
-   
-Add Snappylapy to your pytest configuration and start writing tests that capture and verify snapshots effortlessly.  
-
 ## The output structure
 
 The results is split into two folders, for ease of comparison, and for handling stochastic/variable outputs (timestamps, generated ids, llm outputs, third party api responses etc).
@@ -112,12 +86,6 @@ Update snapshots with:
 pytest --snapshot-update
 ```
 
-A diff report in html can be generated with (not implemented yet ❌):
-
-```bash
-pytest --snappylapy-html=report.html
-```
-
 ## Fixtures and roadmap
 Registers fixtures:
 - expect ✅

scripts/extract_examples_from_markdown.py

@@ -36,4 +36,9 @@ def save_codeblocks(code_blocks: list[str], save_dir: pathlib.Path) -> None:
             file.write(block)
 
 code_blocks = extract_codeblocks(PATH)
+
+# Delete everything in the save directory
+for file in PATH_SAVE_DIR.iterdir():
+    file.unlink()
+
 save_codeblocks(code_blocks, PATH_SAVE_DIR)

todo.md

@@ -2,15 +2,18 @@ Markdown Checkbox VSCode Extension
 - ctl+shift+enter to toggle checkbox
 
 # Todo
+- [ ] Update README.md with example of how to use the parametization functionality
 - [ ] Do a significant boost in testing both manually and adding automated tests
 - [ ] Update README.md such that todo items is shown here instead of in the README.md
-- [ ] Change setting of path to only have a single path, and make the __snapshots__ and __test_results__ name fixed
-- [ ] Make the folder names of __snapshots__ and __test_results__ enforced to be fixed (needed for cleanup and diffing)
 - [ ] Add removal command of ophaned snapshots to snappylapy cli
 
 
 # Backlog
+- [ ] A diff report in html can be generated with `pytest --snappylapy-html=report.html`
 
 # Done
+- [X] ~~*Add snappylapy parametization functionality to snappylapy and allow it to be loaded in the load_snapshot fixture*~~ [2025-01-19]
+- [X] ~~*Make the folder names of __snapshots__ and __test_results__ enforced to be fixed (needed for cleanup and diffing)*~~ [2025-01-19]
+- [X] ~~*Change setting of path to only have a single path configurable and update such it is configured through the marker*~~ [2025-01-19]
 - [X] ~~*Do reporting showing count of updated, created and deleted snapshots*~~ [2025-01-18]
 - [X] ~~*Rename output file names of snapshots to match [filename][testname][name].extention conversion*~~ [2025-01-15]