Merge 5e75acfd17 into e5cd8349db

.github/workflows/release.yml

@@ -26,7 +26,7 @@ jobs:
         uses: actions/setup-python@v3
 
       - name: "🔨 Setup Poetry"
-        uses: abatilo/actions-poetry@v2.4.0
+        uses: abatilo/actions-poetry@v2.3.0
 
       - name: "🔨 Setup Poetry Python environment"
         uses: Steffo99/actions-poetry-deps@v0.2.5

.github/workflows/tests.yml

@@ -46,7 +46,7 @@ jobs:
         uses: actions/setup-python@v3
 
       - name: "🔨 Setup Poetry"
-        uses: abatilo/actions-poetry@v2.4.0
+        uses: abatilo/actions-poetry@v2.3.0
 
       - name: "🔨 Setup Poetry Python environment"
         id: pyenv

README.md

@@ -1,15 +1,35 @@
-<div align="center"> 
-
-![](.media/icon-128x128_round.png)
-
 # cfig
 
-Configuration helper for Python 
+A configuration manager for Python 
 
-</div>
+\[ [**Example**](https://github.com/Steffo99/cfig/tree/main/cfig/sample) | [**Documentation**](https://cfig.readthedocs.io/) | [**PyPI**](https://pypi.org/project/cfig/) \]
 
-## Links
+```python
+import cfig
 
-[![PyPI](https://img.shields.io/pypi/v/cfig)](https://pypi.org/project/cfig)
+config = cfig.Configuration()
 
-[![Documentation](https://img.shields.io/readthedocs/cfig)](https://cfig.readthedocs.io/en/latest/)
+@config.required()
+def SECRET_KEY(val: str) -> str:
+    """Secret string used to manage HTTP session tokens."""
+    return val
+
+if __name__ == "__main__":
+    config.cli()
+```
+
+```python
+from mypackage.mycfig import SECRET_KEY
+
+print(f"My SECRET_KEY is: {SECRET_KEY}")
+```
+
+```console
+$ python -m mypackage.mycfig
+===== Configuration =====
+
+SECRET_KEY    → Required, but not set.
+Secret string used to manage HTTP session tokens.
+
+===== End =====
+```