Skip to main content

**dworshak-access** is a light-weight library for local credential access. It exposes the **get_secret()** function, to allow a program to leverage credentials that have been established using the Drowshak CLI tool, which is a separate package.

Project description

dworshak-access is a light-weight library for local credential access. By adding dworshak-access as a dependency to your Python project, you enable your program or script to leverage credentials that have been established using the Drowshak CLI tool, which is a separate package.

Functions exposed in dworshak-access:

  • initialize_vault() – Create the vault directory, encryption key, and SQLite database. Safe to call multiple times.
  • check_vault() – Check the health of the vault (directory, key, DB).
  • store_secret(service: str, item: str, plaintext: str) – Encrypt and store a credential in the vault.
  • get_secret(service: str, item: str) -> str – Retrieve and decrypt a credential.
  • list_credentials() -> list[tuple[str, str]] – List all stored service/item pairs.

All secrets are stored Fernet-encrypted in the database under the secret column. No opaque blobs — every entry is meaningful and decryptable via the library.

Example

uv add dworshak-access
from dworshak_access import initialize_vault, store_secret, get_secret, list_credentials

# Initialize the vault (create key and DB if missing)
initialize_vault()

# Store credentials
store_secret("rjn_api", "username", "admin")
store_secret("rjn_api", "password", "s3cr3t")

# Retrieve credentials
username = get_secret("rjn_api", "username")
password = get_secret("rjn_api", "password")

# List stored items
for service, item in list_credentials():
    print(f"{service}/{item}")

Cryptography Library (When Building dworshak-access From Source or When Using It A Dependency in Your Project)

The only external Python library used is crytography, for the Fernet class.

On a Termux system, cryptography can (A) be built from source or (B) the precompiled python-crytography dedicated Termux package can be used.

A. Allow cryptography to build from source (uv is better at this compared to using pip)

pkg install rust binutils
uv sync

B. Use python-cryptography (This is faster but pollutes your local venv with other system site packages.)

pkg install python-cryptography
uv venv --system-site-packages
uv sync

uv venv --system-site-packages is a modern,faster alternative to python -m venv .venv --system-site-packages. Because uv manages the build-time dependencies (setuptools-rust and cffi) in an isolated environment and coordinates the hand-off to the Rust compiler more robustly than pip, it is the recommended way to install cryptography from source on Termux.


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_access-0.1.18.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

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

dworshak_access-0.1.18-py3-none-any.whl (5.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for dworshak_access-0.1.18.tar.gz
Algorithm Hash digest
SHA256 f19a3500abdff868ea4f5fbc6da8f634343d4c19a886dcad42ff1ed05a4ea0f0
MD5 30bc594946c0d91c78520c403ce6d49c
BLAKE2b-256 4457551a21a6539ef8ed9d25bed7aab3e331a13518faa1e4ee7e157ab3ff0d5d

See more details on using hashes here.

Provenance

The following attestation bundles were made for dworshak_access-0.1.18.tar.gz:

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

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_access-0.1.18-py3-none-any.whl.

File metadata

File hashes

Hashes for dworshak_access-0.1.18-py3-none-any.whl
Algorithm Hash digest
SHA256 7ce705a796895225f4b692f57a9242b35bec5f46a7a6214aa67565c2c043e062
MD5 abe4abb771639c30c7c6f481f020e05d
BLAKE2b-256 4a11cc35980cbdb7722251612fbc0b240a9819d83573e53d228707c40a4f6b63

See more details on using hashes here.

Provenance

The following attestation bundles were made for dworshak_access-0.1.18-py3-none-any.whl:

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

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