durability 1.0.0__tar.gz

durability-1.0.0/.github/workflows/python-publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    permissions:
+      id-token: write
+      contents: read
+
+    environment:
+      name: pypi
+      url: https://pypi.org/p/${{ github.event.repository.name }}
+
+    steps:
+    - name: Checkout source
+      uses: actions/checkout@v4
+
+    - name: Set up Python
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.13"
+
+    - name: Install build dependencies
+      run: python -m pip install build --user
+
+    - name: Build a binary wheel and a source tarball
+      run: python -m build
+
+    - name: Publish package distributions to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

durability-1.0.0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: durability
+Version: 1.0.0
+Summary: A Python persistance library.
+Author-email: Jack Huey <jhhuey@icloud.com>
+Project-URL: Repository, https://github.com/jackr4bbit/Durability
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# Durability
+## A tiny Python persistence library.
+
+---
+
+![PyPI Version](https://img.shields.io/pypi/v/durability?style=for-the-badge)
+
+
+## Installation
+
+```bash
+pip install durability
+```
+
+
+## Why
+I don't want to have to mess with state/data files. You have to read and write to them whenever you make a change, worry about different locations for them across platforms, and troubleshoot the system. This autosaves and uses the OS's existing dir for application data.
+
+## How to use
+Durability provides a `DataStore` object that may be passed the name of your project (so that files don't conflict). It will automatically use your script/lib's name if you don't provide one.  
+In "normal mode" each key of a `DataStore` is another file, but in "simple mode" (which you can use by setting the parameter `simple` to `True`) to get an interface where each key corresponds to a value in the same file. 
+
+Here's an example of using it in simple mode:
+```python
+from durability import DataStore
+
+store = DataStore("durability-example", simple = True)
+
+#If no existing count, set it to 0
+if "count" not in store:
+    store["count"] = 0
+
+#Increment and display it
+store["count"] += 1
+print(store["count"])
+
+#Automatically saves! No hassle necessary.
+```
+vs in normal mode:
+```python
+from durability import DataStore
+
+store = DataStore("durability-example")
+
+store["config"] = {"threads": 3, "username": "abc"}
+store["currentConnections"] = ["192.168.1.13", "100.90.116.124"]
+```

durability-1.0.0/README.md

@@ -0,0 +1,47 @@
+# Durability
+## A tiny Python persistence library.
+
+---
+
+![PyPI Version](https://img.shields.io/pypi/v/durability?style=for-the-badge)
+
+
+## Installation
+
+```bash
+pip install durability
+```
+
+
+## Why
+I don't want to have to mess with state/data files. You have to read and write to them whenever you make a change, worry about different locations for them across platforms, and troubleshoot the system. This autosaves and uses the OS's existing dir for application data.
+
+## How to use
+Durability provides a `DataStore` object that may be passed the name of your project (so that files don't conflict). It will automatically use your script/lib's name if you don't provide one.  
+In "normal mode" each key of a `DataStore` is another file, but in "simple mode" (which you can use by setting the parameter `simple` to `True`) to get an interface where each key corresponds to a value in the same file. 
+
+Here's an example of using it in simple mode:
+```python
+from durability import DataStore
+
+store = DataStore("durability-example", simple = True)
+
+#If no existing count, set it to 0
+if "count" not in store:
+    store["count"] = 0
+
+#Increment and display it
+store["count"] += 1
+print(store["count"])
+
+#Automatically saves! No hassle necessary.
+```
+vs in normal mode:
+```python
+from durability import DataStore
+
+store = DataStore("durability-example")
+
+store["config"] = {"threads": 3, "username": "abc"}
+store["currentConnections"] = ["192.168.1.13", "100.90.116.124"]
+```

durability-1.0.0/example.py

@@ -0,0 +1,9 @@
+from durability import DataStore
+
+store = DataStore("durability-example", simple = True)
+
+if "count" not in store:
+    store["count"] = 0
+
+store["count"] += 1
+print(store["count"])

durability-1.0.0/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools>=61.0", "setuptools_scm[toml]>=8.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "durability"
+dynamic = ["version"]
+description = "A Python persistance library."
+readme = "README.md"
+requires-python = ">=3.14"
+authors = [
+    { name = "Jack Huey", email = "jhhuey@icloud.com" }
+]
+dependencies = []
+
+[project.urls]
+Repository = "https://github.com/jackr4bbit/Durability"
+
+[tool.setuptools]
+packages.find = { where = ["src"] }
+
+[tool.setuptools_scm]

durability-1.0.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

durability-1.0.0/src/durability/__init__.py

@@ -0,0 +1,59 @@
+from .utils import useVar, toStr
+from . import platforms
+import inspect
+import json
+from pathlib import Path
+
+for frameInfo in inspect.stack():
+    module = frameInfo.frame.f_globals.get("__name__")
+    if module and module != __name__ and not module.startswith("importlib"):
+        if module == "__main__":
+            importing = Path(frameInfo.filename).stem
+        else:
+            importing = str(module)
+        break
+else:
+    importing = ""
+
+type JSON = dict[str, JSON] | list[JSON] | str | int | float | bool | None
+
+class DataStore:
+    def __init__(self, name: str = importing, simple: bool = False):
+        if name == "":
+            print("The name of your script/lib could not be detected. Please specify one.")
+        if "/" in name or "." in name:
+            raise ValueError("Unallowed characters in name")
+        self.name = name
+
+        self.__path = platforms.path / toStr(useVar(platforms.standard, name))
+        if not simple:
+            self.__path.mkdir(parents=False, exist_ok=True)
+
+        self.__data = {}
+        self.__simple = simple
+
+    def __setitem__(self, key: str, value: JSON):
+        self.__data[key] = value
+
+        if self.__simple: self.__path.write_text(json.dumps(self.__data))
+        else: (self.__path / f"{key}.json").write_text(json.dumps(value))
+
+    def __contains__(self, key: str) -> bool:
+        self.__getitem__(key)
+        return key in self.__data
+
+    def __getitem__(self, key: str):
+        path = self.__path if self.__simple else self.__path / f"{key}.json"
+
+        if key not in self.__data:
+            try:
+                data = json.loads(path.read_text(encoding="utf-8"))
+            except FileNotFoundError:
+                return None
+
+            if self.__simple:
+                self.__data = data
+            else:
+                self.__data[key] = data
+
+        return self.__data.get(key)

durability-1.0.0/src/durability/_linux.py

@@ -0,0 +1,9 @@
+import os
+from pathlib import Path
+
+if os.geteuid() == 0:
+    path = Path("/var/lib")
+else:
+    path = Path.home() / ".config"
+
+standard = t"{"default"}-durability"

durability-1.0.0/src/durability/_mac.py

@@ -0,0 +1,6 @@
+import os
+from pathlib import Path
+
+root = os.geteuid() == 0
+path = (Path("/") if root else Path.home()) / "Library" / "Application Support"
+standard = t"py.durability.{"default"}"

durability-1.0.0/src/durability/_win.py

@@ -0,0 +1,9 @@
+import ctypes
+from pathlib import Path
+
+if ctypes.windll.shell32.IsUserAnAdmin() != 0:
+    path = Path.cwd().anchor / "ProgramData"
+else:
+    path = Path.home() / "AppData" / "Roaming"
+
+standard = t"durability/{"default"}"

durability-1.0.0/src/durability/platforms.py

@@ -0,0 +1,12 @@
+import sys
+from pathlib import Path
+from string.templatelib import Template
+
+match sys.platform:
+    case "darwin": from ._mac import path, standard
+    case "win32": from ._win import path, standard
+    case os if os.startswith("linux"): from ._linux import path, standard
+    case _: raise OSError(f"Unsupported operating system: {sys.platform}")
+
+path: Path = path
+standard: Template = standard

durability-1.0.0/src/durability/utils.py

@@ -0,0 +1,20 @@
+from string.templatelib import Template, Interpolation
+
+def useVar(template: Template, newValue: str) -> Template:
+    parts = []
+    for item in template:
+        if isinstance(item, Interpolation):
+            parts.append(Interpolation(newValue, item.expression, item.conversion, item.format_spec))
+        else:
+            parts.append(item)
+
+    return Template(*parts)
+
+def toStr(template: Template) -> str:
+    result = []
+    for i, segment in enumerate(template.strings):
+        result.append(segment)
+        if i < len(template.values):
+            result.append(str(template.values[i]))
+
+    return "".join(result)

durability-1.0.0/src/durability.egg-info/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: durability
+Version: 1.0.0
+Summary: A Python persistance library.
+Author-email: Jack Huey <jhhuey@icloud.com>
+Project-URL: Repository, https://github.com/jackr4bbit/Durability
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# Durability
+## A tiny Python persistence library.
+
+---
+
+![PyPI Version](https://img.shields.io/pypi/v/durability?style=for-the-badge)
+
+
+## Installation
+
+```bash
+pip install durability
+```
+
+
+## Why
+I don't want to have to mess with state/data files. You have to read and write to them whenever you make a change, worry about different locations for them across platforms, and troubleshoot the system. This autosaves and uses the OS's existing dir for application data.
+
+## How to use
+Durability provides a `DataStore` object that may be passed the name of your project (so that files don't conflict). It will automatically use your script/lib's name if you don't provide one.  
+In "normal mode" each key of a `DataStore` is another file, but in "simple mode" (which you can use by setting the parameter `simple` to `True`) to get an interface where each key corresponds to a value in the same file. 
+
+Here's an example of using it in simple mode:
+```python
+from durability import DataStore
+
+store = DataStore("durability-example", simple = True)
+
+#If no existing count, set it to 0
+if "count" not in store:
+    store["count"] = 0
+
+#Increment and display it
+store["count"] += 1
+print(store["count"])
+
+#Automatically saves! No hassle necessary.
+```
+vs in normal mode:
+```python
+from durability import DataStore
+
+store = DataStore("durability-example")
+
+store["config"] = {"threads": 3, "username": "abc"}
+store["currentConnections"] = ["192.168.1.13", "100.90.116.124"]
+```

durability-1.0.0/src/durability.egg-info/SOURCES.txt

@@ -0,0 +1,16 @@
+README.md
+example.py
+pyproject.toml
+.github/workflows/python-publish.yml
+src/durability/__init__.py
+src/durability/_linux.py
+src/durability/_mac.py
+src/durability/_win.py
+src/durability/platforms.py
+src/durability/utils.py
+src/durability.egg-info/PKG-INFO
+src/durability.egg-info/SOURCES.txt
+src/durability.egg-info/dependency_links.txt
+src/durability.egg-info/scm_file_list.json
+src/durability.egg-info/scm_version.json
+src/durability.egg-info/top_level.txt

durability-1.0.0/src/durability.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

durability-1.0.0/src/durability.egg-info/scm_file_list.json

@@ -0,0 +1,14 @@
+{
+  "files": [
+    ".github/workflows/python-publish.yml",
+    "README.md",
+    "example.py",
+    "pyproject.toml",
+    "src/durability/__init__.py",
+    "src/durability/_linux.py",
+    "src/durability/_mac.py",
+    "src/durability/_win.py",
+    "src/durability/platforms.py",
+    "src/durability/utils.py"
+  ]
+}

durability-1.0.0/src/durability.egg-info/scm_version.json

@@ -0,0 +1,8 @@
+{
+  "tag": "1.0.0",
+  "distance": 0,
+  "node": "g08f4d057c819e17b2da6dd82f144d4973b902c90",
+  "dirty": false,
+  "branch": "HEAD",
+  "node_date": "2026-10-09"
+}

durability-1.0.0/src/durability.egg-info/top_level.txt

@@ -0,0 +1 @@
+durability