Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FastFlowTransform (PoC 0.3)
# FastFlowTransform (PoC 0.5.1)

[![CI](https://github.com/<org>/<repo>/actions/workflows/ci.yml/badge.svg)](https://github.com/<org>/<repo>/actions/workflows/ci.yml)
[![PyPI version](https://img.shields.io/pypi/v/fastflowtransform.svg)](https://pypi.org/project/fastflowtransform/)
Expand Down
2 changes: 0 additions & 2 deletions docs/Config_and_Macros.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
1 change: 1 addition & 0 deletions docs/Contributing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
--8<-- "CONTRIBUTING.md"
1 change: 0 additions & 1 deletion docs/Data_Quality_Tests.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
4 changes: 1 addition & 3 deletions docs/Technical_Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
6 changes: 3 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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.

---
Expand All @@ -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.
3 changes: 3 additions & 0 deletions docs/license.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# License

--8<-- "LICENSE"
18 changes: 9 additions & 9 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,25 +17,21 @@ 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
- Cache & Parallelism: Cache_and_Parallelism.md
- 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
Expand All @@ -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:
Expand Down
5 changes: 4 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -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" }
Expand Down Expand Up @@ -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",
Expand Down
18 changes: 10 additions & 8 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.