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

🏗 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 OpenSSL to manage a local ~/.dowrshak/ 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-0.1.18.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-0.1.18-py3-none-any.whl (9.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dworshak-0.1.18.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-0.1.18.tar.gz
Algorithm Hash digest
SHA256 983a2bfc0fc4bada9e800af0ada96303986b15959a859f5a0ca0e1c9bdb0fd8b
MD5 eada93e3ef4b253a47ec921a231c7a99
BLAKE2b-256 762b42edef695bb53a91820d0506c924041323565a0c032c0963873cf2d1cd18

See more details on using hashes here.

Provenance

The following attestation bundles were made for dworshak-0.1.18.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-0.1.18-py3-none-any.whl.

File metadata

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

File hashes

Hashes for dworshak-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 ed93a9e3a9411c877fd5bdc31bc426377b2b3ba5d1bc15a15511222e5aaa7e0a
MD5 aa25c4403944b5bbd57b7e51e5c10bf1
BLAKE2b-256 e7d9a1c131d57189bf1fb00cc5219ef2eb5286ecf5864582f6d0d03a4289b039

See more details on using hashes here.

Provenance

The following attestation bundles were made for dworshak-0.1.18-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