Skip to content

Commit

Permalink
update module docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
pmayd committed Jul 30, 2022
1 parent 239cf83 commit 2f9bebe
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion src/pygenesis/config.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
"""Module loads the config (.env) file. (Placeholder for additional logic related to the config.)"""
"""Module for handling settings.ini and config.ini files.
This package stores core information in the settings.ini, which is stored under the user home directory.
The parent directory for the settings.ini is called after the package name.
The settings.ini gets automatically created by importing this package, if it does not exist already.
The config.ini is stored in a directory that is configured in the settings.ini via `config_dir`.
The config.ini holds all revelant information about the usage of GENESIS API like credentials.
If there is no config.ini in the given config_dir, a default config will be created with empty credentials.
"""
import logging
from configparser import ConfigParser
from pathlib import Path
Expand Down

0 comments on commit 2f9bebe

Please sign in to comment.