Skip to content

EKGF/ekglib

Repository files navigation

ekglib

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

Badges

Build & Test License: MIT Python 3.13+ uv Linting & Formatting: ruff Type checking: mypy

Metadata Parsers

Capture Steps

Maturity Model Tools

Pipelines and Export

LDAP Variants

Storage and Data Access

Knowledge Graph and SPARQL Utilities

Core Utilities

Installation

ekglib is not yet published on PyPI. You can install it directly from GitHub.

Using uv from GitHub (recommended)

Add ekglib as a dependency from GitHub:

uv add --git https://github.com/EKGF/ekglib.git

You can then run the provided CLI tools via uv:

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

To install the CLI tools as global commands (similar to pipx):

uv tool install --git https://github.com/EKGF/ekglib.git

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

Using pip from GitHub

If you prefer to use pip, you can install from the GitHub repo:

python -m pip install "git+https://github.com/EKGF/ekglib.git"

The console scripts will then be available on your PATH:

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

Development setup (from source)

If you cloned this repository and want to work on ekglib itself:

uv sync

This will create and populate 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

Packages

No packages published

Contributors 6