1
Fork 0
mirror of https://github.com/Steffo99/cfig.git synced 2024-12-22 06:04:21 +00:00

Compare commits

...

3 commits

Author SHA1 Message Date
dependabot[bot]
4e9305f188
Merge b8240d18c5 into dc5779f1bc 2024-11-28 20:39:48 +00:00
dc5779f1bc
Remove example from README 2024-05-14 03:25:33 +02:00
eaa3aad5e7
Update README 2024-05-14 03:22:57 +02:00
2 changed files with 9 additions and 29 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 6.1 KiB

View file

@ -1,35 +1,15 @@
<div align="center">
![](.media/icon-128x128_round.png)
# cfig
A configuration manager for Python
Configuration helper for Python
\[ [**Example**](https://github.com/Steffo99/cfig/tree/main/cfig/sample) | [**Documentation**](https://cfig.readthedocs.io/) | [**PyPI**](https://pypi.org/project/cfig/) \]
</div>
```python
import cfig
## Links
config = cfig.Configuration()
[![PyPI](https://img.shields.io/pypi/v/cfig)](https://pypi.org/project/cfig)
@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 =====
```
[![Documentation](https://img.shields.io/readthedocs/cfig)](https://cfig.readthedocs.io/en/latest/)