lumilake 0.1.0.dev1__tar.gz

lumilake-0.1.0.dev1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

lumilake-0.1.0.dev1/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md LICENSE
+recursive-include docs *.md

lumilake-0.1.0.dev1/PKG-INFO

@@ -0,0 +1,237 @@
+Metadata-Version: 2.4
+Name: lumilake
+Version: 0.1.0.dev1
+Summary: Data analytics engine for agentic workflows
+Author: Lumilake contributors
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/mlsys-io/lumilake_OSS
+Project-URL: Repository, https://github.com/mlsys-io/lumilake_OSS
+Project-URL: Issues, https://github.com/mlsys-io/lumilake_OSS/issues
+Keywords: agentic-workflows,data-analytics,lakehouse,workflow-orchestration
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: FastAPI
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Typing :: Typed
+Requires-Python: <3.13,>=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: sdk
+Requires-Dist: lumilake-sdk==0.1.0.dev1; extra == "sdk"
+Provides-Extra: cli
+Requires-Dist: lumilake-cli==0.1.0.dev1; extra == "cli"
+Requires-Dist: lumilake-deploy==0.1.0.dev1; extra == "cli"
+Provides-Extra: deploy
+Requires-Dist: lumilake-deploy==0.1.0.dev1; extra == "deploy"
+Provides-Extra: hook
+Requires-Dist: lumilake-hook==0.1.0.dev1; extra == "hook"
+Provides-Extra: all
+Requires-Dist: lumilake-sdk==0.1.0.dev1; extra == "all"
+Requires-Dist: lumilake-cli==0.1.0.dev1; extra == "all"
+Requires-Dist: lumilake-deploy==0.1.0.dev1; extra == "all"
+Requires-Dist: lumilake-hook==0.1.0.dev1; extra == "all"
+Dynamic: license-file
+
+# Lumilake
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![Lint](https://github.com/mlsys-io/lumilake_OSS/actions/workflows/lint-typecheck.yml/badge.svg)](https://github.com/mlsys-io/lumilake_OSS/actions/workflows/lint-typecheck.yml)
+[![Tests](https://github.com/mlsys-io/lumilake_OSS/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/mlsys-io/lumilake_OSS/actions/workflows/unit-tests.yml)
+
+Lumilake is a data analytics engine for agentic workflows. It accepts workflow specs (native graph JSON, YAML, or n8n JSON), optimizes the runtime graph with HALO, and dispatches tasks through FlowMesh.
+
+## What Lumilake Provides
+
+- Workflow parsing for native graph specs, YAML workflows, and n8n exports.
+- HALO scheduling for multi-step AI and data workflows.
+- A FastAPI server for job submission, status, cancellation, results, workers, and traces.
+- A CLI and Python SDK for local deployment and server API access.
+- Data access through direct PostgreSQL and S3-compatible storage; agent-style retrievals additionally route through lumid.data when `LUMID_DATA_URL` is set.
+- Shared hook integration through `lumid-hooks`, plus Lumilake-owned optimizer plugins.
+
+## Install
+
+From PyPI:
+
+```bash
+pip install "lumilake[cli]"
+```
+
+From a source checkout:
+
+```bash
+uv sync --all-packages --all-extras --all-groups
+```
+
+The PyPI `lumilake` distribution is a code-free metapackage; install one of the extras below to get a working set. The server runtime is published as a Docker image only and is intentionally not on PyPI.
+
+| Extra | Includes |
+|-------|----------|
+| `sdk` | Python SDK HTTP clients (`lumilake-sdk` → module `lumilake`) |
+| `cli` | `lumilake` command line interface plus deploy lifecycle (`lumilake-cli` + `lumilake-deploy`) |
+| `deploy` | Local Docker / FlowMesh deployment helpers (`lumilake-deploy`) |
+| `hook` | Resource-kind helpers for shared hook integrations (`lumilake-hook`) |
+| `all` | Everything above. |
+
+## Quick Start
+
+The server runs as the published Docker image. `lumilake deploy` reads its env files from `--project-dir` (or the current working directory). Either point at a deployment directory with `-C` / `--project-dir`, or `cd` to it first.
+
+```bash
+mkdir -p ~/lumilake-deploy
+lumilake deploy -C ~/lumilake-deploy init --flowmesh   # ~/lumilake-deploy/.env + .env.flowmesh
+$EDITOR ~/lumilake-deploy/.env                          # fill in DATABASE_URL / S3 / model keys
+lumilake deploy -C ~/lumilake-deploy pull               # fetch ghcr.io/mlsys-io/lumilake_server:<tag>
+lumilake deploy -C ~/lumilake-deploy up                 # bring the stack up via docker compose
+```
+
+`LUMILAKE_DEPLOY_DIR=~/lumilake-deploy` is an equivalent override. The deployment directory only needs to hold your `.env` files (and any local state docker compose creates) — the compose file and server image are resolved from the installed `lumilake-deploy` package and GHCR. The server listens on `http://127.0.0.1:9000` by default — open `/docs` for the API browser.
+
+Note: a real workflow run also requires running PostgreSQL and S3-compatible storage; agent-style retrievals (`DataRetrievalOp` with `type: agent`) additionally require `LUMID_DATA_URL`. See `docs/ENV.md` for the env contract. If you don't have your own data plane, the repo ships a bundled Postgres + MinIO at `scripts/dev/compose.data-plane.yml` — see `docs/E2E_DEMO.md` for the full three-step demo flow (data plane → load demo data → run a workflow).
+
+Submit and inspect a workflow. From a source checkout the example
+workflow file is at `examples/templates/yaml/trading-agent.yaml`;
+PyPI installs do not ship the templates, so pass an absolute path to a
+workflow file you have locally:
+
+```bash
+# From a source checkout:
+uv run lumilake login http://127.0.0.1:9000
+uv run lumilake job submit examples/templates/yaml/trading-agent.yaml \
+    --format yaml --input 'Stock=NVDA,AAPL,MSFT' --output-prefix demo/trading-agent
+
+# From a PyPI install (lumilake on PATH; supply your own workflow file):
+lumilake login http://127.0.0.1:9000
+lumilake job submit /path/to/your/workflow.yaml \
+    --format yaml --input 'Stock=NVDA,AAPL,MSFT' --output-prefix demo/trading-agent
+
+lumilake job list
+lumilake job watch <job_id>
+```
+
+See `docs/E2E_DEMO.md` for a full reproduction using the bundled demo
+workflows and dataset.
+
+## Data Access
+
+- **SQL retrievals** connect directly to `DATABASE_URL`.
+- **S3 retrievals** connect directly to `S3_URL`.
+- **Agent retrievals** (`DataRetrievalOp` with `type: agent`) require `LUMID_DATA_URL` and route through lumid.data's `/agent/v1` endpoint.
+
+Job records and runtime artifacts are written under `S3_ARCHIVE_PREFIX` using the same `S3_URL` connection.
+
+## Deployment
+
+Examples below assume you're set up with `LUMILAKE_DEPLOY_DIR=~/lumilake-deploy` (or pass `-C ~/lumilake-deploy` explicitly). Workspace-checkout users can prefix the commands with `uv run`; PyPI-install users invoke `lumilake` directly.
+
+Generate `.env` from the bundled template:
+
+```bash
+lumilake deploy init
+```
+
+Generate both Lumilake and bundled FlowMesh env files:
+
+```bash
+lumilake deploy init --flowmesh
+```
+
+Common deployment commands:
+
+```bash
+lumilake deploy doctor
+lumilake deploy pull         # or `build` to compile from source
+lumilake deploy up
+lumilake deploy status
+lumilake deploy logs server --tail 200
+lumilake deploy restart server
+lumilake deploy down
+lumilake deploy clean
+```
+
+Use `deploy down` to stop services while keeping data volumes. Use `deploy clean` or `deploy reset` only when you want to remove local stack state.
+
+## Python SDK
+
+```python
+from lumilake import LumilakeClient
+
+with LumilakeClient(base_url="http://127.0.0.1:9000") as client:
+    print(client.health())
+    print(client.jobs.list())
+```
+
+Install the SDK extra for HTTP clients:
+
+```bash
+pip install "lumilake[sdk]"
+```
+
+Install deploy support as well if you want `client.deploy.*` methods:
+
+```bash
+pip install "lumilake[sdk,deploy]"
+```
+
+See `docs/SDK.md` for the SDK resource map.
+
+## Documentation
+
+- `docs/ENV.md` - environment variables and data-plane modes.
+- `docs/CLI.md` - command groups and common CLI usage.
+- `docs/WORKFLOWS.md` - workflow input formats and YAML structure.
+- `docs/OPS.md` - built-in operation classes.
+- `docs/SDK.md` - sync and async Python client usage.
+- `docs/API.md` - server route overview and response shape.
+- `docs/ARCHITECTURE.md` - module layout and runtime flow.
+- `docs/PLUGINS.md` - shared hooks and Lumilake plugin model.
+- `docs/CODE_STYLE.md` - coding rules for contributors and agents.
+
+## Plugins
+
+Lumilake wires shared hook protocols from `lumid-hooks` for identity, permissions, resource registration, submission guards, and usage sinks. Optimizer registration remains Lumilake-specific.
+
+A minimal in-memory plugin is available under `examples/plugins/simple_plugin/`.
+
+## Repository Layout
+
+```text
+.
+├── src/lumilake_server/       # server runtime — image-only, not on PyPI
+├── packages/sdk/              # `lumilake-sdk` → module `lumilake` (Client, envs, log)
+├── packages/cli/              # `lumilake-cli` → `lumilake_cli` (Typer entry point)
+├── packages/deploy/           # `lumilake-deploy` — packaged compose + .env.example assets
+├── packages/hook/             # `lumilake-hook` → `lumilake_hook` (resource-kind helpers)
+├── examples/                  # workflow templates and sample plugins
+├── tests/                     # pytest suite
+├── scripts/                   # CI and developer helpers
+├── Dockerfile                 # builds ghcr.io/mlsys-io/lumilake_server
+├── .env.example -> packages/deploy/.../assets/.env.example   # symlink for editors
+├── uv.lock
+└── pyproject.toml             # metapackage (`lumilake`) with [sdk]/[cli]/[deploy]/[hook]/[all] extras
+```
+
+## Development
+
+```bash
+uv sync --group lint --group test --extra cli
+uv run pre-commit install --install-hooks -t pre-commit -t prepare-commit-msg -t commit-msg
+uv run pre-commit run --all-files
+uv run pytest tests/ --ignore=tests/server
+```
+
+After changing dependencies, run:
+
+```bash
+uv lock
+```
+
+See `CONTRIBUTING.md` for PR title format, CI workflows, DCO sign-off, dependency guidance, and local testing notes.
+
+## License
+
+Apache-2.0. See `LICENSE`.

lumilake-0.1.0.dev1/README.md

@@ -0,0 +1,200 @@
+# Lumilake
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![Python 3.12+](https://img.shields.io/badge/python-3.12+-blue.svg)](https://www.python.org/downloads/)
+[![Lint](https://github.com/mlsys-io/lumilake_OSS/actions/workflows/lint-typecheck.yml/badge.svg)](https://github.com/mlsys-io/lumilake_OSS/actions/workflows/lint-typecheck.yml)
+[![Tests](https://github.com/mlsys-io/lumilake_OSS/actions/workflows/unit-tests.yml/badge.svg)](https://github.com/mlsys-io/lumilake_OSS/actions/workflows/unit-tests.yml)
+
+Lumilake is a data analytics engine for agentic workflows. It accepts workflow specs (native graph JSON, YAML, or n8n JSON), optimizes the runtime graph with HALO, and dispatches tasks through FlowMesh.
+
+## What Lumilake Provides
+
+- Workflow parsing for native graph specs, YAML workflows, and n8n exports.
+- HALO scheduling for multi-step AI and data workflows.
+- A FastAPI server for job submission, status, cancellation, results, workers, and traces.
+- A CLI and Python SDK for local deployment and server API access.
+- Data access through direct PostgreSQL and S3-compatible storage; agent-style retrievals additionally route through lumid.data when `LUMID_DATA_URL` is set.
+- Shared hook integration through `lumid-hooks`, plus Lumilake-owned optimizer plugins.
+
+## Install
+
+From PyPI:
+
+```bash
+pip install "lumilake[cli]"
+```
+
+From a source checkout:
+
+```bash
+uv sync --all-packages --all-extras --all-groups
+```
+
+The PyPI `lumilake` distribution is a code-free metapackage; install one of the extras below to get a working set. The server runtime is published as a Docker image only and is intentionally not on PyPI.
+
+| Extra | Includes |
+|-------|----------|
+| `sdk` | Python SDK HTTP clients (`lumilake-sdk` → module `lumilake`) |
+| `cli` | `lumilake` command line interface plus deploy lifecycle (`lumilake-cli` + `lumilake-deploy`) |
+| `deploy` | Local Docker / FlowMesh deployment helpers (`lumilake-deploy`) |
+| `hook` | Resource-kind helpers for shared hook integrations (`lumilake-hook`) |
+| `all` | Everything above. |
+
+## Quick Start
+
+The server runs as the published Docker image. `lumilake deploy` reads its env files from `--project-dir` (or the current working directory). Either point at a deployment directory with `-C` / `--project-dir`, or `cd` to it first.
+
+```bash
+mkdir -p ~/lumilake-deploy
+lumilake deploy -C ~/lumilake-deploy init --flowmesh   # ~/lumilake-deploy/.env + .env.flowmesh
+$EDITOR ~/lumilake-deploy/.env                          # fill in DATABASE_URL / S3 / model keys
+lumilake deploy -C ~/lumilake-deploy pull               # fetch ghcr.io/mlsys-io/lumilake_server:<tag>
+lumilake deploy -C ~/lumilake-deploy up                 # bring the stack up via docker compose
+```
+
+`LUMILAKE_DEPLOY_DIR=~/lumilake-deploy` is an equivalent override. The deployment directory only needs to hold your `.env` files (and any local state docker compose creates) — the compose file and server image are resolved from the installed `lumilake-deploy` package and GHCR. The server listens on `http://127.0.0.1:9000` by default — open `/docs` for the API browser.
+
+Note: a real workflow run also requires running PostgreSQL and S3-compatible storage; agent-style retrievals (`DataRetrievalOp` with `type: agent`) additionally require `LUMID_DATA_URL`. See `docs/ENV.md` for the env contract. If you don't have your own data plane, the repo ships a bundled Postgres + MinIO at `scripts/dev/compose.data-plane.yml` — see `docs/E2E_DEMO.md` for the full three-step demo flow (data plane → load demo data → run a workflow).
+
+Submit and inspect a workflow. From a source checkout the example
+workflow file is at `examples/templates/yaml/trading-agent.yaml`;
+PyPI installs do not ship the templates, so pass an absolute path to a
+workflow file you have locally:
+
+```bash
+# From a source checkout:
+uv run lumilake login http://127.0.0.1:9000
+uv run lumilake job submit examples/templates/yaml/trading-agent.yaml \
+    --format yaml --input 'Stock=NVDA,AAPL,MSFT' --output-prefix demo/trading-agent
+
+# From a PyPI install (lumilake on PATH; supply your own workflow file):
+lumilake login http://127.0.0.1:9000
+lumilake job submit /path/to/your/workflow.yaml \
+    --format yaml --input 'Stock=NVDA,AAPL,MSFT' --output-prefix demo/trading-agent
+
+lumilake job list
+lumilake job watch <job_id>
+```
+
+See `docs/E2E_DEMO.md` for a full reproduction using the bundled demo
+workflows and dataset.
+
+## Data Access
+
+- **SQL retrievals** connect directly to `DATABASE_URL`.
+- **S3 retrievals** connect directly to `S3_URL`.
+- **Agent retrievals** (`DataRetrievalOp` with `type: agent`) require `LUMID_DATA_URL` and route through lumid.data's `/agent/v1` endpoint.
+
+Job records and runtime artifacts are written under `S3_ARCHIVE_PREFIX` using the same `S3_URL` connection.
+
+## Deployment
+
+Examples below assume you're set up with `LUMILAKE_DEPLOY_DIR=~/lumilake-deploy` (or pass `-C ~/lumilake-deploy` explicitly). Workspace-checkout users can prefix the commands with `uv run`; PyPI-install users invoke `lumilake` directly.
+
+Generate `.env` from the bundled template:
+
+```bash
+lumilake deploy init
+```
+
+Generate both Lumilake and bundled FlowMesh env files:
+
+```bash
+lumilake deploy init --flowmesh
+```
+
+Common deployment commands:
+
+```bash
+lumilake deploy doctor
+lumilake deploy pull         # or `build` to compile from source
+lumilake deploy up
+lumilake deploy status
+lumilake deploy logs server --tail 200
+lumilake deploy restart server
+lumilake deploy down
+lumilake deploy clean
+```
+
+Use `deploy down` to stop services while keeping data volumes. Use `deploy clean` or `deploy reset` only when you want to remove local stack state.
+
+## Python SDK
+
+```python
+from lumilake import LumilakeClient
+
+with LumilakeClient(base_url="http://127.0.0.1:9000") as client:
+    print(client.health())
+    print(client.jobs.list())
+```
+
+Install the SDK extra for HTTP clients:
+
+```bash
+pip install "lumilake[sdk]"
+```
+
+Install deploy support as well if you want `client.deploy.*` methods:
+
+```bash
+pip install "lumilake[sdk,deploy]"
+```
+
+See `docs/SDK.md` for the SDK resource map.
+
+## Documentation
+
+- `docs/ENV.md` - environment variables and data-plane modes.
+- `docs/CLI.md` - command groups and common CLI usage.
+- `docs/WORKFLOWS.md` - workflow input formats and YAML structure.
+- `docs/OPS.md` - built-in operation classes.
+- `docs/SDK.md` - sync and async Python client usage.
+- `docs/API.md` - server route overview and response shape.
+- `docs/ARCHITECTURE.md` - module layout and runtime flow.
+- `docs/PLUGINS.md` - shared hooks and Lumilake plugin model.
+- `docs/CODE_STYLE.md` - coding rules for contributors and agents.
+
+## Plugins
+
+Lumilake wires shared hook protocols from `lumid-hooks` for identity, permissions, resource registration, submission guards, and usage sinks. Optimizer registration remains Lumilake-specific.
+
+A minimal in-memory plugin is available under `examples/plugins/simple_plugin/`.
+
+## Repository Layout
+
+```text
+.
+├── src/lumilake_server/       # server runtime — image-only, not on PyPI
+├── packages/sdk/              # `lumilake-sdk` → module `lumilake` (Client, envs, log)
+├── packages/cli/              # `lumilake-cli` → `lumilake_cli` (Typer entry point)
+├── packages/deploy/           # `lumilake-deploy` — packaged compose + .env.example assets
+├── packages/hook/             # `lumilake-hook` → `lumilake_hook` (resource-kind helpers)
+├── examples/                  # workflow templates and sample plugins
+├── tests/                     # pytest suite
+├── scripts/                   # CI and developer helpers
+├── Dockerfile                 # builds ghcr.io/mlsys-io/lumilake_server
+├── .env.example -> packages/deploy/.../assets/.env.example   # symlink for editors
+├── uv.lock
+└── pyproject.toml             # metapackage (`lumilake`) with [sdk]/[cli]/[deploy]/[hook]/[all] extras
+```
+
+## Development
+
+```bash
+uv sync --group lint --group test --extra cli
+uv run pre-commit install --install-hooks -t pre-commit -t prepare-commit-msg -t commit-msg
+uv run pre-commit run --all-files
+uv run pytest tests/ --ignore=tests/server
+```
+
+After changing dependencies, run:
+
+```bash
+uv lock
+```
+
+See `CONTRIBUTING.md` for PR title format, CI workflows, DCO sign-off, dependency guidance, and local testing notes.
+
+## License
+
+Apache-2.0. See `LICENSE`.