From 7970718103dde7dc07d179cccf0f883890e7761e Mon Sep 17 00:00:00 2001 From: Marko Lekic Date: Tue, 28 Oct 2025 20:25:31 +0100 Subject: [PATCH 1/2] Fixed pages.yml --- .github/workflows/pages.yml | 13 +++++++------ README.md | 2 +- pyproject.toml | 5 ++++- uv.lock | 18 ++++++++++-------- 4 files changed, 22 insertions(+), 16 deletions(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 31d629a..63c1ee1 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -24,16 +24,17 @@ jobs: - name: Setup Python uses: actions/setup-python@v5 with: - python-version: '3.x' - cache: 'pip' + python-version: '3.12' - - name: Install dependencies + - name: Setup uv + uses: astral-sh/setup-uv@v4 + + - name: Install docs (and dev) dependencies run: | - python -m pip install --upgrade pip - pip install -r requirements.txt + uv sync --extra docs --extra dev - name: Build site - run: mkdocs build --strict + run: uv run mkdocs build --strict - name: Upload Pages artifact uses: actions/upload-pages-artifact@v3 diff --git a/README.md b/README.md index 9f27b75..345e03b 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# FastFlowTransform (PoC 0.3) +# FastFlowTransform (PoC 0.5.1) [![CI](https://github.com///actions/workflows/ci.yml/badge.svg)](https://github.com///actions/workflows/ci.yml) [![PyPI version](https://img.shields.io/pypi/v/fastflowtransform.svg)](https://pypi.org/project/fastflowtransform/) diff --git a/pyproject.toml b/pyproject.toml index c858a5d..b752cde 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ build-backend = "hatchling.build" [project] name = "fastflowtransform" -version = "0.4.0" +version = "0.5.1" description = "FastFlowTransform PoC: SQL+Python Models, DAG, DuckDB executor" readme = "README.md" license = { text = "Apache-2.0" } @@ -47,6 +47,9 @@ dev = [ "pre-commit==3.*", "pandas-stubs>=2.1", "types-PyYAML>=6.0.12", +] + +docs = [ "mkdocs>=1.6", "mkdocs-material>=9.5", "pymdown-extensions>=10.0", diff --git a/uv.lock b/uv.lock index 5d45621..763f89d 100644 --- a/uv.lock +++ b/uv.lock @@ -720,7 +720,7 @@ wheels = [ [[package]] name = "fastflowtransform" -version = "0.4.0" +version = "0.5.1" source = { editable = "." } dependencies = [ { name = "bigframes" }, @@ -744,16 +744,18 @@ dependencies = [ [package.optional-dependencies] dev = [ - { name = "mkdocs" }, - { name = "mkdocs-material" }, { name = "mypy" }, { name = "pandas-stubs" }, { name = "pre-commit" }, - { name = "pymdown-extensions" }, { name = "pytest" }, { name = "ruff" }, { name = "types-pyyaml" }, ] +docs = [ + { name = "mkdocs" }, + { name = "mkdocs-material" }, + { name = "pymdown-extensions" }, +] [package.dev-dependencies] dev = [ @@ -768,8 +770,8 @@ requires-dist = [ { name = "google-cloud-bigquery", specifier = ">=3.25" }, { name = "httpx", specifier = ">=0.28.1" }, { name = "jinja2", specifier = ">=3.1" }, - { name = "mkdocs", marker = "extra == 'dev'", specifier = ">=1.6" }, - { name = "mkdocs-material", marker = "extra == 'dev'", specifier = ">=9.5" }, + { name = "mkdocs", marker = "extra == 'docs'", specifier = ">=1.6" }, + { name = "mkdocs-material", marker = "extra == 'docs'", specifier = ">=9.5" }, { name = "mypy", marker = "extra == 'dev'", specifier = "==1.18.*" }, { name = "pandas", specifier = ">=2.0" }, { name = "pandas-stubs", marker = "extra == 'dev'", specifier = ">=2.1" }, @@ -778,7 +780,7 @@ requires-dist = [ { name = "psycopg2-binary", specifier = ">=2.9" }, { name = "pydantic", specifier = ">=2.8" }, { name = "pydantic-settings", specifier = ">=2.4" }, - { name = "pymdown-extensions", marker = "extra == 'dev'", specifier = ">=10.0" }, + { name = "pymdown-extensions", marker = "extra == 'docs'", specifier = ">=10.0" }, { name = "pyspark", specifier = ">=4.0.1" }, { name = "pytest", marker = "extra == 'dev'", specifier = "==8.4.*" }, { name = "python-dotenv", specifier = ">=1.0" }, @@ -790,7 +792,7 @@ requires-dist = [ { name = "typer", specifier = ">=0.12" }, { name = "types-pyyaml", marker = "extra == 'dev'", specifier = ">=6.0.12" }, ] -provides-extras = ["dev"] +provides-extras = ["dev", "docs"] [package.metadata.requires-dev] dev = [ From 035036ea7aba3e35e5520ab3f84fcaef2284e193 Mon Sep 17 00:00:00 2001 From: Marko Lekic Date: Tue, 28 Oct 2025 21:15:00 +0100 Subject: [PATCH 2/2] Fixed pages and updated docs --- docs/Config_and_Macros.md | 2 -- docs/Contributing.md | 1 + docs/Data_Quality_Tests.md | 1 - docs/Technical_Overview.md | 4 +--- docs/index.md | 6 +++--- docs/license.md | 3 +++ mkdocs.yml | 18 +++++++++--------- 7 files changed, 17 insertions(+), 18 deletions(-) create mode 100644 docs/Contributing.md create mode 100644 docs/license.md diff --git a/docs/Config_and_Macros.md b/docs/Config_and_Macros.md index fcef06d..dcf3b05 100644 --- a/docs/Config_and_Macros.md +++ b/docs/Config_and_Macros.md @@ -352,6 +352,4 @@ See the [Technical Overview](./Technical_Overview.md#model-unit-tests-fastflowtr --- -Need something not covered here? Open an issue or start a discussion as described in [`../Contributing.md`](../Contributing.md). Continuous feedback keeps this reference sharp. - Return to the [Docs Hub](./index.md) or switch to the [User/Developer Guide](./Technical_Overview.md). diff --git a/docs/Contributing.md b/docs/Contributing.md new file mode 100644 index 0000000..ea38c9b --- /dev/null +++ b/docs/Contributing.md @@ -0,0 +1 @@ +--8<-- "CONTRIBUTING.md" diff --git a/docs/Data_Quality_Tests.md b/docs/Data_Quality_Tests.md index 65082d7..d04519e 100644 --- a/docs/Data_Quality_Tests.md +++ b/docs/Data_Quality_Tests.md @@ -169,5 +169,4 @@ Failures include the generated SQL (where available) to simplify debugging. Use ## Further Reading - [`docs/YAML_Tests.md`](YAML_Tests.md) – schema for YAML-defined tests and advanced scenarios. -- [`fastflowtransform/testing.py`](../src/fastflowtransform/testing.py) – implementation details and helper functions. - [`fft test --help`] — command-line switches, selectors, and cache options. diff --git a/docs/Technical_Overview.md b/docs/Technical_Overview.md index 4206508..4d7e555 100644 --- a/docs/Technical_Overview.md +++ b/docs/Technical_Overview.md @@ -172,14 +172,12 @@ Targets wrap the CLI commands showcased below. Feel free to copy the pattern int ### CLI Flows -> 📚 **Need recipes?** The step-by-step walkthrough lives in [`README.md`](../README.md#quickstart); this section highlights additional guidance. - - CLI flags and internals are documented under [CLI Implementation](#cli-implementation). - Automation examples appear in the [Makefile Targets](#makefile-targets). #### HTTP/API in Python models -See [API calls in Python models](./API_Models.md) for `get_json`/`get_df`, pagination, cache/offline flags. +See [API calls in Python models](./Api_Models.md) for `get_json`/`get_df`, pagination, cache/offline flags. #### DAG & Documentation diff --git a/docs/index.md b/docs/index.md index 735f88c..d71d65d 100644 --- a/docs/index.md +++ b/docs/index.md @@ -9,7 +9,7 @@ Welcome! This page is your starting point for FastFlowTransform docs. Pick the t - [User Guide](./Technical_Overview.md#part-i--operational-guide) - [Modeling Reference](./Config_and_Macros.md) - [Parallelism & Cache](./Cache_and_Parallelism.md) -- [API calls in Python models](./API_Models.md) +- [API calls in Python models](./Api_Models.md) - [Incremental Models](./Incremental.md) - [YAML Tests (Schema-bound)](./YAML_Tests.md) - [Data Quality Tests Reference](./Data_Quality_Tests.md) @@ -41,7 +41,7 @@ Welcome! This page is your starting point for FastFlowTransform docs. Pick the t - **Dive into architecture & core modules:** start with [Architecture Overview](Technical_Overview.md#architecture-overview) and [Core Modules](Technical_Overview.md#core-modules) for registry, DAG, executors, validation, and more. - **Add tests & seeds:** see [Sample Models](Technical_Overview.md#sample-models), [Seeds & Example Data](Technical_Overview.md#seeds--example-data), and the unit test guide in [Model Unit Tests](Technical_Overview.md#model-unit-tests-fastflowtransform-utest). -- **Contribute code:** follow the workflow described in [`../Contributing.md`](../Contributing.md) and consult the module-level docs for internal APIs. +- **Contribute code:** follow the workflow described in [`./Contributing.md`](./Contributing.md) and consult the module-level docs for internal APIs. - **Plan ahead:** check the roadmap snapshot in the [Technical Overview](Technical_Overview.md#roadmap-snapshot) to understand upcoming work. --- @@ -58,6 +58,6 @@ Welcome! This page is your starting point for FastFlowTransform docs. Pick the t ## Need Help? -- Open an issue or PR — see [`../Contributing.md`](../Contributing.md) for guidelines. +- Open an issue or PR — see [`./Contributing.md`](./Contributing.md) for guidelines. - Join the discussion (planning doc / roadmap highlights) — see the roadmap section in the [Technical Overview](Technical_Overview.md#roadmap-snapshot). - If you spot gaps in the docs, file an issue with the context and links to the relevant section. diff --git a/docs/license.md b/docs/license.md new file mode 100644 index 0000000..0e8c6fc --- /dev/null +++ b/docs/license.md @@ -0,0 +1,3 @@ +# License + +--8<-- "LICENSE" diff --git a/mkdocs.yml b/mkdocs.yml index 33abcaf..fe84938 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -17,16 +17,9 @@ theme: - search.highlight icon: repo: fontawesome/brands/github - # Optional Branding (aktiviere bei Bedarf): - # logo: assets/logo.png - # favicon: assets/favicon.png - # palette: - # - scheme: default - # primary: indigo - # accent: indigo - nav: - Home: index.md + - Quickstart: Quickstart.md - Technical Overview: Technical_Overview.md - API & Models: Api_Models.md - Configuration & Macros: Config_and_Macros.md @@ -34,8 +27,11 @@ nav: - Incremental Processing: Incremental.md - State Selection: State_Selection.md - YAML Tests: YAML_Tests.md + - Data Quality Tests: Data_Quality_Tests.md - Examples: - Environment Matrix: examples/Environment_Matrix.md + - Contributing: Contributing.md + - License: license.md markdown_extensions: - admonition @@ -46,7 +42,11 @@ markdown_extensions: - pymdownx.details - pymdownx.highlight - pymdownx.inlinehilite - - pymdownx.snippets + - pymdownx.snippets: + base_path: + - . + - docs + check_paths: true - pymdownx.magiclink plugins: