Prepare release 0.4.0, add changelog and version

Author: Martin Møldrup

CHANGELOG.md

@@ -3,8 +3,12 @@ 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.4.0]
+- 🆕 Add support for pandas DataFrame assertions (pandas is an optional dependency, and snappylapy can be used without it)
+- 🆕 Add new simpler and more intuitive Expect API. We can use expect() calls and an overload will select the appropriate Expect class based on the type of the input. This is in contrast with expect.dict(), expect.list(), etc. This is not a breaking change, since the old API is still supported.
+
 ## [0.3.2]
-- Bug fix of test_directory fixture, not loading correctly depending fixture
+- 🐞 Bug fix of test_directory fixture, not loading correctly depending fixture
 
 ## [0.3.1]
 - 🐞 Fix load_snapshot fixture not loading correctly

README.md

@@ -47,6 +47,7 @@ def test_snapshot_dict(expect: Expect):
     """Test snapshot with dictionary data."""
     data: dict = my_function()
     expect.dict(data).to_match_snapshot()
+    # or expect(data).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.
@@ -100,26 +101,26 @@ Supported data types
 
 Planned data types:
 
-| Python Type         | Default Output file type | Implementation Status |
-|---------------------|--------------------------|-----------------------|
-| bytes               | .txt                     | ✅                    |
-| pd.DataFrame        | .csv                     | ❌                    |
-| pd.Series           | .csv                     | ❌                    |
-| np.ndarray          | .csv                     | ❌                    |
-| dict                | .json                    | ✅                    |
-| list                | .json                    | ✅                    |
-| tuple               | .json                    | ❌                    |
-| set                 | .json                    | ❌                    |
-| str                 | .txt                     | ✅                    |
-| int                 | .txt                     | ❌                    |
-| float               | .txt                     | ❌                    |
-| bool                | .txt                     | ❌                    |
-| datetime.datetime   | .txt                     | ❌                    |
-| datetime.date       | .txt                     | ❌                    |
-| datetime.time       | .txt                     | ❌                    |
-| pathlib.Path        | .txt                     | ❌                    |
-| decimal.Decimal     | .txt                     | ❌                    |
-| uuid.UUID           | .txt                     | ❌                    |
+| Python Type         | Default Output file type | Implementation Status     |
+|---------------------|--------------------------|---------------------------|
+| bytes               | .txt                     | ✅                       |
+| pd.DataFrame        | .csv                     | ✅ (missing csv support) |
+| pd.Series           | .csv                     | ❌                       |
+| np.ndarray          | .csv                     | ❌                       |
+| dict                | .json                    | ✅                       |
+| list                | .json                    | ✅                       |
+| tuple               | .json                    | ❌                       |
+| set                 | .json                    | ❌                       |
+| str                 | .txt                     | ✅                       |
+| int                 | .txt                     | ❌                       |
+| float               | .txt                     | ❌                       |
+| bool                | .txt                     | ❌                       |
+| datetime.datetime   | .txt                     | ❌                       |
+| datetime.date       | .txt                     | ❌                       |
+| datetime.time       | .txt                     | ❌                       |
+| pathlib.Path        | .txt                     | ❌                       |
+| decimal.Decimal     | .txt                     | ❌                       |
+| uuid.UUID           | .txt                     | ❌                       |
 
 
 

docs/index.md

@@ -1,10 +1,3 @@
 
 
 --8<-- "README.md"
-
-## Design Decisions
-### Why not match automatically based on the type of the value?
-**Why require the user to provide the type when using expect fixture (e.g. expect.string("Hello world")), instead of inferring it from the value type (e.g. expect('Hello world'))?**
-
-This is done for better code editor code completions and better type checking. When using ctrl+space in the code editor, the user will see the available options and documentation for the type. Even though it is bit more verbose, it is more explicit and and allows for a better developer experience.
-

pyproject.toml

@@ -10,7 +10,7 @@ dependencies = [
     "typing-extensions ; python_full_version == '3.9.*'",
 ]
 name = "snappylapy"
-version = "0.3.2"
+version = "0.4.0"
 description = "A snapshot library for python optimized for easy of use, human readable snapshots and enabling decoupling of chained integration tests."
 readme = "README.md"
 classifiers = [