calc-flow-python 4.0.0__cp313-abi3-win_amd64.whl

calc_flow_python-4.0.0.dist-info/METADATA

@@ -0,0 +1,376 @@
+Metadata-Version: 2.4
+Name: calc-flow-python
+Version: 4.0.0
+Requires-Dist: pydantic>=2.12.0,<3
+Requires-Dist: pyarrow>=24.0.0,<25
+Requires-Dist: jax>=0.4 ; extra == 'array'
+Requires-Dist: numpy>=2.0.0 ; extra == 'array'
+Requires-Dist: ta-lib==0.7.1 ; extra == 'benchmark'
+Requires-Dist: datafusion==54.0.0 ; extra == 'benchmark'
+Requires-Dist: jax>=0.4 ; extra == 'benchmark'
+Requires-Dist: numpy>=2.0.0 ; extra == 'benchmark'
+Requires-Dist: polars>=1.32,<2 ; extra == 'benchmark'
+Requires-Dist: psutil>=6.1 ; extra == 'benchmark'
+Requires-Dist: py-cpuinfo>=9 ; extra == 'benchmark'
+Requires-Dist: pytest>=8 ; extra == 'benchmark'
+Requires-Dist: pytest-benchmark>=5.2 ; extra == 'benchmark'
+Requires-Dist: hypothesis>=6.100 ; extra == 'dev'
+Requires-Dist: jax>=0.4 ; extra == 'dev'
+Requires-Dist: maturin>=1.14.1,<2.0 ; extra == 'dev'
+Requires-Dist: numpy>=2.0.0 ; extra == 'dev'
+Requires-Dist: psutil>=6.1 ; extra == 'dev'
+Requires-Dist: py-cpuinfo>=9 ; extra == 'dev'
+Requires-Dist: pytest>=8 ; extra == 'dev'
+Requires-Dist: pytest-cov>=7.1 ; extra == 'dev'
+Requires-Dist: pytest-xdist>=3.6 ; extra == 'dev'
+Requires-Dist: ruff==0.16.0 ; extra == 'dev'
+Requires-Dist: jax>=0.4 ; extra == 'jax'
+Requires-Dist: numpy>=2.0.0 ; extra == 'numpy'
+Provides-Extra: array
+Provides-Extra: benchmark
+Provides-Extra: dev
+Provides-Extra: jax
+Provides-Extra: numpy
+License-File: LICENSE
+Summary: Rust-native DataFusion batch and streaming calculation pipelines
+License-Expression: Apache-2.0
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown; charset=UTF-8; variant=GFM
+Project-URL: Repository, https://github.com/wegamekinglc/calc-flow
+
+# Calc Flow
+
+[![Linux CI](https://github.com/wegamekinglc/calc-flow/actions/workflows/ci-linux.yml/badge.svg?branch=main)](https://github.com/wegamekinglc/calc-flow/actions/workflows/ci-linux.yml)
+[![Windows CI](https://github.com/wegamekinglc/calc-flow/actions/workflows/ci-windows.yml/badge.svg?branch=main)](https://github.com/wegamekinglc/calc-flow/actions/workflows/ci-windows.yml)
+[![Coverage Status](https://coveralls.io/repos/github/wegamekinglc/calc-flow/badge.svg?branch=main)](https://coveralls.io/github/wegamekinglc/calc-flow?branch=main)
+
+Calc Flow 4.0 is a Rust-native calculation engine for immutable Arrow
+micro-batches and stateful streams. The core crate compiles typed calculation
+graphs, runs every table expression and query with Apache DataFusion, and owns
+checkpoint/recovery semantics. The Python package is a PyO3 binding to that
+engine; it is not a second implementation. Calc Flow Studio remains a separate
+local FastAPI and React application.
+
+## Install
+
+Python 3.13 or newer:
+
+```bash
+uv add calc-flow-python
+```
+
+Optional array providers:
+
+```bash
+uv add "calc-flow-python[numpy]"
+uv add "calc-flow-python[jax]"
+```
+
+Rust:
+
+```toml
+[dependencies]
+calc-flow = "4.0.0"
+```
+
+## Python quickstart
+
+```python
+from datetime import UTC, datetime, timedelta
+
+import pyarrow as pa
+
+from calc_flow import Batch, ExecutionOptions, PipelineBuilder
+
+batch = Batch.from_pyarrow(pa.table({"a": [1, 3], "b": [2, 4]}))
+plan = (
+    PipelineBuilder("totals").expression("calculate", "total = a + b").compile_batch()
+)
+result = plan.execute(
+    {"input": batch},
+    options=ExecutionOptions(
+        settings={"request": {"source": "readme"}},
+        deadline=datetime.now(UTC) + timedelta(seconds=30),
+    ),
+)
+
+assert result.outputs["output"].to_pyarrow()["total"].to_pylist() == [3, 7]
+```
+
+`PipelineBuilder` is functional: every method returns a new builder and leaves
+its input unchanged. Unconnected input ports become graph inputs; unconnected
+output ports become graph outputs. Use `execute_async()` inside an event loop.
+Both execution forms accept keyword-only, frozen `ExecutionOptions` carrying
+deep-copied strict-JSON settings and an optional timezone-aware deadline that
+is normalized to UTC. Settings may be nested mappings/lists; `settings=None`
+means empty settings.
+
+See [the Python API guide](docs/python-api.md) and the executable
+[examples](examples/README.md) for SQL, Python scalar UDFs, continuous
+execution and recovery, asyncio, and NumPy/JAX.
+The [symbolic workflow guide](docs/symbolic-workflows.md) covers composed
+financial features, checkpoint recovery, static matrices, bounded stream
+joins, capability errors, Studio inspection, and performance output.
+
+## Rust quickstart
+
+The Rust crate exposes the native data, operator, graph, runtime, project, and
+checkpoint types directly. A table `Batch` contains one or more Arrow
+`RecordBatch` values plus immutable metadata. Build a graph with
+`PipelineBuilder`, compile it against a `UdfRegistrySnapshot`, then await
+`BatchExecutionPlan::execute`. The canonical first example is
+[`crates/calc-flow/examples/expression_pipeline.rs`](crates/calc-flow/examples/expression_pipeline.rs),
+a true twin of the Python quickstart:
+
+```rust
+use std::{collections::BTreeMap, sync::Arc};
+
+use calc_flow::{
+    Batch, BatchMetadata, ExecutionOptions, ExpressionOperator, PipelineBuilder, UdfRegistry,
+};
+use datafusion::arrow::{array::Int64Array, record_batch::RecordBatch};
+
+#[tokio::main]
+async fn main() -> Result<(), Box<dyn std::error::Error>> {
+    let plan = PipelineBuilder::new("totals")?
+        .add_node(
+            "calculate",
+            Box::new(ExpressionOperator::new(
+                "calculate",
+                "total = a + b",
+                Vec::new(),
+                None,
+                Vec::new(),
+            )?),
+        )?
+        .compile_batch(&UdfRegistry::new().snapshot())?;
+    let input = RecordBatch::try_from_iter(vec![
+        (
+            "a",
+            Arc::new(Int64Array::from(vec![1, 3])) as Arc<dyn datafusion::arrow::array::Array>,
+        ),
+        ("b", Arc::new(Int64Array::from(vec![2, 4])) as _),
+    ])?;
+    let result = plan
+        .execute(
+            BTreeMap::from([(
+                "input".into(),
+                Batch::table(vec![input], BatchMetadata::default())?,
+            )]),
+            ExecutionOptions::default(),
+        )
+        .await?;
+    let output = result.outputs["output"].table_payload()?;
+    let totals = output.batches()[0]
+        .column_by_name("total")
+        .expect("expression output contains total")
+        .as_any()
+        .downcast_ref::<Int64Array>()
+        .expect("total is an Int64 column");
+
+    assert_eq!(totals.values(), &[3, 7]);
+    println!("calculated totals: {totals:?}");
+    Ok(())
+}
+```
+
+Run the checked examples:
+
+```bash
+cargo run -p calc-flow --example expression_pipeline
+cargo run -p calc-flow --example sql_join
+cargo run -p calc-flow --example continuous_runtime
+cargo run -p calc-flow --example windowed_streaming
+```
+
+See [the Rust API guide](docs/rust-api.md) for paired source examples and links
+to the public types, or the [Rust examples index](crates/calc-flow/examples/README.md).
+
+## Architecture
+
+```text
+crates/calc-flow  (Rust core: Batch, graph compiler, DataFusion, runners, stores)
+  ├─ crates/calc-flow-connectors  (trusted transport implementations)
+  └─ crates/calc-flow-python  (PyO3 _native binding + registered connectors)
+       └─ python/calc_flow  (pure-Python public API + functional adapters)
+            └─ web-ui/backend  (calc-flow-studio FastAPI, /api/v3, loopback only)
+                  └─ web-ui/src  (React + TypeScript + Vite + React Flow studio, via REST)
+```
+
+The native dependency edges are `crates/calc-flow ← calc-flow-connectors` and
+`crates/calc-flow ← crates/calc-flow-python ← python/calc_flow ← web-ui/backend`.
+The frontend talks to the backend over the `/api/v3` REST contract only; the
+Python package is not a second engine.
+
+| Path                           | Purpose                                                                                                                                  |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------|
+| `crates/calc-flow/`            | Native core: batches, ports/operators, graph compiler, DataFusion runtime, UDF/provider registries, runners, checkpoints, project stores |
+| `crates/calc-flow-connectors/` | Trusted file, Kafka, PostgreSQL, MySQL, ClickHouse, HTTP, and WebSocket connectors behind feature gates                                  |
+| `crates/calc-flow-python/`     | PyO3 binding exposing the core as `calc_flow._native`                                                                                    |
+| `python/calc_flow/`            | Pure-Python public API, functional `PipelineBuilder`, runner/store adapters, NumPy/JAX provider registration, exception hierarchy        |
+| `web-ui/backend/`              | `calc-flow-studio` FastAPI service under `/api/v3`, loopback-bound, spawned bounded continuous-job workers                               |
+| `web-ui/src/`                  | React + TypeScript + Vite + React Flow studio; API types generated from `web-ui/openapi.json`                                            |
+| `schemas/`                     | `project-v3.schema.json`, the canonical generated project contract                                                                       |
+| `examples/`                    | Executable v3 Python examples                                                                                                            |
+| `benchmarks/`                  | pytest-benchmark harness (informational)                                                                                                 |
+
+## Data and execution model
+
+- Table data is Arrow-backed and calculated only by DataFusion.
+- NumPy and JAX are optional Python array providers. They are registered
+  explicitly and evaluate a bounded, allowlisted expression language.
+- Raw tables or arrays never cross a graph or runner boundary; they are wrapped
+  in immutable `Batch` envelopes.
+- Project documents are strict, data-only JSON/YAML with
+  `format_version: 3`. They select batch or stream runtime mode explicitly;
+  stream documents reference registered connectors and named secrets without
+  embedding credentials, callables, import paths, or table backend selectors.
+- Table and mixed graph runs own one run-scoped DataFusion session. External-only
+  NumPy/JAX runs own no DataFusion configuration, UDF state, or runtime and
+  return an empty DataFusion metrics list.
+- Every graph run returns named outputs, per-node row counts/timings, and run
+  metadata; table work additionally reports DataFusion plans and timings.
+- Python executions accept reusable frozen `ExecutionOptions` with
+  deep-copied strict-JSON settings and a cooperative, timezone-aware deadline
+  normalized to UTC.
+- The source-driven `StreamingRunner` consumes a `StreamExecutionPlan`, owns
+  async source/sink bindings, and returns a one-owner `StreamingJob`.
+- Managed epoch checkpoints use `LocalStateBackend` segments and strict v3
+  `CheckpointManifest` documents. Exactly-once compatibility is proved per
+  requested output; ordinary sinks remain at least once.
+
+The capabilities and execution model are introduced in
+[docs/introduction.md](docs/introduction.md). The complete component and
+lifecycle design is in [docs/design.md](docs/design.md), and the practical
+continuous tutorial is [docs/streaming-guide.md](docs/streaming-guide.md).
+
+## Trusted extensions
+
+Python applications may register trusted vectorized DataFusion scalar UDFs on
+a `Runtime`. Every registration declares provider, name, version, exact Arrow
+input types, return type, and volatility. Graph nodes select registrations
+explicitly with `(provider, name, version)` references. Serialized projects
+contain references only.
+
+Rust applications use `UdfRegistry` for native DataFusion UDFs and
+`ProviderRegistry` for explicitly registered external operators.
+
+## Studio
+
+`web-ui/backend/` is the independently packaged `calc-flow-studio` FastAPI
+service. `web-ui/` is the React, TypeScript, Vite, and React Flow client.
+The local service:
+
+- exposes the v3 REST API under `/api/v3`;
+- binds only to loopback and is intentionally single-user;
+- validates and stores v3 project documents;
+- runs bounded continuous jobs in spawned workers;
+- serves generated frontend assets from the Studio wheel.
+
+Start both development processes on macOS, Linux, or WSL:
+
+```bash
+./web-ui/scripts/start_web_ui.sh
+```
+
+On native Windows PowerShell:
+
+```powershell
+.\web-ui\scripts\start_web_ui.ps1
+```
+
+Open `http://127.0.0.1:5173`, then stop the managed processes with the
+matching command for your platform:
+
+```bash
+./web-ui/scripts/stop_web_ui.sh
+```
+
+```powershell
+.\web-ui\scripts\stop_web_ui.ps1
+```
+
+Both launchers keep logs and process state under `.calc-flow-web/`.
+
+The checked OpenAPI contract is
+[web-ui/openapi.json](web-ui/openapi.json); generated TypeScript request and
+response types are in `web-ui/src/api/schema.d.ts`.
+
+## Project contracts
+
+Calc Flow 4.0 accepts strict project-v3 documents and exposes the Studio
+`/api/v3` surface. Read [projects and persistence](docs/projects-guide.md)
+for validation, serialization, and reloading a graph. Historical changes are
+recorded in [CHANGELOG.md](CHANGELOG.md).
+
+## Development
+
+Large Cargo and Maturin outputs should use the repository `target/` tree.
+A typical local verification sequence is:
+
+```bash
+uv sync --extra dev
+cargo fmt --all --check
+cargo clippy --workspace --all-targets --all-features -- -D warnings
+uv run python scripts/run_rust_tests.py
+CALC_FLOW_CONNECTOR_CONTAINERS=1 \
+  CALC_FLOW_KAFKA_BOOTSTRAP=localhost:9092 \
+  CALC_FLOW_PG_TEST_URL=postgresql://postgres:postgres@localhost:5432/postgres \
+  CALC_FLOW_MYSQL_TEST_URL=mysql://root:calcflow-test@localhost:3306/calcflow \
+  CH_TEST_URL=http://localhost:8123 \
+  uv run python scripts/run_rust_coverage.py
+RUSTDOCFLAGS="-D warnings" cargo doc --workspace --all-features --no-deps
+
+uv run maturin develop
+JAX_PLATFORMS=cpu uv run pytest python/tests -q
+JAX_PLATFORMS=cpu uv run python scripts/run_examples.py
+uv run ruff check .
+uv run ruff format --check .
+
+cd web-ui/backend
+uv run --project . --extra dev pytest --cov=calc_flow_studio
+
+cd ..
+npm ci
+npm run sync:api
+npm run build
+npm test
+npm run test:e2e
+npm audit --omit=dev
+```
+
+Release gates also run `cargo audit`, `cargo deny --locked check`, package
+inspectors, isolated wheel smoke tests, `cargo package`, and
+`cargo publish --dry-run`. See [AGENTS.md](AGENTS.md) for the maintained
+repository commands and constraints.
+
+## Documentation
+
+- **[Documentation index](docs/README.md)** — reading order for all published docs
+- **[Introduction](docs/introduction.md)** — capabilities, vocabulary, and execution modes
+- **[getting started](docs/getting-started.md)** — installation and smoke test
+- **[Executable examples](docs/examples.md)** — verified example matrix and runner
+- **[Batch calculations](docs/batch-guide.md)** — expressions, SQL, UDFs, and async execution
+- **[Arrays and matrices](docs/array-guide.md)** — NumPy/JAX and static weights
+- **[Continuous streaming](docs/streaming-guide.md)** — source-to-recovery tutorial
+- **[Connectors](docs/connectors.md)** — transport configuration and guarantees
+- **[Projects and persistence](docs/projects-guide.md)** — JSON/YAML and file stores
+- **[Studio](docs/studio-guide.md)** — local editing, inspection, and job controls
+- **[Python API](docs/python-api.md)** — Python surface and examples
+- **[Symbolic workflows](docs/symbolic-workflows.md)** — declaration-to-Studio
+  batch, stream, recovery, static matrix, and performance workflows
+- **[Rust API](docs/rust-api.md)** — native surface and examples
+- **[API reference](docs/api-reference.md)** — supported surfaces at a glance
+- **[Symbolic API](docs/symbolic-api.md)** — declarations, analysis, and compile requirements
+- **[Design and architecture](docs/design.md)** — component ownership and execution design
+- **[Verification](docs/verification.md)** — documentation, examples, and implementation checks
+- **[Python release guide](docs/python-release.md)** — packaging, verification,
+  Trusted Publishers, and the PyPI procedure
+- **[Benchmark suite](docs/benchmark-suite.md)** — complete CI tables, scale matrices,
+  external-engine comparisons and historical regression evidence
+- **[Changelog](CHANGELOG.md)** — the single history of changes
+
+## License
+
+Apache-2.0 — see [LICENSE](LICENSE).
+

calc_flow_python-4.0.0.dist-info/RECORD

@@ -0,0 +1,35 @@
+calc_flow/__init__.py,sha256=P_XRJZ4t4d8uYuQdnFouQTm4xpK3exW1d_C9D9K_wGo,4059
+calc_flow/_native.pyd,sha256=mvysRAnFWdo86VKdztUXp0u_tm1q71wSbz_KWrFChbo,147412480
+calc_flow/_native.pyi,sha256=av4dj4RYKw_L5nXicJ78sJzV2WshamHhxrP3zARg04s,11413
+calc_flow/array.py,sha256=zytOlk3TkhmwFLRyDCVTJypCE9K8-PtqcIf1n546Bfk,45421
+calc_flow/capabilities.py,sha256=2CBdHuxqlbPymR-VBGzXzX1unQbtzo1RJzaqufjXP3U,29535
+calc_flow/config.py,sha256=lkKuKEmH41ptpXGyANvjGlxwnehwTeb6WFCCNx5v4gI,7838
+calc_flow/errors.py,sha256=iuPOFP2zD9ZQLVo38kZ7Tb0NvYDBeXFk2MjAXTonNxY,528
+calc_flow/join_spec.py,sha256=Kdz2_EQPkMVgefUNZxIFFopPqQNswuNm2md6o2UxkWE,5395
+calc_flow/pipeline.py,sha256=phiV3fQG2LZbrJ_lbKwG2V9cevb2Lwk53VYN1E6pSKk,41875
+calc_flow/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+calc_flow/runtime.py,sha256=QSJe4_uVCkb8rmTFm-X6fCcBEJme54mbIqgNe1mwBos,33238
+calc_flow/store.py,sha256=_-FM0LtHMuyNcLb431qGjPlPEXS4bjhXVJZCR_2bgJs,4845
+calc_flow/symbolic/__init__.py,sha256=FAnx4NlWyJhMo_GwiEzIvJTYEyV2dhdpcQfR-keZucM,1699
+calc_flow/symbolic/_generated_rolling_kernels.py,sha256=-G2tQAzl0n9THWRB3Davmil_L3W7dtIbC5I6wATCK4U,976
+calc_flow/symbolic/analyzer.py,sha256=r8cA6yskob_oQmezinXBBv3PXR9YP34hlvk9yBpmIFA,82892
+calc_flow/symbolic/domains.py,sha256=RV59EIBIy0dArXFZz97FIaVmDcjT3rC42-mdzmT5p84,2303
+calc_flow/symbolic/errors.py,sha256=CjIo6re4Or6WOIBnunN1YE-8oztORaR97uMnFir3WRc,1661
+calc_flow/symbolic/expr.py,sha256=bQXon0N1v_klF--hIsU4q2HyQste5VJmB_7p9M5NHjI,21471
+calc_flow/symbolic/lower/__init__.py,sha256=Q6ltOLc51HVrkeM-4JFGhFRaUCup2c9e2s0189fUVOE,1240
+calc_flow/symbolic/lower/planners.py,sha256=E4UyWxfmNQA-uawJInp64rxh803L-_-QOTrdlrJAEDs,45333
+calc_flow/symbolic/lower/program.py,sha256=Xd757t4rrPUnxBTApmalVBK08E5npD9kd4Xj-BpGlCk,31451
+calc_flow/symbolic/lower/segments.py,sha256=QRD3xshXrifIVTDOTBRJfNllcYKjEA-kgRNhlEklx9M,25065
+calc_flow/symbolic/lower/strategies.py,sha256=vuoNW-uKuFUYNaWmaRUqnn71oWHZZp4uMDboQb_C3fk,44610
+calc_flow/symbolic/nodes.py,sha256=SfwVGrNHTnsQK1NuhOsN4JDcbbHFy19DzeWiHubyG40,18305
+calc_flow/symbolic/ops.py,sha256=7QQPzeajuDmVDOJfXle6bR3CS9VqlG9Cpv9zmyPTg48,36690
+calc_flow/symbolic/optimizer.py,sha256=9Z0HngoZr6C1QHH8075p4ErEwHum9t7Ill4RL9HtdKc,21005
+calc_flow/symbolic/program.py,sha256=b-JvMRvL9s7JI0zh363OlpjE6nayvULhVpDqpsDJ7Kg,13149
+calc_flow/symbolic/types.py,sha256=YiyXesC0blFNKanztR5UmdYdye1XGCzAsJWG_X8i2Vk,3642
+calc_flow/symbolic/windows.py,sha256=EgzWH5i_5nUl6na6eXez4YHIEdQ1eYtv_xoSdol1658,5091
+calc_flow/udf.py,sha256=3vsY02jdxVEuUZdisaterxF7bvYu119nBLsToh6GhJY,778
+calc_flow_python-4.0.0.dist-info/METADATA,sha256=vGH6SdUOtKP1ZPL3XiVfsp-3_3LBbWmQzoiHANKIr6E,16762
+calc_flow_python-4.0.0.dist-info/WHEEL,sha256=ZabH5xxlwnCjl57ftEQBbNmdiu_GwBo2USq4vbg1zTo,96
+calc_flow_python-4.0.0.dist-info/licenses/LICENSE,sha256=Pd-b5cKP4n2tFDpdx27qJSIq0d1ok0oEcGTlbtL6QMU,11560
+calc_flow_python-4.0.0.dist-info/sboms/calc-flow-python.cyclonedx.json,sha256=4iNHeJNSxQiMeC83Z-O3p1qV0_sIVC2bIGVHflU_2wc,342282
+calc_flow_python-4.0.0.dist-info/RECORD,,

calc_flow_python-4.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: maturin (1.14.1)
+Root-Is-Purelib: false
+Tag: cp313-abi3-win_amd64

calc_flow_python-4.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.