dworshak-access 0.1.11__tar.gz

dworshak_access-0.1.11/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 George Clayton Bennett <https://github.com/City-of-Memphis-Wastewater/dworshak-access/>
+
+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.

dworshak_access-0.1.11/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: dworshak-access
+Version: 0.1.11
+Summary: **dworshak-access** is a light-weight library for local credential access. It exposes the **get_secret()** function, to allow a program to leverage credentials that have been established using the Drowshak CLI tool, which is a separate package.
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=46.0.3
+Dynamic: license-file
+
+**dworshak-access** is a light-weight library for local credential access. By adding **dworshak-access** as a dependency to your Python project, you enable your program or script to leverage credentials that have been established using the Drowshak CLI tool, which is a separate package.
+
+## Functions exposed in **dworshak-access**:
+- check_vault() # For troubleshooting automated testing.
+- get_secret() # The meat and potatoes.
+
+
+### Example
+
+```zsh
+uv add dworshak-access
+```
+
+```python
+from dworshak_access import get_secret
+
+service_name = "MyThirdFavoriteAPI"
+item_id_u = "username"
+item_id_p = "password"
+
+un = get_secret(service_name,item_id_u)
+pw = get_secret(service_name,item_id_p)
+
+# Then use these in your program
+
+```
+
+---
+
+## Cryptography Library (When Building **dworshak-access** From Source or When Using It A Dependency in Your Project)
+
+The only external Python library used is `crytography`, for the **Fernet** class.
+
+On a Termux system, cryptography can **(A)** be built from source or **(B)** the precompiled python-crytography dedicated Termux package can be used.
+
+#### A. Allow cryptography to build from source (uv is better at this compared to using pip)
+
+```zsh
+pkg install rust binutils
+uv sync
+```
+
+#### B. Use python-cryptography (This is faster but pollutes your local venv with other system site packages.)
+
+```zsh
+pkg install python-cryptography
+uv venv --system-site-packages
+uv sync
+```
+
+`uv venv --system-site-packages` is a modern,faster alternative to `python -m venv .venv --system-site-packages`.
+Because **uv** manages the build-time dependencies (**setuptools-rust** and **cffi**) in an isolated environment and coordinates the hand-off to the Rust compiler more robustly than **pip**, it is the recommended way to install **cryptography** from source on Termux.
+
+---

dworshak_access-0.1.11/README.md

@@ -0,0 +1,54 @@
+**dworshak-access** is a light-weight library for local credential access. By adding **dworshak-access** as a dependency to your Python project, you enable your program or script to leverage credentials that have been established using the Drowshak CLI tool, which is a separate package.
+
+## Functions exposed in **dworshak-access**:
+- check_vault() # For troubleshooting automated testing.
+- get_secret() # The meat and potatoes.
+
+
+### Example
+
+```zsh
+uv add dworshak-access
+```
+
+```python
+from dworshak_access import get_secret
+
+service_name = "MyThirdFavoriteAPI"
+item_id_u = "username"
+item_id_p = "password"
+
+un = get_secret(service_name,item_id_u)
+pw = get_secret(service_name,item_id_p)
+
+# Then use these in your program
+
+```
+
+---
+
+## Cryptography Library (When Building **dworshak-access** From Source or When Using It A Dependency in Your Project)
+
+The only external Python library used is `crytography`, for the **Fernet** class.
+
+On a Termux system, cryptography can **(A)** be built from source or **(B)** the precompiled python-crytography dedicated Termux package can be used.
+
+#### A. Allow cryptography to build from source (uv is better at this compared to using pip)
+
+```zsh
+pkg install rust binutils
+uv sync
+```
+
+#### B. Use python-cryptography (This is faster but pollutes your local venv with other system site packages.)
+
+```zsh
+pkg install python-cryptography
+uv venv --system-site-packages
+uv sync
+```
+
+`uv venv --system-site-packages` is a modern,faster alternative to `python -m venv .venv --system-site-packages`.
+Because **uv** manages the build-time dependencies (**setuptools-rust** and **cffi**) in an isolated environment and coordinates the hand-off to the Rust compiler more robustly than **pip**, it is the recommended way to install **cryptography** from source on Termux.
+
+---

dworshak_access-0.1.11/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "dworshak-access"
+version = "0.1.11"
+description = "**dworshak-access** is a light-weight library for local credential access. It exposes the **get_secret()** function, to allow a program to leverage credentials that have been established using the Drowshak CLI tool, which is a separate package."
+readme = "README.md"
+requires-python = ">=3.9"
+dependencies = [
+    "cryptography>=46.0.3",
+]
+
+[tool.uv]
+# This tells uv that if it can't find a wheel for aarch64,
+# it is allowed to build from source using your local Rust/Clang.
+package = true
+resolution = "highest"
+
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[dependency-groups]
+dev = [
+    "pytest>=8.4.2",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]

dworshak_access-0.1.11/setup.cfg

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

dworshak_access-0.1.11/src/dworshak_access/__init__.py

@@ -0,0 +1,9 @@
+# src/dowrshak_access/__init__.py
+from __future__ import annotations
+from dworshak_access.vault import get_secret, check_vault
+
+__all__ = [
+    "get_secret",
+    "check_vault"
+]
+

dworshak_access-0.1.11/src/dworshak_access/vault.py

@@ -0,0 +1,58 @@
+# src/dworshak-access/vault.py
+from __future__ import annotations
+import sqlite3
+import os
+from pathlib import Path
+from typing import NamedTuple, List, Tuple, Optional
+from cryptography.fernet import Fernet
+
+DEFAULT_ROOT = Path.home() / ".dworshak"
+
+class VaultStatus(NamedTuple):
+    is_valid: bool
+    message: str
+    root_path: Path
+
+def check_vault(root: Path = DEFAULT_ROOT) -> VaultStatus:
+    """Diagnose the health of the Dworshak environment."""
+    if not root.exists():
+        return VaultStatus(False, "Vault directory does not exist.", root)
+    if not (root / ".key").exists():
+        return VaultStatus(False, "Security key (.key) is missing.", root)
+    if not (root / "vault.db").exists():
+        return VaultStatus(False, "Credential database (vault.db) is missing.", root)
+    
+    try:
+        with sqlite3.connect(root / "vault.db") as conn:
+            conn.execute("SELECT 1 FROM credentials LIMIT 1")
+    except sqlite3.Error as e:
+        return VaultStatus(False, f"Database error: {e}", root)
+        
+    return VaultStatus(True, "Vault is healthy.", root)
+
+def get_secret(service: str, item: str, root: Path = DEFAULT_ROOT) -> str:
+    """Retrieve and decrypt a specific secret."""
+    key_path = root / ".key"
+    db_path = root / "vault.db"
+
+    if not key_path.exists():
+        raise FileNotFoundError(f"Dworshak key not found at {key_path}")
+
+    fernet = Fernet(key_path.read_bytes())
+
+    with sqlite3.connect(db_path) as conn:
+        try:
+            cursor = conn.execute(
+                "SELECT secret FROM credentials WHERE service = ? AND item = ?",
+                (service, item)
+            )
+            row = cursor.fetchone()
+        except sqlite3.OperationalError as e:
+            raise RuntimeError(f"Database schema mismatch: {e}")
+
+    if not row:
+        raise KeyError(f"No credential found for {service}/{item}")
+
+    return fernet.decrypt(row[0]).decode()
+
+

dworshak_access-0.1.11/src/dworshak_access.egg-info/PKG-INFO

@@ -0,0 +1,64 @@
+Metadata-Version: 2.4
+Name: dworshak-access
+Version: 0.1.11
+Summary: **dworshak-access** is a light-weight library for local credential access. It exposes the **get_secret()** function, to allow a program to leverage credentials that have been established using the Drowshak CLI tool, which is a separate package.
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=46.0.3
+Dynamic: license-file
+
+**dworshak-access** is a light-weight library for local credential access. By adding **dworshak-access** as a dependency to your Python project, you enable your program or script to leverage credentials that have been established using the Drowshak CLI tool, which is a separate package.
+
+## Functions exposed in **dworshak-access**:
+- check_vault() # For troubleshooting automated testing.
+- get_secret() # The meat and potatoes.
+
+
+### Example
+
+```zsh
+uv add dworshak-access
+```
+
+```python
+from dworshak_access import get_secret
+
+service_name = "MyThirdFavoriteAPI"
+item_id_u = "username"
+item_id_p = "password"
+
+un = get_secret(service_name,item_id_u)
+pw = get_secret(service_name,item_id_p)
+
+# Then use these in your program
+
+```
+
+---
+
+## Cryptography Library (When Building **dworshak-access** From Source or When Using It A Dependency in Your Project)
+
+The only external Python library used is `crytography`, for the **Fernet** class.
+
+On a Termux system, cryptography can **(A)** be built from source or **(B)** the precompiled python-crytography dedicated Termux package can be used.
+
+#### A. Allow cryptography to build from source (uv is better at this compared to using pip)
+
+```zsh
+pkg install rust binutils
+uv sync
+```
+
+#### B. Use python-cryptography (This is faster but pollutes your local venv with other system site packages.)
+
+```zsh
+pkg install python-cryptography
+uv venv --system-site-packages
+uv sync
+```
+
+`uv venv --system-site-packages` is a modern,faster alternative to `python -m venv .venv --system-site-packages`.
+Because **uv** manages the build-time dependencies (**setuptools-rust** and **cffi**) in an isolated environment and coordinates the hand-off to the Rust compiler more robustly than **pip**, it is the recommended way to install **cryptography** from source on Termux.
+
+---

dworshak_access-0.1.11/src/dworshak_access.egg-info/SOURCES.txt

@@ -0,0 +1,12 @@
+LICENSE
+README.md
+pyproject.toml
+src/dworshak_access/__init__.py
+src/dworshak_access/vault.py
+src/dworshak_access.egg-info/PKG-INFO
+src/dworshak_access.egg-info/SOURCES.txt
+src/dworshak_access.egg-info/dependency_links.txt
+src/dworshak_access.egg-info/requires.txt
+src/dworshak_access.egg-info/top_level.txt
+tests/test_check_vault.py
+tests/test_get_secret.py

dworshak_access-0.1.11/src/dworshak_access.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dworshak_access-0.1.11/src/dworshak_access.egg-info/requires.txt

@@ -0,0 +1 @@
+cryptography>=46.0.3

dworshak_access-0.1.11/src/dworshak_access.egg-info/top_level.txt

@@ -0,0 +1 @@
+dworshak_access

dworshak_access-0.1.11/tests/test_check_vault.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+from pathlib import Path
+from dworshak_access.vault import check_vault
+
+def test_check_vault_reports_missing_dir(tmp_path):
+    """
+    If the folder doesn't exist, check_vault should 
+    return a valid status object indicating it's missing.
+    """
+    # Point to a directory we know doesn't exist
+    fake_path = tmp_path / "non_existent_vault"
+    
+    status = check_vault(root=fake_path)
+    
+    # We don't want a crash/exception; we want a 'False' status
+    assert status.is_valid is False
+    assert "does not exist" in status.message
+    assert status.root_path == fake_path

dworshak_access-0.1.11/tests/test_get_secret.py

@@ -0,0 +1,27 @@
+from __future__ import annotations
+import pytest
+from unittest.mock import patch, MagicMock, mock_open
+from dworshak_access.vault import get_secret
+
+@patch("dworshak_access.vault.Fernet")
+@patch("sqlite3.connect")
+@patch("pathlib.Path.exists", return_value=True)
+@patch("pathlib.Path.read_bytes", return_value=b"fake-key-bytes")
+def test_get_secret_logic(mock_read, mock_exists, mock_connect, mock_fernet):
+    # 1. Setup the Mock Database Response
+    mock_conn = MagicMock()
+    mock_cursor = MagicMock()
+    # Simulate the DB returning an encrypted blob
+    mock_cursor.fetchone.return_value = (b"encrypted-blob",)
+    mock_conn.execute.return_value = mock_cursor
+    mock_connect.return_value.__enter__.return_value = mock_conn
+
+    # 2. Setup the Mock Decryption
+    mock_fernet_instance = mock_fernet.return_value
+    mock_fernet_instance.decrypt.return_value = b"decrypted-password"
+
+    # 3. Execution
+    result = get_secret("service", "item")
+
+    # 4. Assertion
+    assert result == "decrypted-password"