papertrail 0.1.0__tar.gz → 0.1.1__tar.gz

{papertrail-0.1.0 → papertrail-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: papertrail
-Version: 0.1.0
+Version: 0.1.1
 Summary: Add your description here
 Author: ed cuss
 Author-email: ed cuss <edcussmusic@gmail.com>
@@ -13,6 +13,11 @@ Requires-Python: >=3.11
 Description-Content-Type: text/markdown
 
 # papertrail
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/papertrail?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=BLUE&left_text=downloads)](https://pepy.tech/projects/danom)
+
+## API Reference
+
+[papertrail API docs](https://second-ed.github.io/papertrail/)
 
 ### Motivation
 - Documentation can get out of date quickly
@@ -86,7 +91,10 @@ def func_b(a: float, b: float) -> float:
 
     Papertrail examples:
 
-        >>> func_b(3, 4) == -1
+        >>> func_b(2, 2) == 0
+        True
+
+        >>> func_b(2, b=3) == -1
         True
     ::
     """
@@ -99,9 +107,6 @@ def func_b(a: float, b: float) -> float:
 │   └── workflows
 │       ├── ci_tests.yaml
 │       └── publish.yaml
-├── docs
-│   └── source
-│       └── conf.py
 ├── src
 │   └── papertrail
 │       ├── adapters

{papertrail-0.1.0 → papertrail-0.1.1}/README.md

@@ -1,4 +1,9 @@
 # papertrail
+[![PyPI Downloads](https://static.pepy.tech/personalized-badge/papertrail?period=total&units=INTERNATIONAL_SYSTEM&left_color=BLACK&right_color=BLUE&left_text=downloads)](https://pepy.tech/projects/danom)
+
+## API Reference
+
+[papertrail API docs](https://second-ed.github.io/papertrail/)
 
 ### Motivation
 - Documentation can get out of date quickly
@@ -72,7 +77,10 @@ def func_b(a: float, b: float) -> float:
 
     Papertrail examples:
 
-        >>> func_b(3, 4) == -1
+        >>> func_b(2, 2) == 0
+        True
+
+        >>> func_b(2, b=3) == -1
         True
     ::
     """
@@ -85,9 +93,6 @@ def func_b(a: float, b: float) -> float:
 │   └── workflows
 │       ├── ci_tests.yaml
 │       └── publish.yaml
-├── docs
-│   └── source
-│       └── conf.py
 ├── src
 │   └── papertrail
 │       ├── adapters

{papertrail-0.1.0 → papertrail-0.1.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "papertrail"
-version = "0.1.0"
+version = "0.1.1"
 description = "Add your description here"
 readme = "README.md"
 authors = [
@@ -46,3 +46,9 @@ omit = [
 show_missing = true
 skip_covered = true
 fail_under = 95
+
+[tool.pytest.ini_options]
+norecursedirs = [
+    "docs/docs-build",
+    "docs/_build",
+]

{papertrail-0.1.0 → papertrail-0.1.1}/src/papertrail/core/collection/example.py

@@ -111,11 +111,77 @@ def example(fn: Callable, *args: tuple[Any, ...], **kwargs: dict[str, Any]) -> E
 
             Papertrail examples:
 
-                >>> func_b(3, 4) == -1
+                >>> func_b(2, 2) == 0
+                True
+
+                >>> func_b(2, b=3) == -1
                 True
             ::
             \"\"\"
             return a - b
+
+    For more exciting inputs and arguments the docstrings code will be formatted with black:
+
+    .. code-block:: python
+
+        def enum_keys(enum_dict: dict[int, str]) -> list[str]:
+            \"\"\"Multiply the values by the key amount.\"\"\"
+            return [i * a for i, a in enum_dict.items()]
+
+
+    Imagine this test:
+
+    .. code-block:: python
+
+        import string
+
+        import pytest
+        from mock_src.mod_b import enum_keys
+
+        from papertrail import example
+
+
+        @pytest.mark.parametrize(
+            ("args", "kwargs", "expected_result"),
+            [
+                pytest.param(
+                    (dict(enumerate(string.ascii_lowercase[:5])),),
+                    {},
+                    [
+                        "",
+                        "b",
+                        "cc",
+                        "ddd",
+                        "eeee",
+                    ],
+                ),
+            ],
+        )
+        def test_enum_keys(args, kwargs, expected_result):
+            assert example(enum_keys, *args, **kwargs) == expected_result
+
+
+    This is the result (Hopefully it clearly suggests what the function should do):
+
+    .. code-block:: python
+
+        def enum_keys(enum_dict: dict[int, str]) -> list[str]:
+            \"\"\"Multiply the values by the key amount.
+
+            Papertrail examples:
+
+                >>> enum_keys({0: "a", 1: "b", 2: "c", 3: "d", 4: "e"}) == [
+                ...     "",
+                ...     "b",
+                ...     "cc",
+                ...     "ddd",
+                ...     "eeee",
+                ... ]
+                True
+            ::.
+            \"\"\"
+            return [i * a for i, a in enum_dict.items()]
+
     """
     value = fn(*args, **kwargs)
     return Example(fn, args, kwargs, value, recorder=_RECORDER)