Skip to content

feat(package): restructure src/ into pip-installable lakeflow_framewo…#87

Open
rederik76 wants to merge 2 commits into
mainfrom
refactor/lakeflow-framework-package
Open

feat(package): restructure src/ into pip-installable lakeflow_framewo…#87
rederik76 wants to merge 2 commits into
mainfrom
refactor/lakeflow-framework-package

Conversation

@rederik76
Copy link
Copy Markdown
Collaborator

  • Introduce src/lakeflow_framework/ as a proper Python package with pyproject.toml (hatchling build); config/ and schemas/ bundled as package data
  • Implement Strategy B (Workspace Files-first) resolver in config_resolver: load_framework_default_json resolves via Workspace Files → importlib.resources → local/config/ overlay; load_framework_schema returns an importlib.resources traversable for bundled JSON schemas
  • Reduce src/*.py shims to thin re-exports from lakeflow_framework for backward compat
  • Add contrib/ extension point with README and init stub
  • Add tests: test_package.py (import surface), test_strategy_b_resolver.py (resolver + schema)
  • Update all internal imports across dataflow/, dataflow_spec_builder/, and support modules
  • Add docs: ADR-0007 (package layout), ADR-0008 (Workspace Files-first resolver), deploy_wheel.rst, deploy_framework_overview.rst, contributor_contrib.rst; update all existing docs/ pages to reference lakeflow_framework imports

…rk package

- Introduce src/lakeflow_framework/ as a proper Python package with pyproject.toml
  (hatchling build); config/ and schemas/ bundled as package data
- Implement Strategy B (Workspace Files-first) resolver in config_resolver:
  load_framework_default_json resolves via Workspace Files → importlib.resources →
  local/config/ overlay; load_framework_schema returns an importlib.resources
  traversable for bundled JSON schemas
- Reduce src/*.py shims to thin re-exports from lakeflow_framework for backward compat
- Add contrib/ extension point with README and __init__ stub
- Add tests: test_package.py (import surface), test_strategy_b_resolver.py (resolver + schema)
- Update all internal imports across dataflow/, dataflow_spec_builder/, and support modules
- Add docs: ADR-0007 (package layout), ADR-0008 (Workspace Files-first resolver),
  deploy_wheel.rst, deploy_framework_overview.rst, contributor_contrib.rst;
  update all existing docs/ pages to reference lakeflow_framework imports
@rederik76 rederik76 requested a review from haillew as a code owner May 23, 2026 05:36
@rederik76 rederik76 self-assigned this May 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[FEATURE]: lakeflow-framework Python package with contrib extras and absolute imports

1 participant