Refactor serialization to use CSV for pandas DataFrames (#9)

Refactor the serialization process to utilize `PandasCsvSerializer` for
handling pandas DataFrames, enhance documentation, and improve test
coverage. Update the CHANGELOG and README to reflect the new CSV support
and version bump to 0.7.0. Fix typos in docstrings across multiple
files.

Author: martinmoldrup

.github/workflows/continuous_integration.yaml

@@ -62,7 +62,11 @@ jobs:
             uv venv
             source .venv/bin/activate
             DIST_FILE=$(ls dist/snappylapy-*.tar.gz | head -n 1)
-            uv pip install "snappylapy@$DIST_FILE"
+            if [ "${{ matrix.include-extras }}" = "true" ]; then
+              uv pip install "snappylapy[all]@$DIST_FILE"
+            else
+              uv pip install "snappylapy@$DIST_FILE"
+            fi
 
         # Remove the snappylapy folder to ensure the installed package is used for the test
         - name: Remove snappylapy folder in the cloned repository

.vscode/launch.json

@@ -0,0 +1,46 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Python Debugger: Current File",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "${file}",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}"
+            }
+        },
+        // Run current file as a module such relative imports work
+        {
+            "name": "Python Debugger: Current File as Module",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "snappylapy.${fileBasenameNoExtension}",
+            "console": "integratedTerminal",
+            "cwd": "${workspaceFolder}",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}"
+            }
+        },
+        {
+            "name": "Python Debugger: pytest",
+            "type": "debugpy",
+            "request": "launch",
+            "program": "debug.py",
+            "args": [
+
+            ],
+            "console": "integratedTerminal",
+            "justMyCode": true,
+            "cwd": "${workspaceFolder}",
+            "env": {
+                "PYTHONPATH": "${workspaceFolder}"
+            }
+        }
+    ]
+}

CHANGELOG.md

@@ -3,6 +3,9 @@ All notable changes to this project will be documented in this file.
 
 *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.7.0] - 2025-08-27
+- 🆕 Added csv serializer for pandas dataframes for making the deserialization work on windows and make a more suitable and human readable format.
+
 ## [0.6.1] - 2025-08-25
 - 🐞 Improve the handling of comparing large snapshots with test results. Snappylapy should be working well on large data structures. Disable the pytest assertion rewrite for large comparisons.
 

README.md

@@ -1,6 +1,8 @@
 # Snappylapy
 
-Welcome to **Snappylapy**, a powerful and intuitive snapshot testing plugin 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.  
+Welcome to **Snappylapy**, a powerful and intuitive snapshot testing plugin 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. 
+
+Snappylapy is following the api-style of the very popular Jest testing framework, making it familiar and easy to use for JavaScript developers.
 
 ## Installation
 To get started with Snappylapy, install the package via pip, uv or poetry:  
@@ -64,7 +66,7 @@ import pytest
 from snappylapy import Expect, LoadSnapshot
 
 def test_snapshot_dict(expect: Expect):
-    """Test snapshot with dictionary data.****"""
+    """Test snapshot with dictionary data."""
     expect({
         "name": "John Doe",
         "age": 31
@@ -109,6 +111,7 @@ Registers pytest fixtures:
 Supported data types
 - ✅ .txt - if you provide a string
 - ✅ .json - for all other objects
+- ✅ .csv - for pandas DataFrames
 - ✅ custom (decode the data yourself and provide a file extension)
 
 ### Supported data types to snapshot test