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.

dworshak helptree

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 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.

🚀 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.

Typical installation

pipx install "dworshak[crypto]"

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.13.tar.gz (8.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.13-py3-none-any.whl (8.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: dworshak-1.1.13.tar.gz
  • Upload date:
  • Size: 8.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.13.tar.gz
Algorithm Hash digest
SHA256 0639bb5de28d2c1e982639c1e8adde561d3b430e1d0ae5569320cadc648afb69
MD5 0696d28bfd6a6e63393bc9016f434936
BLAKE2b-256 a875c70c345bac65a1448c0f22aa19b95df980f8d86c1bc667dca6422269ef3a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: dworshak-1.1.13-py3-none-any.whl
  • Upload date:
  • Size: 8.2 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 d99341350b70d297855b6874825f500e32e58069002078d3d0547194344afb18
MD5 c00b13c9b92e5eca95bdc786c98605db
BLAKE2b-256 316be634592274ffeb634a039682af9efd932aac8eb7c50a3157922fe293bf5c

See more details on using hashes here.

Provenance

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