scanisaur 0.0.1__py3-none-any.whl

scanisaur/__init__.py

@@ -0,0 +1,10 @@
+"""Scanisaur: schema-aware pre-flight checks for AI-agent SQL."""
+
+from importlib.metadata import PackageNotFoundError, version
+
+try:
+    __version__ = version("scanisaur")
+except PackageNotFoundError:  # running from a source tree that isn't installed
+    __version__ = "0.0.0"
+
+__all__ = ["__version__"]

scanisaur/__main__.py

@@ -0,0 +1,3 @@
+from scanisaur.cli import app
+
+app(prog_name="scanisaur")

scanisaur/cli.py

@@ -0,0 +1,41 @@
+"""Command-line entry point."""
+
+from typing import Annotated
+
+import typer
+
+from scanisaur import __version__
+
+app = typer.Typer(
+    name="scanisaur",
+    help="Schema-aware pre-flight checks for AI-agent SQL.",
+    no_args_is_help=True,
+    add_completion=False,
+)
+
+
+def _print_version(value: bool) -> None:
+    if value:
+        typer.echo(f"scanisaur {__version__}")
+        raise typer.Exit
+
+
+@app.callback()
+def main(
+    version: Annotated[
+        bool,
+        typer.Option(
+            "--version",
+            callback=_print_version,
+            is_eager=True,
+            help="Show the version and exit.",
+        ),
+    ] = False,
+) -> None:
+    """Schema-aware pre-flight checks for AI-agent SQL."""
+
+
+@app.command("version")
+def version_command() -> None:
+    """Show the version."""
+    typer.echo(f"scanisaur {__version__}")

scanisaur/engine/__init__.py

@@ -0,0 +1 @@
+"""SQL analysis engine."""

scanisaur/engine/facts.py

@@ -0,0 +1,444 @@
+"""Per-table facts extracted from a qualified SQL syntax tree.
+
+Rules and the cost estimator read these facts instead of walking the syntax tree
+themselves. The input must already be qualified (``sqlglot.optimizer.qualify``
+with ``expand_stars=False``), so every column carries the alias of its source.
+"""
+
+from __future__ import annotations
+
+from collections import Counter
+from collections.abc import Iterator
+from dataclasses import dataclass
+from typing import Literal
+
+from sqlglot import exp
+from sqlglot.optimizer.scope import Scope, find_all_in_scope, traverse_scope
+
+#: BigQuery pseudo-columns that sqlglot leaves unqualified.
+PSEUDO_COLUMNS = frozenset({"_table_suffix", "_partitiontime", "_partitiondate"})
+
+# sqlglot renames node arguments between major versions. Fail at import rather than
+# silently treating every ``SELECT * EXCEPT (...)`` as reading all columns.
+_STAR_EXCEPT_ARG = "except_"
+if _STAR_EXCEPT_ARG not in exp.Star.arg_types:  # pragma: no cover
+    raise ImportError(f"unsupported sqlglot version: exp.Star has no {_STAR_EXCEPT_ARG!r}")
+
+ComparisonOp = Literal["=", "<", "<=", ">", ">=", "between", "in", "other"]
+Clause = Literal["where", "on", "qualify"]
+
+_COMPARISONS: dict[type[exp.Expr], ComparisonOp] = {
+    exp.EQ: "=",
+    exp.LT: "<",
+    exp.LTE: "<=",
+    exp.GT: ">",
+    exp.GTE: ">=",
+}
+_FLIPPED: dict[ComparisonOp, ComparisonOp] = {"<": ">", "<=": ">=", ">": "<", ">=": "<="}
+
+
+@dataclass(frozen=True, slots=True)
+class TableRef:
+    project: str | None
+    dataset: str | None
+    name: str
+    alias: str
+
+    @property
+    def qualified_name(self) -> str:
+        return ".".join(part for part in (self.project, self.dataset, self.name) if part)
+
+
+@dataclass(frozen=True, slots=True)
+class Predicate:
+    """A filter condition that involves columns of exactly one table reference."""
+
+    column: str
+    op: ComparisonOp
+    #: SQL of the compared value(s); empty unless ``constant``.
+    values: tuple[str, ...]
+    #: True when compared only against constants (literals, ``CURRENT_DATE()`` arithmetic).
+    constant: bool
+    #: Function wrapping the column, such as ``DATE`` or ``CAST``; None for a bare column.
+    wrapper: str | None
+    clause: Clause
+    sql: str
+
+
+@dataclass(frozen=True, slots=True)
+class Join:
+    target: str
+    target_kind: Literal["table", "unnest", "derived"]
+    side: str | None
+    kind: str | None
+    has_condition: bool
+    #: Equality pairs such as ("e.user_id", "u.user_id"), from ON or from WHERE.
+    keys: tuple[tuple[str, str], ...]
+
+
+@dataclass(frozen=True, slots=True)
+class TableFacts:
+    table: TableRef
+    #: Columns read from the table; with ``star`` the query reads every column...
+    columns: frozenset[str]
+    star: bool
+    #: ...except these (BigQuery ``SELECT * EXCEPT (...)``).
+    star_except: frozenset[str]
+    predicates: tuple[Predicate, ...]
+    #: How many times the table is scanned; a CTE referenced twice counts twice.
+    scans: int
+
+
+@dataclass(frozen=True, slots=True)
+class QueryFacts:
+    tables: tuple[TableFacts, ...]
+    joins: tuple[Join, ...]
+    outer_limit: int | None
+    outer_aggregated: bool
+
+
+def extract(expression: exp.Expr, dialect: str = "bigquery") -> QueryFacts:
+    """Extract facts from a qualified query (SELECT, set operation, or pipe syntax)."""
+    scopes = traverse_scope(expression)
+    if not scopes:
+        raise ValueError("expression is not a query")
+    scans = _scan_counts(scopes)
+
+    tables: list[TableFacts] = []
+    joins: list[Join] = []
+    for scope in scopes:
+        if scans[id(scope)] == 0 or not isinstance(scope.expression, exp.Select):
+            continue
+        tables.extend(_table_facts(scope, scans[id(scope)], dialect))
+        joins.extend(_joins(scope))
+
+    root = _effective_root(scopes[-1])
+    limit, aggregated = _outer_shape(root.expression)
+    return QueryFacts(tuple(tables), tuple(joins), limit, aggregated)
+
+
+def _scan_counts(scopes: list[Scope]) -> Counter[int]:
+    """Count how many times each scope runs: CTEs once per reference, unused CTEs zero."""
+    counts: Counter[int] = Counter({id(scopes[-1]): 1})
+    for scope in reversed(scopes):  # traverse_scope yields children first
+        runs = counts[id(scope)]
+        for _node, source in scope.selected_sources.values():
+            if isinstance(source, Scope):
+                counts[id(source)] += runs
+        for child in [*scope.subquery_scopes, *scope.set_operation_scopes]:
+            counts[id(child)] += runs
+    return counts
+
+
+def _table_sources(scope: Scope) -> dict[str, exp.Table]:
+    return {
+        alias: source
+        for alias, (_node, source) in scope.selected_sources.items()
+        if isinstance(source, exp.Table)
+    }
+
+
+def _table_facts(scope: Scope, scans: int, dialect: str) -> Iterator[TableFacts]:
+    sources = _table_sources(scope)
+    if not sources:
+        return
+    lone_alias = next(iter(sources)) if len(sources) == 1 else None
+    starred = _starred_aliases(scope, sources)
+    predicates = list(_predicates(scope, sources, lone_alias, dialect))
+
+    for alias, table in sources.items():
+        columns = frozenset(
+            column.name.lower()
+            for column in scope.columns
+            if _owner(column, lone_alias) == alias and column.name.lower() not in PSEUDO_COLUMNS
+        )
+        yield TableFacts(
+            table=TableRef(
+                project=table.catalog or None,
+                dataset=table.db or None,
+                name=table.name,
+                alias=alias,
+            ),
+            columns=columns,
+            star=alias in starred,
+            star_except=starred.get(alias, frozenset()),
+            predicates=tuple(p for owner, p in predicates if owner == alias),
+            scans=scans,
+        )
+
+
+def _owner(column: exp.Column, lone_alias: str | None) -> str | None:
+    """The alias a column belongs to; unqualified pseudo-columns go to a scope's only table."""
+    if column.table:
+        return column.table
+    if column.name.lower() in PSEUDO_COLUMNS:
+        return lone_alias
+    return None
+
+
+def _starred_aliases(scope: Scope, sources: dict[str, exp.Table]) -> dict[str, frozenset[str]]:
+    """Aliases selected with a star, mapped to the columns their ``EXCEPT`` leaves out."""
+    select = scope.expression
+    assert isinstance(select, exp.Select)
+    starred: dict[str, frozenset[str]] = {}
+    for projection in select.expressions:
+        if isinstance(projection, exp.Star):
+            excluded = _star_except(projection)
+            starred.update(dict.fromkeys(sources, excluded))
+        elif isinstance(projection, exp.Column) and isinstance(projection.this, exp.Star):
+            if projection.table in sources:
+                starred[projection.table] = _star_except(projection.this)
+    return starred
+
+
+def _star_except(star: exp.Star) -> frozenset[str]:
+    return frozenset(column.name.lower() for column in star.args.get(_STAR_EXCEPT_ARG) or [])
+
+
+def _conjuncts(condition: exp.Expr | None) -> Iterator[exp.Expr]:
+    if condition is None:
+        return
+    if isinstance(condition, exp.Paren):
+        yield from _conjuncts(condition.this)
+    elif isinstance(condition, exp.And):
+        yield from _conjuncts(condition.left)
+        yield from _conjuncts(condition.right)
+    else:
+        yield condition
+
+
+def _clauses(scope: Scope) -> Iterator[tuple[Clause, exp.Expr]]:
+    select = scope.expression
+    where = select.args.get("where")
+    if where is not None:
+        yield from (("where", c) for c in _conjuncts(where.this))
+    for join in select.args.get("joins") or []:
+        yield from (("on", c) for c in _conjuncts(join.args.get("on")))
+    qualify = select.args.get("qualify")
+    if qualify is not None:
+        yield from (("qualify", c) for c in _conjuncts(qualify.this))
+
+
+def _local_columns(node: exp.Expr) -> list[exp.Column]:
+    """Columns in ``node`` that belong to this scope, not to a nested subquery."""
+    return [
+        column
+        for column in node.find_all(exp.Column)
+        if not isinstance(column.this, exp.Star)
+        and column.find_ancestor(exp.Select, exp.Subquery) is node.find_ancestor(exp.Select)
+    ]
+
+
+def _has_subquery(node: exp.Expr) -> bool:
+    return node.find(exp.Select, exp.Subquery) is not None
+
+
+def _is_constant(node: exp.Expr) -> bool:
+    return not _local_columns(node) and not _has_subquery(node)
+
+
+def _wrapper(side: exp.Expr) -> str | None:
+    """The function around a column, ignoring parentheses and struct field access."""
+    while isinstance(side, exp.Paren | exp.Dot):
+        side = side.this
+    if isinstance(side, exp.Column):
+        return None
+    if isinstance(side, exp.Func):
+        return side.sql_name()
+    return side.key.upper()
+
+
+def _predicates(
+    scope: Scope, sources: dict[str, exp.Table], lone_alias: str | None, dialect: str
+) -> Iterator[tuple[str, Predicate]]:
+    for clause, condition in _clauses(scope):
+        columns = _local_columns(condition)
+        owners = {_owner(column, lone_alias) for column in columns}
+        if len(owners) != 1:
+            continue
+        owner = owners.pop()
+        if owner not in sources:
+            continue
+        predicate = _classify(condition, clause, dialect)
+        if predicate is not None:
+            yield owner, predicate
+
+
+def _classify(condition: exp.Expr, clause: Clause, dialect: str) -> Predicate | None:
+    sql = condition.sql(dialect=dialect)
+
+    def other() -> Predicate | None:
+        columns = _local_columns(condition)
+        if not columns:
+            return None
+        return Predicate(columns[0].name.lower(), "other", (), False, None, clause, sql)
+
+    def make(side: exp.Expr, op: ComparisonOp, others: list[exp.Expr]) -> Predicate | None:
+        columns = _local_columns(side)
+        if not columns:  # e.g. CURRENT_DATE() BETWEEN valid_from AND valid_to
+            return other()
+        constant = bool(others) and all(_is_constant(value) for value in others)
+        values = tuple(value.sql(dialect=dialect) for value in others) if constant else ()
+        return Predicate(columns[0].name.lower(), op, values, constant, _wrapper(side), clause, sql)
+
+    comparison = _COMPARISONS.get(type(condition))
+    if comparison is not None and isinstance(condition, exp.Binary):
+        left, right = condition.left, condition.right
+        if _local_columns(left) and not _local_columns(right):
+            return make(left, comparison, [right])
+        if _local_columns(right) and not _local_columns(left):
+            return make(right, _FLIPPED.get(comparison, comparison), [left])
+        return other()
+    if isinstance(condition, exp.Between):
+        return make(condition.this, "between", [condition.args["low"], condition.args["high"]])
+    if isinstance(condition, exp.In):
+        return make(condition.this, "in", _in_values(condition))
+    if isinstance(condition, exp.Or):
+        disjunction = _equality_disjunction(condition)
+        if disjunction is not None:
+            side, values = disjunction
+            return make(side, "in", values)
+    return other()
+
+
+def _in_values(condition: exp.In) -> list[exp.Expr]:
+    """The right-hand side of IN: a list, a subquery, or UNNEST of an array."""
+    query = condition.args.get("query")
+    if query is not None:
+        return [query]
+    unnest = condition.args.get("unnest")
+    if unnest is not None:
+        arrays = unnest.expressions
+        if len(arrays) == 1 and isinstance(arrays[0], exp.Array):
+            return list(arrays[0].expressions)
+        return list(arrays)
+    return list(condition.expressions)
+
+
+def _disjuncts(condition: exp.Expr) -> Iterator[exp.Expr]:
+    if isinstance(condition, exp.Paren):
+        yield from _disjuncts(condition.this)
+    elif isinstance(condition, exp.Or):
+        yield from _disjuncts(condition.left)
+        yield from _disjuncts(condition.right)
+    else:
+        yield condition
+
+
+def _equality_disjunction(
+    condition: exp.Or,
+) -> tuple[exp.Expr, list[exp.Expr]] | None:
+    """Treat ``x = 'a' OR x = 'b'`` like ``x IN ('a', 'b')``, which BigQuery can prune."""
+    side: exp.Expr | None = None
+    values: list[exp.Expr] = []
+    for disjunct in _disjuncts(condition):
+        if not isinstance(disjunct, exp.EQ):
+            return None
+        left, right = disjunct.left, disjunct.right
+        if _local_columns(left) and _is_constant(right):
+            this, value = left, right
+        elif _local_columns(right) and _is_constant(left):
+            this, value = right, left
+        else:
+            return None
+        if side is not None and this != side:
+            return None
+        side = this
+        values.append(value)
+    return (side, values) if side is not None else None
+
+
+def _joins(scope: Scope) -> Iterator[Join]:
+    select = scope.expression
+    where = select.args.get("where")
+    where_conjuncts = list(_conjuncts(where.this)) if where is not None else []
+    for join in select.args.get("joins") or []:
+        target = join.this
+        alias = target.alias_or_name
+        kind: Literal["table", "unnest", "derived"]
+        if isinstance(target, exp.Unnest):
+            kind = "unnest"
+        elif isinstance(scope.sources.get(alias), exp.Table):
+            kind = "table"
+        else:
+            kind = "derived"
+        on_conjuncts = list(_conjuncts(join.args.get("on")))
+        keys = [
+            *_equality_keys(on_conjuncts, alias),
+            *_equality_keys(where_conjuncts, alias),
+        ]
+        yield Join(
+            target=alias,
+            target_kind=kind,
+            side=join.side or None,
+            kind=join.kind or None,
+            # ON TRUE, ON 1 = 1 or a filter on one side alone doesn't connect the tables.
+            has_condition=bool(keys) or any(_links(c, alias) for c in on_conjuncts),
+            keys=tuple(keys),
+        )
+
+
+def _links(condition: exp.Expr, alias: str) -> bool:
+    """True when a condition relates the join target to some other source."""
+    owners = {column.table for column in _local_columns(condition)}
+    return alias in owners and len(owners) > 1
+
+
+def _equality_keys(
+    conditions: Iterator[exp.Expr] | list[exp.Expr], alias: str
+) -> Iterator[tuple[str, str]]:
+    for condition in conditions:
+        if not isinstance(condition, exp.EQ):
+            continue
+        left, right = condition.left, condition.right
+        if not (isinstance(left, exp.Column) and isinstance(right, exp.Column)):
+            continue
+        if left.table == right.table or alias not in (left.table, right.table):
+            continue
+        yield (f"{left.table}.{left.name.lower()}", f"{right.table}.{right.name.lower()}")
+
+
+def _effective_root(scope: Scope) -> Scope:
+    """Skip pass-through wrappers such as ``SELECT * FROM (...)`` and pipe-syntax CTEs."""
+    while True:
+        select = scope.expression
+        if not isinstance(select, exp.Select) or len(scope.selected_sources) != 1:
+            return scope
+        if any(select.args.get(key) for key in ("where", "group", "having", "qualify", "limit")):
+            return scope
+        if select.args.get("joins") or not all(
+            isinstance(p, exp.Star | exp.Column) for p in select.expressions
+        ):
+            return scope
+        ((_node, source),) = scope.selected_sources.values()
+        if not isinstance(source, Scope):
+            return scope
+        scope = source
+
+
+def _outer_shape(expression: exp.Expr) -> tuple[int | None, bool]:
+    limit_node = expression.args.get("limit")
+    limit: int | None = None
+    if limit_node is not None:
+        value = limit_node.expression
+        if isinstance(value, exp.Literal) and value.is_int:
+            limit = int(value.this)
+    return limit, _aggregated(expression)
+
+
+def _aggregated(expression: exp.Expr) -> bool:
+    """True when the query returns one row per group rather than one per input row."""
+    if isinstance(expression, exp.Subquery):
+        return _aggregated(expression.this)
+    if isinstance(expression, exp.SetOperation):
+        return _aggregated(expression.left) and _aggregated(expression.right)
+    if not isinstance(expression, exp.Select):
+        return False
+    if expression.args.get("group"):
+        return True
+    # Aggregates inside scalar subqueries or window functions don't collapse the rows.
+    return any(
+        aggregate.find_ancestor(exp.Window) is None
+        for projection in expression.expressions
+        for aggregate in find_all_in_scope(projection, exp.AggFunc)
+    )

scanisaur-0.0.1.dist-info/METADATA

@@ -0,0 +1,61 @@
+Metadata-Version: 2.5
+Name: scanisaur
+Version: 0.0.1
+Summary: Schema-aware pre-flight checks for AI-agent SQL, using warehouse metadata only.
+Project-URL: Homepage, https://github.com/tjslezak/Scanisaur
+Project-URL: Issues, https://github.com/tjslezak/Scanisaur/issues
+Author: Scanisaur contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai-agents,bigquery,data-warehouse,mcp,query-optimization,sql
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Database
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: sqlglot<31,>=30.21
+Requires-Dist: typer>=0.15
+Description-Content-Type: text/markdown
+
+# Scanisaur
+The apex predator of agent-generated SQL.
+
+Scanisaur is an [MCP](https://modelcontextprotocol.io) server that AI agents call **before** they run SQL. It reads only warehouse metadata (tables, columns, types, partitioning, clustering, row counts and sizes) and uses it to:
+
+- **validate** the query: are these tables and columns real?
+- **optimize** it: catch missing partition filters, `SELECT *` on wide tables, joins with no condition and other costly patterns, each with a concrete fix;
+- **quantify** it: estimate bytes scanned and cost before anything runs.
+
+Scanisaur never reads table data and never runs the queries it checks. The agent's own SQL tool does that.
+
+> **Status: pre-alpha.** Nothing is published yet. BigQuery is the first supported warehouse; Snowflake follows.
+
+## Planned MCP tools
+
+| Tool | Purpose |
+| --- | --- |
+| `scanisaur_schema_search` | Find relevant tables and columns by keyword |
+| `scanisaur_schema_describe` | Compact, token-efficient table descriptions with partition and cluster keys |
+| `scanisaur_check_sql` | Verdict (`pass`, `warn`, `block`), cost estimate, findings with fixes, and a tracking tag |
+
+## Development
+
+You need [uv](https://docs.astral.sh/uv/).
+
+```bash
+uv sync
+uv run scanisaur --version
+uv run pytest
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for the full set of checks, and [docs/adr/](docs/adr/) for the design decisions so far.
+
+## License
+
+[Apache License 2.0](LICENSE)

scanisaur-0.0.1.dist-info/RECORD

@@ -0,0 +1,11 @@
+scanisaur/__init__.py,sha256=3Kc0QOOeotTyGzWJhQc88pBKkQEgzepAnj-6aAzywTw,306
+scanisaur/__main__.py,sha256=OA-_EXWmngoZ8J4HfNrMws_SKxpSFkjbf6gdK99nvHs,58
+scanisaur/cli.py,sha256=Ggcl5glXA0FujSxw3ZwhU9MmF3kmUkzuzhcLmV1-Qik,845
+scanisaur/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+scanisaur/engine/__init__.py,sha256=74zkKSKd_r4YPl0Pmrg2mGDIVrtNBV3NTL7NPMuiyzw,27
+scanisaur/engine/facts.py,sha256=ST6JI94N5QlzOtojwiachBLdr_pIymwbqVRDn14G2QU,16470
+scanisaur-0.0.1.dist-info/METADATA,sha256=iMGCbRAudwO58-4dUS_KOnl_Xu_gQ8ONfMMLBBoZw1A,2449
+scanisaur-0.0.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+scanisaur-0.0.1.dist-info/entry_points.txt,sha256=5gdecoK_1hJtd6plzu8ouoveOJQF0BvjNPB480IMNTo,48
+scanisaur-0.0.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+scanisaur-0.0.1.dist-info/RECORD,,

scanisaur-0.0.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

scanisaur-0.0.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+scanisaur = scanisaur.cli:app

scanisaur-0.0.1.dist-info/licenses/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.