Skip to main content

Manage local, encrypted credentials. The **dworshak* CLI leverages openssl, sqlite3, and cryptography.

Project description

Dworshak 🌊

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


Quick Start

# 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

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


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 .keyfile, avault.dbencrypted credential file, and aconfig.json` file for controlling defaults.

🚀 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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

dworshak-1.1.1.tar.gz (9.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dworshak-1.1.1-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file dworshak-1.1.1.tar.gz.

File metadata

  • Download URL: dworshak-1.1.1.tar.gz
  • Upload date:
  • Size: 9.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dworshak-1.1.1.tar.gz
Algorithm Hash digest
SHA256 3564b0d7cd06752cdf84f4164e01001d5c7e0841d5c9d90c137a66364c2dee47
MD5 e3afdfce63fcc2db37383e9faba70ea0
BLAKE2b-256 bfbd2b2b4320e127ea159de76291fa0491987ef921e2c76833fbd2e7e644f2e4

See more details on using hashes here.

Provenance

The following attestation bundles were made for dworshak-1.1.1.tar.gz:

Publisher: publish.yml on City-of-Memphis-Wastewater/dworshak

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file dworshak-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: dworshak-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for dworshak-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 50d61744e8c37f99b8735ceb3403787b2f1174b9ad0c48f6ee6149304d4f79e9
MD5 a7eac029629d4ba92b61cc6b7c4afb47
BLAKE2b-256 98bf1f8e0b22854742578e445ac253906b93d2dedf45da0823510f4aa912baaa

See more details on using hashes here.

Provenance

The following attestation bundles were made for dworshak-1.1.1-py3-none-any.whl:

Publisher: publish.yml on City-of-Memphis-Wastewater/dworshak

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page