chore: export invariant decorators on module level

MultifokalHirn · Dec 21, 2023 · 5ff62ac · 5ff62ac
1 parent 5d3af3a
commit 5ff62ac
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -51,7 +51,7 @@ A `@decorator` 'talks about' other code in a way that is <u>understandable for b
 ### Example
 
 ``` python
-from ornaments.invariants.only_called_once import only_called_once
+from ornaments.invariants import only_called_once
 
 @only_called_once(scope="session", enforce=True)
 def only_once_callable_function() -> None:

diff --git a/src/ornaments/invariants/__init__.py b/src/ornaments/invariants/__init__.py
@@ -0,0 +1,5 @@
+from .only_called_once import only_called_once
+
+__all__ = [
+    "only_called_once",
+]
diff --git a/tests/invariants/test_only_called_once.py b/tests/invariants/test_only_called_once.py
@@ -1,6 +1,6 @@
 import pytest
 from ornaments.exceptions import CalledTooOftenError, CalledTooOftenWarning
-from ornaments.invariants.only_called_once import only_called_once
+from ornaments.invariants import only_called_once
 
 # ---------------------------------------------------------------
 # enforce=False (default)