From f8c8959d10eeacdd0b2ab4f2b7e8cf21eefd410c Mon Sep 17 00:00:00 2001 From: LobaDK Date: Fri, 6 Sep 2024 12:32:33 +0200 Subject: [PATCH] Changed package-level docstring --- settings/__init__.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/settings/__init__.py b/settings/__init__.py index f7a81ce..0b7975a 100644 --- a/settings/__init__.py +++ b/settings/__init__.py @@ -1,11 +1,17 @@ """ -Settings Manager package for handling settings and configuration files in JSON, YAML, TOML, and INI formats. - Author: Nicklas H. (LobaDK) Date: 2024 URL: https://github.com/LobaDK/python_modules -This package provides a SettingsManager base class and two fully implemented and ready-to-use classes, "SettingsManagerWithDataclass" and "SettingsManagerWithClass". for handling settings and configuration files in JSON, YAML, TOML, and INI formats. It is provided "as is" for anyone to use, modify, and distribute, freely and openly. While not required, credit back to the original author is appreciated. +Settings Manager package for handling settings and configuration files in JSON, YAML, TOML, and INI formats. + +`base.py`: Contains the base class `SettingsManagerBase` which includes all or the majority of the functionality for handling the settings and configuration files. Subclasses should inherit from this class and implement the abstract methods to provide the necessary functionality for the specific object type they wish to employ. + +`settings_manager.py`: Contains two fully implemented and ready-to-use classes, `SettingsManagerWithDataclass` and `SettingsManagerWithClass`, for working with settings created as dataclasses or classes. + +Please keep in mind that limitations and restrictions employed by the specific file formats also extend to this package. For example, INI files do not support nested sections, and TOML only supports nesting in the form of tables (dictionaries). + +This package is provided "as is" for anyone to use, modify, and distribute, freely and openly. While not required, credit back to the original author is appreciated. This package is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. """