mirror of
https://github.com/Steffo99/cfig.git
synced 2024-11-24 08:54:20 +00:00
🗒️ Add README.md
This commit is contained in:
parent
775c8c8a38
commit
aa1f3cb41e
1 changed files with 27 additions and 0 deletions
27
README.md
Normal file
27
README.md
Normal file
|
@ -0,0 +1,27 @@
|
||||||
|
# cfig
|
||||||
|
|
||||||
|
A configuration manager for Python
|
||||||
|
|
||||||
|
```python
|
||||||
|
import cfig
|
||||||
|
|
||||||
|
config = cfig.Configuration()
|
||||||
|
|
||||||
|
@config.required()
|
||||||
|
def SECRET_KEY(val: str) -> str:
|
||||||
|
"""Secret string used to manage tokens."""
|
||||||
|
return val
|
||||||
|
|
||||||
|
if __name__ == "__main__":
|
||||||
|
config.cli()
|
||||||
|
```
|
||||||
|
|
||||||
|
```console
|
||||||
|
$ python -m cfig.sample
|
||||||
|
=== Configuration ===
|
||||||
|
|
||||||
|
SECRET_KEY → Required, but not set.
|
||||||
|
Secret string used to manage HTTP session tokens.
|
||||||
|
```
|
||||||
|
|
||||||
|
\[ [**Documentation**]() | [**PyPI**](https://pypi.org/project/cfig/) \]
|
Loading…
Reference in a new issue