From acbcfb091560f9dc81b34ec160e219f6258f1185 Mon Sep 17 00:00:00 2001 From: dx4iot Date: Sat, 14 Mar 2026 22:32:13 +0530 Subject: [PATCH 1/2] docs: README wording, grammar, and formatting improvements --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 3ee69bb..8d9509e 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ DataHelm is a data engineering framework focused on: - source ingestion and orchestration - dbt transformation workflows - notebook-based dashboard execution -- reusable provider connectors (SharePoint, GCS, S3, BigQuery) +- reusable provider connectors (SharePoint, GCS, S3, and BigQuery) - optional local LLM analytics query scaffolding ![DataHelm Architecture](https://github.com/DevStrikerTech/datahelm/blob/master/docs/architecture.png?raw=true) @@ -13,15 +13,15 @@ DataHelm is a data engineering framework focused on: ## Core Capabilities - **Config-driven ingestion** using YAML in `config/api/` -- **Dagster orchestration** for jobs, schedules, and sensors -- **dbt project execution** through `analytics/dbt_runner.py` and dbt configs +- **Dagster orchestration** for managing jobs, schedules, and sensors +- **dbt project execution** through `analytics/dbt_runner.py` and dbt configuration files - **Dashboard generation** with Dagstermill notebooks - **Reusable handlers/connectors** for multiple external providers - **Optional NL-to-SQL module** (`analytics/nl_query/`) for local Ollama-based analytics workflows ## High-Level Architecture -The repository follows layered responsibilities: +The repository follows a layered responsibility structure: - `handlers/`: provider-specific source connectors and API handlers - `ingestion/`: ingestion factory + native ingestion implementations @@ -74,7 +74,7 @@ pip install -e . ### Environment Variables -Create a `.env` file in repository root with required values, for example: +Create a `.env` file in the repository root with the required values, for example: ```env DB_HOST=${DB_HOST} @@ -149,7 +149,7 @@ Run all tests: .venv/bin/python -m pytest -q ``` -The current test suite covers: +The current test suite includes coverage for: - ingestion and handler behavior - analytics factory and runner logic From 6ec4cb45b50094b9a5f7b2b3763f23548e3e5207 Mon Sep 17 00:00:00 2001 From: DevStrikerTech Date: Sat, 14 Mar 2026 17:43:11 +0000 Subject: [PATCH 2/2] docs: clarify Dagster gRPC runtime wording Made-with: Cursor --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index ea1b175..820cb00 100644 --- a/README.md +++ b/README.md @@ -172,7 +172,7 @@ Workflows: Container image is defined via `Dockerfile`. -Default runtime command starts Dagster gRPC: +Default runtime command starts the Dagster gRPC server: ```bash python -m dagster api grpc -m dagster_op.repository