Metadata-Version: 2.4
Name: dworshak
Version: 1.1.2
Summary: Manage local, encrypted credentials. The **dworshak* CLI leverages openssl, sqlite3, and cryptography.
Author-email: George Clayton Bennett <george.bennett@memphistn.gov>
Maintainer-email: George Clayton Bennett <george.bennett@memphistn.gov>
License-Expression: MIT
Project-URL: Homepage, https://github.com/city-of-memphis-wastewater/dworshak
Project-URL: Repository, https://github.com/city-of-memphis-wastewater/dworshak
Keywords: credentials,security
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Topic :: System :: Operating System
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Utilities
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: typer>=0.21.0
Requires-Dist: rich>=13.0.0
Requires-Dist: dworshak-access>=1.1.1
Requires-Dist: pyhabitat>=1.1.26
Requires-Dist: typer-helptree>=0.1.10
Provides-Extra: crypto
Requires-Dist: cryptography>=46.0.3; extra == "crypto"
Requires-Dist: dworshak-access[crypto]; extra == "crypto"
Dynamic: license-file

# Dworshak  🌊

**Dworshak** a cross-platform credential management solution.
It is a sister project of the `dworshak-access` library.

---

### Quick Start

```bash
# Install the CLI (for most environments)
pipx install "dworshak[crypto]"

# Bootstrap the security layer
dworshak setup

# Register your first API
dworshak store --service rjn_api --item username

```

---

`dworshak --help`:
![Screenshot of the dworshak CLI Tree Help](https://raw.githubusercontent.com/City-of-Memphis-Wastewater/dworshak/main/assets/dworshak_cli_v0.1.10_help.png)
<!---https://github.com/City-of-Memphis-Wastewater/dworshak/blob/main/assets/dworshak_cli_v0.1.10_help.png--->


See the Help Tree by unlocking the helptree CLI command, using the DEV_TYPER_HELP_TREE env var.

```
DEV_TYPER_HELP_TREE=1 dworshak helptree` # bash
$env:DEV_TYPER_HELP_TREE = "1"; dworshak helptree` # PowerShell
```

![Screenshot of the dworshak CLI Tree Help](https://raw.githubusercontent.com/City-of-Memphis-Wastewater/dworshak/main/assets/dworshak_cli_v0.1.10_help_tree.png)

---

## Sister Project: 
Library: `dworshak-access` 

GitHub: https://github.com/City-of-Memphis-Wastewater/dworshak-access 

PyPI: https://pypi.org/project/dworshak-access/ 

```
pip install dworshak-access
# or,  uv add dworshak-access
```

---

## 🏗  The Ultimate Vision
To become a stable credential management tool for scripting the flow of Emerson Ovation data and related APIs, supporting multiple projects in and beyond at the Maxson Wastewater Treatment Plant.
* **The Wider Goal:** A system where data is fetched, validated, and mirrored locally so that decision-support tools (Dashboards, Alarms) never have to "wait" on a slow external API.
* **The Method:** "Do one boring thing well." Use Industry-standard AES (Fernet) encryption  to manage a local `~/.dworshak/ directory which includes a `.key` file, a `vault.db` encrypted credential file, and a `config.json` file for controlling defaults.

<!--## ⚖️ User Stories-->

## 🚀 Attributes
- **Secure Vault:** Fernet-encrypted SQLite storage for API credentials.
- **Root of Trust:** A local `.key` file architecture that works identically on Windows and Termux.
- **CLI Entry:** A `typer`-based interface for setup and credential management.

---

## Termux installation

```
pkg install python-cryptography
pipx install dworshak --system-site-packages
```

## iSH Apline installation

```
apk add py3-cryptography 
pipx install dworshak --system-site-packages

```
