steffo/cfig
steffo/cfig
1
Fork 0
mirror of https://github.com/Steffo99/cfig.git synced 2024-11-24 17:04:19 +00:00
Code Activity

🗒️ Improve example in README

Browse source
This commit is contained in:
Steffo 2022-04-19 04:19:23 +02:00
parent 3cee5ff825
commit 207665a185
Signed by: steffo
GPG key ID: 6965406171929D01
1 changed files with 6 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -2,6 +2,10 @@
A configuration manager for Python A configuration manager for Python
\[ [**Documentation**](https://cfig.readthedocs.io/) | [**PyPI**](https://pypi.org/project/cfig/) \]
## Example
```python ```python
import cfig import cfig
@ -17,17 +21,15 @@ if __name__ == "__main__":
``` ```
```python ```python
from .mycfig import SECRET_KEY from mypackage.mycfig import SECRET_KEY
print(f"My SECRET_KEY is: {SECRET_KEY}") print(f"My SECRET_KEY is: {SECRET_KEY}")
``` ```
```console ```console
$ python -m cfig.sample $ python -m mypackage.mycfig
=== Configuration === === Configuration ===
SECRET_KEY → Required, but not set. SECRET_KEY → Required, but not set.
Secret string used to manage HTTP session tokens. Secret string used to manage HTTP session tokens.
``` ```
\[ [**Documentation**](https://cfig.readthedocs.io/) | [**PyPI**](https://pypi.org/project/cfig/) \]