Move all public methods to the api namespace

CHANGES/19.breaking.rst

@@ -0,0 +1 @@
+Moved :func:`propcache.api.under_cached_property` and :func:`propcache.api.cached_property` to ``propcache.api`` -- by :user:`bdraco`.

docs/api.rst

@@ -4,7 +4,7 @@
 Reference
 =========
 
-.. module:: propcache
+.. module:: propcache.api
 
 
 
@@ -15,7 +15,7 @@ cached_property
 
    This decorator functions exactly the same as the standard library
    :func:`cached_property` decorator, but it's available in the
-   :mod:`propcache` module along with an accelerated Cython version.
+   :mod:`propcache.api` module along with an accelerated Cython version.
 
    As with the standard library version, the cached value is stored in
    the instance's ``__dict__`` dictionary. To clear a cached value, you
@@ -34,6 +34,8 @@ under_cached_property
 
    Example::
 
+       from propcache.api import under_cached_property
+
        class MyClass:
 
            def __init__(self, data: List[float]):

propcache/__init__.py

@@ -1,8 +1,6 @@
-from ._helpers import cached_property, under_cached_property
+"""propcache: An accelerated property cache for Python classes."""
 
-__version__ = "0.1.0.dev0"
+__version__ = "1.0.0.dev0"
 
-__all__ = (
-    "cached_property",
-    "under_cached_property",
-)
+# Imports have moved to `propcache.api` in 1.0.0+.
+__all__ = ()

propcache/api.py

@@ -0,0 +1,8 @@
+"""Public API of the property caching library."""
+
+from ._helpers import cached_property, under_cached_property
+
+__all__ = (
+    "cached_property",
+    "under_cached_property",
+)