ekg-lib

A Python Library for various tasks in an EKG DataOps operation.

Badges

Metadata Parsers

• Concept Parser
• Persona Parser
• Story Validate Rule Parser
• Story Validate Rules Capture
• Story Validate Rules Executor
• Use Case Parser
• User Story Parser

Capture Steps

• Xlsx Parser
• LDAP Parser

Maturity Model Tools

• Maturity Model Parser

Pipelines and Export

• Pipeline Framework
• Step Export

LDAP Variants

• LDAP Parser to File
• LDAP Parser to S3

Storage and Data Access

• S3 Helpers
• Data Sources
• Datasets

Knowledge Graph and SPARQL Utilities

• KG IRI Utilities
• SPARQL Helpers
• Namespaces
• Ontologies and Resources

Core Utilities

• Logging Utilities
• String Utilities
• Git Utilities
• Exceptions
• MIME Helpers
• Main CLI Entrypoint

Installation

From PyPI (recommended)

pip install ekg-lib

Or using uv:

uv add ekg-lib

From GitHub

Add ekg-lib as a dependency from GitHub:

uv add --git https://github.com/EKGF/ekg-lib.git

Or using pip:

pip install "git+https://github.com/EKGF/ekg-lib.git"

CLI tools

After installation, the following CLI tools are available:

xlsx-parser --help
user-story-parser --help
pipeline-example --help

To install as global commands using uv:

uv tool install ekg-lib

Environment variables

ekg-lib uses dotenvage to load environment variables from .env files with optional age encryption of sensitive values.

All CLI entry points (xlsx-parser, user-story-parser, pipeline-example) call load_env() at startup, which discovers and loads .env* files before any os.getenv() calls.

To use encrypted secrets:

# Install the dotenvage CLI
cargo binstall dotenvage

# Generate an age key (stored in ~/.local/state/)
dotenvage keygen

# Encrypt sensitive values in your .env file
dotenvage encrypt .env.local

Encrypted values are safe to commit to version control. See the dotenvage documentation for details on file layering, key management, and CI/CD integration.

Development setup (from source)

If you cloned this repository and want to work on ekg-lib itself:

uv sync

This creates a virtual environment using uv based on pyproject.toml.

Tests

To run all tests:

uv run pytest

To run a single test:

uv run pytest tests/<path-to-test> -k <name-of-test>

Packaging

uv build