papertrail 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

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)

{papertrail-0.1.0.dist-info → papertrail-0.1.1.dist-info}/METADATA

@@ -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.dist-info → papertrail-0.1.1.dist-info}/RECORD

@@ -4,7 +4,7 @@ papertrail/adapters/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSu
 papertrail/adapters/io_funcs.py,sha256=nDS7EcodP7gEpR5Yse3apvowP45DZG6_95145vroO5s,1089
 papertrail/core/__init__.py,sha256=gO2KeYEZQwE2_YbBuY7IFAILMz7g-FgI8S5avT0ZlIQ,146
 papertrail/core/collection/__init__.py,sha256=U9jT8Gpk7dqnCJbwbvezYFfyxIam04zLKa9n_ortqh8,244
-papertrail/core/collection/example.py,sha256=FbgKDCCODO7eKqTpo86n9M7qtFSSUF1ym7eS3585oqE,3137
+papertrail/core/collection/example.py,sha256=EpzLyi4W2MMTUFG5OBNDs83xuR0eKhXc5QblW_7lIZY,4917
 papertrail/core/collection/record.py,sha256=7cbq9I9AvmtOAONL3hL4SKIccG_Jo1rZ00ugQ2MKX5I,348
 papertrail/core/collection/recorder.py,sha256=O9ZMm5hUi7G1vmjCjTwgs5M7FxtjoMVGJCtS_lWWpQE,1204
 papertrail/core/logger.py,sha256=GdyteNTrz_ywmtHpTqGwX6ATDH92kl-do_0wZGNAQTE,985
@@ -12,6 +12,6 @@ papertrail/core/transformation/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5
 papertrail/core/transformation/ast_editing.py,sha256=QK9VKR8wQCgWDvfA-DJrMvoQQrSP_0Ay7ZT83CIObmA,2373
 papertrail/core/transformation/format_examples.py,sha256=0vHPihq5dpOrmwE3bywQrwZWr1HwKnGSqvq7YmEFwdg,1398
 papertrail/core/transformation/transform.py,sha256=qlcoiRH5WGW22qetdPfslKTOKn4wYa_msXIr4kmwAXU,956
-papertrail-0.1.0.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
-papertrail-0.1.0.dist-info/METADATA,sha256=DgdHqApDYmcGiu1cWA0Ns3n5vNFrkIkpIsR801Sedmo,4717
-papertrail-0.1.0.dist-info/RECORD,,
+papertrail-0.1.1.dist-info/WHEEL,sha256=eh7sammvW2TypMMMGKgsM83HyA_3qQ5Lgg3ynoecH3M,79
+papertrail-0.1.1.dist-info/METADATA,sha256=P68uA2YsewYZHBPJqRmHhuwZ_jffG6OJrMEv6EDijtw,4983
+papertrail-0.1.1.dist-info/RECORD,,