mooch.settings 0.0.1.dev1__py3-none-any.whl

mooch/__init__.py

@@ -0,0 +1,5 @@
+"""mooch package initialization."""
+
+from pkgutil import extend_path
+
+__path__ = extend_path(__path__, __name__)

mooch/settings/__init__.py

@@ -0,0 +1,4 @@
+
+from mooch.settings.settings import Settings
+
+__all__ = ["Settings"]

mooch/settings/file.py

@@ -0,0 +1,41 @@
+from __future__ import annotations
+
+from datetime import datetime, timezone
+from pathlib import Path
+from typing import Any
+
+import toml
+
+from mooch.settings.utils import set_nested
+
+NOTICE_KEY = "metadata.notice"
+NOTICE = "This file was created by mooch.settings."
+CREATED_KEY = "metadata.created"
+UPDATED_KEY = "metadata.updated"
+
+
+class File:
+    def __init__(self, settings_filepath: Path) -> None:
+        self._filepath = settings_filepath
+        self.create_file_if_not_exists()
+
+    def create_file_if_not_exists(self) -> None:
+        """Create the settings file if it does not exist."""
+        if not self._filepath.exists():
+            data = {}
+            set_nested(data, NOTICE_KEY, NOTICE)
+            set_nested(data, CREATED_KEY, datetime.now(tz=timezone.utc).isoformat())
+            set_nested(data, UPDATED_KEY, datetime.now(tz=timezone.utc).isoformat())
+
+            self.save(data)
+
+    def load(self) -> dict[str, Any]:
+        """Load the settings from the file."""
+        with Path.open(self._filepath, mode="r", encoding="utf-8") as f:
+            return toml.load(f)
+
+    def save(self, data: dict) -> None:
+        """Save the settings to the file and update the updated timestamp."""
+        set_nested(data, UPDATED_KEY, datetime.now(tz=timezone.utc).isoformat())
+        with Path.open(self._filepath, mode="w", encoding="utf-8") as f:
+            toml.dump(data, f)

mooch/settings/settings.py

@@ -0,0 +1,76 @@
+from __future__ import annotations
+
+from pathlib import Path
+from typing import Any
+
+from mooch.settings.file import File
+from mooch.settings.utils import get_nested, set_nested
+
+
+class Settings:
+    def __init__(
+        self,
+        settings_filepath: Path,
+        default_settings: dict | None = None,
+    ) -> None:
+        self._file = File(settings_filepath)
+        self.dynamic_reload = True
+
+        self._data = self._file.load()
+
+        if default_settings:
+            self._set_defaults(default_settings)
+            self._file.save(self._data)
+
+    @staticmethod
+    def home_directory() -> Path:
+        """Return the path to the home directory.
+
+        Returns: Path
+        """
+        return Path.home()
+
+    def get(self, key: str) -> Any | None:  # noqa: ANN401
+        """Return a value from the configuration by key.
+
+        Args:
+        key (str): The key to return a value from.
+
+        Returns:
+        Any | None: The value associated with the key, or None if the key does not exist.
+
+        """
+        if self.dynamic_reload:
+            self._data = self._file.load()
+        return get_nested(self._data, key)
+
+    def set(self, key: str, value: Any) -> None:  # noqa: ANN401
+        """Set a value in the configuration by key.
+
+        Args:
+        key (str): The key to store the value under.
+        value (Any): The value to set for the key.
+
+        Returns:
+        None
+
+        """
+        set_nested(self._data, key, value)
+        self._file.save(self._data)
+
+    def __getitem__(self, key: str) -> Any | None:  # noqa: ANN401
+        """Get an item from the configuration by key."""
+        return self.get(key)
+
+    def __setitem__(self, key: str, value: Any) -> None:  # noqa: ANN401
+        """Set an item in the configuration by key."""
+        self.set(key, value)
+
+    def _set_defaults(self, d: dict, parent_key: str = "") -> None:
+        for k, v in d.items():
+            full_key = f"{parent_key}.{k}" if parent_key else k
+            if self.get(full_key) is None:
+                self.set(full_key, v)
+
+            elif isinstance(v, dict):
+                self._set_defaults(v, full_key)

mooch/settings/utils.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from typing import Any
+
+
+def set_nested(d: dict, key: str, value: Any, sep: str = ".") -> None:  # noqa: ANN401
+    """Set a nested value in a dictionary by key."""
+    keys = key.split(sep)
+    for k in keys[:-1]:
+        if k not in d or not isinstance(d[k], dict):
+            d[k] = {}
+        d = d[k]
+    d[keys[-1]] = value
+
+
+def get_nested(d: dict, key: str, sep: str = ".") -> Any | None:  # noqa: ANN401
+    """Get a nested value from a dictionary by key."""
+    keys = key.split(sep)
+    for k in keys:
+        if isinstance(d, dict) and k in d:
+            d = d[k]
+        else:
+            return None
+    return d

mooch_settings-0.0.1.dev1.dist-info/METADATA

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: mooch.settings
+Version: 0.0.1.dev1
+Summary: Python settings management package (mooch.settings). Uses a TOML file.
+Author-email: Nick Stuer <nickstuer@duck.com>
+Project-URL: Homepage, https://github.com/nickstuer/mooch.settings
+Project-URL: Issues, https://github.com/nickstuer/mooch.settings/issues
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: toml>=0.10.2
+Dynamic: license-file
+
+# Python mooch.settings
+
+![PyPI](https://img.shields.io/pypi/v/mooch.settings?label=mooch.settings)
+![PyPI - Downloads](https://img.shields.io/pypi/dm/mooch.settings)
+<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/nickstuer/mooch.settings">
+
+[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
+[![license](https://img.shields.io/github/license/nickstuer/mooch.settings.svg)](LICENSE)
+
+This Python package is a collection of useful Python code that is commonly used on all types of Python projects.
+
+## Table of Contents
+
+- [Features](https://github.com/nickstuer/mooch.settings?tab=readme-ov-file#-features)
+- [Install](https://github.com/nickstuer/mooch.settings?tab=readme-ov-file#-install)
+- [Usage](https://github.com/nickstuer/mooch.settings?tab=readme-ov-file#-usage)
+- [Contributing](https://github.com/nickstuer/mooch.settings?tab=readme-ov-file#-contributing)
+- [License](https://github.com/nickstuer/mooch.settings?tab=readme-ov-file#-license)
+
+## 📖 Features
+
+
+### Settings File
+Uses a TOML settings file. Easily get/set settingsuration values. Automatically sets values to defaults if they're not currently saved in the settingsuration file.
+
+
+## 🛠 Install
+
+```
+# PyPI
+pip install mooch.settings
+```
+or
+```
+uv add mooch.settings
+```
+
+##  📌 Dependencies
+Python 3.9 or greater
+
+## 🎮 Usage
+
+### settings File
+```python
+from mooch.settings import Settings
+default_settings = {
+    "settings": {
+        "name": "MyName,
+        "mood": "happy",
+    },
+}
+
+settings = Settings("settings.toml", default_settings)
+
+print(settings["settings.mood"])
+settings["settings.mood"] = "angry"
+print(settings["settings.mood"])
+```
+## 🏆 Contributing
+
+PRs accepted.
+
+If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
+
+#### Bug Reports and Feature Requests
+Please use the [issue tracker](https://github.com/nickstuer/mooch.settings/issues) to report any bugs or request new features.
+
+#### Contributors
+
+<a href = "https://github.com/nickstuer/mooch.settings/graphs/contributors">
+  <img src = "https://contrib.rocks/image?repo=nickstuer/mooch.settings"/>
+</a>
+
+## 📃 License
+
+[MIT © Nick Stuer](LICENSE)

mooch_settings-0.0.1.dev1.dist-info/RECORD

@@ -0,0 +1,10 @@
+mooch/__init__.py,sha256=_ZVUSDxucTCJe9q2wP1tI31qEX3m4QGcH7kn3BRv6ic,112
+mooch/settings/__init__.py,sha256=Vs0DYdXwvsEU21Umpj893RoX2iSrL7n4Qb-5X4GYtiI,69
+mooch/settings/file.py,sha256=aYwSe6PUhgZki9IF6mKsXVb3VkxEPVoQ2u8PzDoTAJY,1403
+mooch/settings/settings.py,sha256=fL229LnQjte7UP5_cMFaM1YnqKh7LLV8sgWJkgW18jk,2152
+mooch/settings/utils.py,sha256=V-aFKlrLaDfuJed4Yn-1pxlIM8jzdr4xRrNflBxLfXc,665
+mooch_settings-0.0.1.dev1.dist-info/licenses/LICENSE,sha256=FU8uKPcPjgV4M_aaYQPSM5abrktGqLFX2VEUk9oBYIE,1067
+mooch_settings-0.0.1.dev1.dist-info/METADATA,sha256=-K9SCr6DNS-IqsZvLlmUjp9fYRM6TwtR2pwmEGViwdU,2999
+mooch_settings-0.0.1.dev1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+mooch_settings-0.0.1.dev1.dist-info/top_level.txt,sha256=BbCxYfdneRNeyhPyAVvt8IEDA_Px7BIm5zhH6hEmsAo,6
+mooch_settings-0.0.1.dev1.dist-info/RECORD,,

mooch_settings-0.0.1.dev1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

mooch_settings-0.0.1.dev1.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Nick Stuer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mooch_settings-0.0.1.dev1.dist-info/top_level.txt

@@ -0,0 +1 @@
+mooch