dworshak-access 0.1.4__tar.gz

dworshak_access-0.1.4/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.4/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: dworshak-access
+Version: 0.1.4
+Summary: **dworshak-access** is a lightweight library. It exposes the **get_secrets()** 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.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=46.0.3
+Dynamic: license-file
+
+**dworshak-access** is a lightweight library. 
+
+## Purpose
+Allow a program 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_credential() # The meat and potatoes.
+
+
+### Example
+
+```python
+from dworshak_access import get_credential
+
+service_name = "MyThirdFavoriteAPI"
+item_id_u = "username"
+item_id_p = "password"
+
+user = get_credential(service_name,item_id_u)
+pass = get_credential(service_name,item_id_p)
+
+# Then use these in your program
+
+```
+
+---
+
+## Cryptography Library
+
+The only external Python library used is crytography, for the Fernet class.
+
+On a Termux system, cryptography can be built from source if the user first installs Rust with `pkg install rust`.
+Is `uv sync` better at accomplishing this, due to the rust packagig location? Argue and let me know.
+Alteratively, a Termux user can run `pkg install python-crytophy`, then build a fresh venv folder using the --system-site-packages flag to include the now system-wide crytography package. Or maybe you don't need a venv at all. Hm.

dworshak_access-0.1.4/README.md

@@ -0,0 +1,35 @@
+**dworshak-access** is a lightweight library. 
+
+## Purpose
+Allow a program 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_credential() # The meat and potatoes.
+
+
+### Example
+
+```python
+from dworshak_access import get_credential
+
+service_name = "MyThirdFavoriteAPI"
+item_id_u = "username"
+item_id_p = "password"
+
+user = get_credential(service_name,item_id_u)
+pass = get_credential(service_name,item_id_p)
+
+# Then use these in your program
+
+```
+
+---
+
+## Cryptography Library
+
+The only external Python library used is crytography, for the Fernet class.
+
+On a Termux system, cryptography can be built from source if the user first installs Rust with `pkg install rust`.
+Is `uv sync` better at accomplishing this, due to the rust packagig location? Argue and let me know.
+Alteratively, a Termux user can run `pkg install python-crytophy`, then build a fresh venv folder using the --system-site-packages flag to include the now system-wide crytography package. Or maybe you don't need a venv at all. Hm.

dworshak_access-0.1.4/pyproject.toml

@@ -0,0 +1,19 @@
+[project]
+name = "dworshak-access"
+version = "0.1.4"
+description = "**dworshak-access** is a lightweight library. It exposes the **get_secrets()** 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.12"
+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"

dworshak_access-0.1.4/setup.cfg

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

dworshak_access-0.1.4/src/dworshak_access/__init__.py

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

dworshak_access-0.1.4/src/dworshak_access/vault.py

@@ -0,0 +1,52 @@
+# src/dworshak-access/vault.py
+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:
+        cursor = conn.execute(
+            "SELECT secret FROM credentials WHERE service = ? AND item = ?",
+            (service, item)
+        )
+        row = cursor.fetchone()
+
+    if not row:
+        raise KeyError(f"No credential found for {service}/{item}")
+
+    return fernet.decrypt(row[0]).decode()

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

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: dworshak-access
+Version: 0.1.4
+Summary: **dworshak-access** is a lightweight library. It exposes the **get_secrets()** 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.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=46.0.3
+Dynamic: license-file
+
+**dworshak-access** is a lightweight library. 
+
+## Purpose
+Allow a program 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_credential() # The meat and potatoes.
+
+
+### Example
+
+```python
+from dworshak_access import get_credential
+
+service_name = "MyThirdFavoriteAPI"
+item_id_u = "username"
+item_id_p = "password"
+
+user = get_credential(service_name,item_id_u)
+pass = get_credential(service_name,item_id_p)
+
+# Then use these in your program
+
+```
+
+---
+
+## Cryptography Library
+
+The only external Python library used is crytography, for the Fernet class.
+
+On a Termux system, cryptography can be built from source if the user first installs Rust with `pkg install rust`.
+Is `uv sync` better at accomplishing this, due to the rust packagig location? Argue and let me know.
+Alteratively, a Termux user can run `pkg install python-crytophy`, then build a fresh venv folder using the --system-site-packages flag to include the now system-wide crytography package. Or maybe you don't need a venv at all. Hm.

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

@@ -0,0 +1,10 @@
+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

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

@@ -0,0 +1 @@
+

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

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

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

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