Merge pull request #26 from savannahghi/develop

release v1.2.0

docs/CHANGELOG.md

@@ -1,3 +1,10 @@
+## [1.2.0-rc.1](https://github.com/savannahghi/sghi-commons/compare/v1.1.0...v1.2.0-rc.1) (2024-03-30)
+
+
+### Features
+
+* **retry:** add `Retry` policy interface ([#25](https://github.com/savannahghi/sghi-commons/issues/25)) ([14db0fd](https://github.com/savannahghi/sghi-commons/commit/14db0fd56865ce63ee6e763f097c9f4296240a0b))
+
 ## [1.1.0](https://github.com/savannahghi/sghi-commons/compare/v1.0.1...v1.1.0) (2024-03-21)
 
 

docs/conf.py

@@ -67,6 +67,7 @@
     ("py:class", "concurrent.futures._base.Executor"),  # sphinx can't find it
     ("py:class", "concurrent.futures._base.Future"),  # sphinx can't find it
     ("py:class", "sghi.dispatch._ST_contra"),  # private type annotations
+    ("py:class", "sghi.retry._RT"),  # private type annotations
     ("py:class", "sghi.task._IT"),  # private type annotations
     ("py:class", "sghi.task._OT"),  # private type annotations
     ("py:class", "sghi.utils.checkers._Comparable"),  # private type annotations

docs/index.rst

@@ -46,6 +46,7 @@ API Reference
      sghi.disposable
      sghi.exceptions
      sghi.registry
+     sghi.retry
      sghi.task
      sghi.typing
      sghi.utils

package.json

@@ -1,6 +1,6 @@
 {
   "name": "sghi-commons",
-  "version": "1.1.0",
+  "version": "1.2.0-rc.1",
   "description": "Collection of utilities and reusable components used throughout our Python projects.",
   "directories": {
     "doc": "docs"

src/sghi/exceptions.py

@@ -24,3 +24,7 @@ def message(self) -> str | None:
             or ``None`` if one wasn't given.
         """
         return self._message
+
+
+class SGHITransientError(SGHIError):
+    """An error that indicates a temporary failure."""