aw-index-cli 0.1.0__tar.gz

aw_index_cli-0.1.0/.claude/envisioned-architecture.md

@@ -0,0 +1,232 @@
+# aw-index-cli — envisioned architecture & plan
+
+The **to-be** companion to [`initial-architecture.md`](initial-architecture.md)
+(the verified as-is). This is the target design for the full CLI — the four
+unbuilt commands, the workspace-state model they share, and the release/CI path
+— plus a phased roadmap. Forward-looking; revise as decisions land. Today only
+`compose` exists; `import`/`sync`/`check`/`refresh` are argparse stubs that exit 2.
+
+## Design north star
+
+Stay a **thin, honest consumer** of the autoware-index registry. The CLI never
+validates, builds, or resolves Autoware versions — those are the registry's
+sweeps. It composes selections into a workspace and reports what the registry
+already knows. Inherited values, non-negotiable: **fail loud, never
+silent-empty**; **deterministic/diffable output**; **one clone per repository**;
+**pure transforms with I/O at the edges**; **offline-capable where possible**;
+**never invent a green** (registry locked decision 6).
+
+## The pivotal decision: a lockfile sidecar
+
+Every unbuilt command must answer *"what was previously reconciled, and against
+which registry state?"* — and the `.repos` file alone cannot: it omits the
+registry commit, the `--tags` filter, and the resolved sha, and a `branch`
+ref's `value` carries no pinned commit. Three options were weighed
+(fully-stateless / lockfile sidecar / provenance embedded in the `.repos`
+header); **the sidecar wins**.
+
+**`repositories/<name>.lock.json`** sits next to `repositories/<name>.repos`
+(same `<name>`, default `autoware-index`), discovered by the same
+`find_repo_root` walk-up. The `.repos` stays vcstool's contract (*what to
+clone*); the lock is the CLI's (*what was composed, against which registry
+commit, resolved to which shas*). It is JSON (signals "generated, don't
+hand-edit"), sorted, and carries no wall-clock timestamp by default — so it
+diffs cleanly, mirroring `compose --no-timestamp`.
+
+```json
+{
+  "lock_version": 1,
+  "tool_version": "0.1.0",
+  "rosdistro": "jazzy",
+  "tags": ["sensing", "perception"],
+  "registry": {
+    "source": "github",
+    "repo": "autowarefoundation/autoware-index",
+    "ref": "main",
+    "commit": "b42b44f0c3a19d8e7f1c2b3a4d5e6f7081929394",
+    "path": null
+  },
+  "repositories": {
+    "livox-tools": {
+      "url": "https://github.com/autowarefoundation/autoware_livox_tag_filter",
+      "ref": { "kind": "branch", "value": "main" },
+      "resolved_sha": "6d9ff3512ab7c4e9018273645f8a9b0c1d2e3f40",
+      "packages": ["autoware_livox_decoder", "autoware_livox_tag_filter"]
+    }
+  }
+}
+```
+
+Field notes: `tags: null` = composed with no filter (all); `[]` = explicitly
+empty. `registry.commit` is the resolved registry sha (filled for github when
+resolvable; `null` for a local path). `resolved_sha` is `null` after `compose`
+(which stays offline/pure) and **filled by `import`/`sync`** from the clone HEAD
+vcstool actually produced; for `kind: sha` it equals `value`.
+
+**Why not stateless (the tempting option):** the registry itself isn't fully
+stateless — it keeps `state/<distro>/<repo_name>.json` cursors precisely because
+a level-trigger needs a recorded baseline to diff against. `sync`/`check` face
+the identical problem, so the same precedent applies one repo over. Stateless
+would also make a tag-scoped workspace spuriously report every other repo as a
+pending *remove* (no record of the tag filter), and would have no pinned sha to
+diff a `branch` ref against offline.
+
+**Cost to manage:** a second artifact that can drift from the `.repos` if
+hand-edited. Mitigation: every lock-consuming command runs a **lock-vs-`.repos`
+agreement check up front** and fails loud (new `LockError`) on mismatch.
+`compose` builds both from the *same* `select_repositories` result, so they
+agree by construction.
+
+## The five commands, envisioned
+
+| Command | Role | Network | Writes |
+|---|---|---|---|
+| `compose` | registry selection → `.repos` (+ lock) | optional fetch | `.repos`, `.lock.json` |
+| `import` | `compose` + `vcs import` + back-fill resolved shas | clone | `.repos`, `.lock.json`, `src/` |
+| `sync` | reconcile imported workspace ↔ current registry | fetch + targeted clones | `.repos`, `.lock.json`, `src/` |
+| `check` | honest status from the data branch (CI gate) | one branch fetch | nothing (read-only) |
+| `refresh` | refresh the local registry/data cache | fetch | cache only |
+
+All reuse the existing pure modules — `registry.load_distribution` /
+`describe_source` (the single version-gated source loader — no command adds a
+second fetch or a second schema gate), `compose.select_repositories` /
+`to_repos_entries` / `render_repos` / `provenance_header`, and
+`workspace.find_repo_root` / `output_path` (plus new siblings `lock_path` and
+`src_dir`).
+
+### `compose` (evolves)
+Externally unchanged except it now also emits `repositories/<name>.lock.json`
+beside the `.repos`, built by a new **pure** `compose.build_lock(distribution,
+*, tags, registry, tool_version) -> dict` that reuses `select_repositories` so
+the two artifacts are consistent by construction. `resolved_sha` is `null` at
+this stage; `registry.commit` is filled when the github fetch resolves a sha.
+Still offline/pure; `--stdout` still writes nothing to disk.
+
+### `import`
+The one-step materializer: resolve + select exactly like `compose`, write both
+artifacts, then `vcs import < repositories/<name>.repos` into
+`workspace.src_dir(repo_root)`, and finally read each clone's HEAD
+(`git -C <dir> rev-parse HEAD`) to back-fill `resolved_sha` into the lock. A
+**thin wrapper** — it never re-resolves refs or clones twice; it records what
+vcstool checked out. Reuses compose's flags verbatim (`--rosdistro`, `--tags`,
+`--registry-*`, `--repo-root`, `--name`), plus `--dry-run`. Re-running is
+self-reconciling (deterministic artifacts; `vcs import` re-checks the same
+versions).
+
+### `sync`
+Load the lock (prior intent: rosdistro + the exact `--tags` + registry
+coordinates + per-repo ref/sha/packages), re-read the **same** registry source,
+recompose the **same** selection (`select_repositories(distribution,
+tags=lock["tags"])` — this is what stops a tag-scoped workspace from reporting
+every other repo as a remove), and diff per `repo_name` into **adds / removes /
+ref-changes / package-set-changes**. `--dry-run` reports the plan
+deterministically; `--apply` rewrites both artifacts and re-checks out only
+changed/added entries (one clone or `ls-remote` each, honoring
+one-clone-per-repository). Removes are **warned, never auto-deleted** (don't
+destroy user work); `--force-checkout` is required to move a clone with local
+changes. Re-running after a clean apply is a no-op.
+
+### `check` — the honest-status probe (CI gate)
+Joins three real sources per registered package the consumer depends on
+(optionally narrowed to `--tags` and/or packages actually present in the
+workspace):
+1. **registry main** via `load_distribution` (same schema-2 gate) — `url`,
+   `ref`, `packages`;
+2. **data branch history** `history/<distro>/<package>.ndjson` — folding v1
+   (no `schema` field) and v2 lines;
+3. the **workspace** — each clone's HEAD sha (and the lock's `resolved_sha`).
+
+Reports per package: `current_status` (latest-by-`at` record: pass | fail |
+**unknown** when never swept — never coerced to green), `last_green` (the
+`autoware_version` of the most recent `status:pass`, or null), and **drift**
+(workspace HEAD vs lock `resolved_sha` vs registry `ref`). Locating the data
+branch: default **`--data git`** — one shallow `git fetch --depth 1 <remote>
+data` into an XDG cache, then `git show FETCH_HEAD:history/...`. **One network
+round-trip total**, independent of package count, and one atomic snapshot so all
+reads are mutually consistent. Offline layers honestly (a stale-or-missing cache
+is reported as such, never as a green). Exit codes for CI: `0` all-green, `1` a
+drift/fail result, `2` operational error — tunable via `--fail-on`/`--require`.
+
+### `refresh`
+Keeps the consumer's **local cache** of the registry (the distribution YAML and
+the data-branch history used by `check`) current, so `sync`/`check` can run
+offline and fast. Reuses `load_distribution` verbatim to re-fetch+gate; keys the
+cache off the resolved `registry.commit`; skips-if-current (no churn when
+upstream hasn't moved). With no lock it errors ("run compose first") rather than
+doing nothing — the deliberate "cut a command that does nothing useful" guard.
+(If we later choose a no-cache variant, `refresh` folds into `sync`; the design
+keeps that exit open.)
+
+## New surface this introduces
+
+- **`lock.py`** (new module): `build`/`load`/`dump`/`diff_locks` + `LockError`,
+  the lock-vs-`.repos` agreement check. Pure where possible.
+- **`workspace.py`** gains `lock_path(repo_root, name)` and `src_dir(repo_root)`
+  (mirroring `output_path`, so all paths stay one-sourced and discovered alike).
+- **data-branch reader** (in a small `data.py` or under `check`): the cached
+  shallow-fetch + NDJSON fold; mirrors `site/build.py`'s `summarize` (sort by
+  `at`, latest wins; greens give last-green).
+- **error model:** `RegistryError` (load/version) + `ComposeError` (shape) +
+  new `LockError` (lock load / `.repos` disagreement), all mapped uniformly to
+  `error: …` + non-zero exit in the command handlers.
+
+## Release / CI / packaging (registry roadmap B2 + H9)
+
+- **Repo + publish:** create `autowarefoundation/aw-index-cli`, push `main`
+  (merge the local `feat/registry-v2` first — only a v2 CLI composes the now-v2
+  registry). Add governance files + the org `semantic-pull-request` / `sync-files`
+  reusables; protect `main` (no-delete/no-force-push + DCO / pre-commit.ci /
+  pytest). **PyPI via Trusted Publishing (OIDC)**, not a long-lived token —
+  register the pending publisher before the first release.
+- **Versioning:** already single-sourced (`__init__.__version__`); tag-driven
+  (bare `X.Y.Z`), with a guard asserting tag == built version. Stay `0.x` while
+  the surface grows; reserve `1.0.0` for a stable command set + locked schema-2
+  coupling.
+- **CI (four workflows):** `lint.yaml` (ruff + ruff-format + actionlint via
+  pre-commit; run `pre-commit autoupdate` once, don't `pre-commit install`),
+  `test.yaml` (pytest matrix py3.10–3.13, one aggregate `tests` job as the
+  required check), `build.yaml` (sdist+wheel + `twine check`), `publish.yaml`
+  (OIDC publish on tag). Mirror the registry's CI shapes.
+- **e2e proof:** an `e2e.yaml` job *inside* `ghcr.io/autowarefoundation/autoware:
+  core-devel-jazzy-<ver>`: `pip install .` → `aw-index-cli compose` (or
+  `import`) → `vcs import` → `rosdep install` → `colcon build --packages-up-to
+  autoware_livox_tag_filter` green. Closes the registry's B2 proof from the
+  consumer side. (`git config --global --add safe.directory '*'` to pre-empt the
+  sweep's dubious-ownership Bug D.)
+
+## Phased roadmap
+
+1. **Lock foundation** — `lock.py` + `workspace.lock_path`/`src_dir` +
+   `compose.build_lock`; `compose` emits the lock; the agreement guard; tests.
+   *(No new command yet — de-risks the pivotal decision first.)*
+2. **`import`** — thin `vcs import` wrapper + resolved-sha back-fill +
+   `--dry-run`; the `compose → import` happy path tested offline (vcstool
+   mocked) and once for real.
+3. **`check`** — the data-branch reader + cached shallow fetch + the join +
+   CI-grade exit codes. Highest standalone value (works without a prior import).
+4. **`sync`** — the lock-vs-registry diff (adds/removes/ref-changes) + safe
+   apply; depends on 1–2.
+5. **`refresh`** — the registry/data cache + skip-if-current; depends on 3.
+6. **Release** — governance + four CI workflows + e2e proof; create the GitHub
+   repo, push, PyPI OIDC, tag `0.1.0` (compose-only is already shippable; later
+   commands ship as `0.x` minors).
+
+Sequencing rule: **the lockfile lands before any command that reads it** (1
+before 2/4/5); `check` (3) is independent and can ship early as the highest-value
+read-only gate. Each command reuses the existing pure modules — the version gate
+stays single-sourced, transforms stay pure, I/O stays at the edges (the
+"Extending it" rules in the as-is doc).
+
+## Open questions
+
+- **State model:** commit the lockfile alongside the `.repos`, or gitignore it?
+  (Reproducibility argues for committing; needs a one-line docs decision.)
+- **`compose`'s partial lock:** offline `compose` writes `resolved_sha: null`;
+  confirm consumers/`check` treat a null sha as "not yet imported," not drift.
+- **`check` data access:** default `--data git` shallow-fetch vs per-file raw
+  fetch — confirm git is an acceptable hard-ish dependency for `check`.
+- **`refresh`'s reason to exist** hinges on the cache; if `check` proves fast
+  enough with a per-run fetch, consider folding `refresh` into `sync`/`check`.
+- **Release specifics:** PyPI ownership (org vs individual; reserve on
+  test.pypi), the publish gate (required reviewer vs maintainer tag-push for
+  0.x), and whether the e2e container is pinned or tracks latest.

aw_index_cli-0.1.0/.claude/initial-architecture.md

@@ -0,0 +1,228 @@
+# aw-index-cli — architecture
+
+Internal map for contributors and agents. User-facing usage lives in
+[`README.md`](../README.md); this doc covers *how the pieces fit*, the
+contracts they depend on, and where to extend. Keep it reconciled when the
+module boundaries or the registry coupling change.
+
+## What this is (and is not)
+
+`aw-index-cli` is the **consumer** side of the [autoware-index][index]
+ecosystem. It reads a distribution manifest — `distributions/<rosdistro>.yaml`,
+`schema_version: "2"`, the registry's source of truth — and renders a
+[vcstool][vcstool] `.repos` slice you can `vcs import` into a workspace.
+
+It is deliberately **not**:
+
+- a validator or builder — the registry's sweep workflows
+  (`autoware-index-github-actions`) clone, build, and test packages and record
+  history; this CLI never touches a container or runs colcon.
+- an Autoware-version resolver — the registry tracks **one ref per
+  repository**, resolved against the freshest Autoware release at *sweep* time,
+  never stored. `compose` selects nothing by Autoware version; `--autoware` is
+  recorded in the header for provenance only.
+- networked beyond one optional read — its only outbound call is fetching the
+  distribution YAML from `raw.githubusercontent.com` when `--registry-path` is
+  omitted.
+
+The single implemented command is `compose`. `import`/`sync`/`check`/`refresh`
+are registered stubs (see *Deliberately absent*).
+
+## Package layout
+
+```
+src/aw_index_cli/
+  __init__.py     # __version__ (single source of truth; hatchling reads it)
+  __main__.py     # `python -m aw_index_cli` -> SystemExit(main())
+  cli.py          # argparse surface + _cmd_compose orchestration
+  registry.py     # load + schema_version-gate the distribution YAML
+  compose.py      # select repos -> .repos entries -> rendered document
+  workspace.py    # discover the repo root and the output path
+tests/            # pytest, one module per source module (+ conftest)
+pyproject.toml    # hatchling, src-layout, console script aw-index-cli
+```
+
+Build: hatchling, src-layout, `requires-python >= 3.10`, single runtime
+dependency `pyyaml>=6`. Version is single-sourced from `__init__.py`
+(`[tool.hatch.version]`). Console script `aw-index-cli = aw_index_cli.cli:main`.
+Local-only so far — no git remote, not on PyPI.
+
+## Module responsibilities
+
+### `registry.py` — source loading + the version gate
+
+`load_distribution(ros_distro, *, path=None, repo=DEFAULT_REPO, ref=DEFAULT_REF,
+timeout=30) -> dict` is the single entry point for getting a distribution.
+
+- **Source resolution.** With `path`: a file is read directly, a directory is
+  resolved to `<dir>/distributions/<ros_distro>.yaml`. Without `path`: fetched
+  from `RAW_URL = raw.githubusercontent.com/{repo}/{ref}/distributions/{ros_distro}.yaml`.
+- **The gate.** Every failure mode — missing file, HTTP error, timeout, URL
+  error, non-UTF-8, YAML parse error, non-mapping document, **`schema_version`
+  != `"2"`** (`SUPPORTED_SCHEMA_VERSION`), `ros_distro` mismatch, `repositories`
+  not a mapping, or any repository spec not a mapping — raises `RegistryError`
+  with a specific message. The guiding rule: **never produce silently empty
+  output for a document we do not understand.** A v1 (or future) document is a
+  loud non-zero failure, not an empty `.repos`.
+- `describe_source(*, path, repo, ref) -> str` returns the provenance string
+  (`local path <p>` or `<repo>@<ref>`) shown in the header.
+
+This is the only module that knows where YAML comes from or what version is
+acceptable. `SUPPORTED_SCHEMA_VERSION` is the one place the CLI's registry
+coupling is pinned.
+
+### `compose.py` — the transform
+
+The pure registry→`.repos` pipeline, three stages plus the header builder:
+
+1. `select_repositories(distribution, tags=None) -> list[(key, spec,
+   selected_packages)]`, sorted by repo key. A **package** is selected when
+   `tags` is empty/`None` or its own `tags` intersect the wanted set; a
+   **repository** is selected when ≥1 of its packages is selected; the selected
+   package names are sorted. A repository whose `packages` is not a mapping
+   raises `ComposeError`.
+2. `to_repos_entries(repositories) -> dict` maps each selected repo to a
+   vcstool entry `{type: "git", url, version: ref.value, packages: [...]}`.
+   Invariants that matter:
+   - the entry key is the **registry repository key**, never a URL basename —
+     so a monorepo's packages collapse to exactly **one clone**;
+   - `ref.kind` is **never read** — vcstool is kind-agnostic, so `version` is
+     `ref.value` verbatim (tag, branch, or sha all work);
+   - `packages` is a **manifest** of the selected registered package names
+     (vcstool ignores unknown keys), so a downstream `colcon build
+     --packages-up-to <names>` can scope to exactly what was asked for;
+   - missing `url`, missing `ref.value`, or a non-mapping `ref` each raise
+     `ComposeError`.
+3. `render_repos(distribution, *, tags, header_lines) -> str` re-runs selection,
+   builds entries, and emits `header + yaml.safe_dump({"repositories": entries},
+   sort_keys=False)`. `sort_keys=False` preserves the `type/url/version/packages`
+   field order; cross-entry order is already sorted by `select_repositories`.
+
+`provenance_header(...)` builds the leading `# …` comment block (tool version,
+source, rosdistro, tags, optional `autoware`, optional `generated_at`, and a
+per-repository "selected packages" listing), ending with a do-not-edit notice.
+
+`ComposeError` covers every *shape* failure once the document has loaded;
+`RegistryError` covers *loading/version*. Both are caught together in the CLI.
+
+### `workspace.py` — output location
+
+- `find_repo_root(start)` walks up from `start` (inclusive) to the first
+  ancestor containing a `repositories/` directory; falls back to the resolved
+  `start` if none is found.
+- `output_path(repo_root, name="autoware-index")` →
+  `<repo_root>/repositories/<name>.repos`.
+
+No registry knowledge — pure path discovery, so it stays trivially testable.
+
+### `cli.py` — argparse surface + orchestration
+
+`_build_parser()` defines `--version`, the `compose` subparser (all its flags),
+and the four stubs. `_cmd_compose(args)` is the only real handler and wires the
+pipeline:
+
+```
+load_distribution ─▶ describe_source ─▶ select_repositories ─▶ provenance_header
+                                              │                        │
+                                              └──────────▶ render_repos ┘
+                                                                 │
+                              --stdout ? print : write to output_path / --output
+```
+
+The two success paths diverge: with `--stdout` the rendered YAML is printed to
+**stdout** and the handler returns `0` immediately — no summary. On the
+file-write path it writes to `--output` (or the discovered
+`<repo_root>/repositories/<name>.repos`) and prints `Wrote N repository
+entr(y|ies) covering P registered package(s) to <path>: key (pkgs), …` to
+**stderr**. `RegistryError`/`ComposeError` → `error: <msg>` on stderr, exit `1`.
+Stubs print "not implemented yet" and exit `2`; no subcommand prints help and
+exits `2`. `main(argv=None) -> int` is the console-script entry and returns the
+exit code.
+
+## The compose data flow, end to end
+
+```
+distributions/<distro>.yaml (schema_version 2, repository-keyed)
+        │  registry.load_distribution  (local path OR raw.githubusercontent.com; gate on "2")
+        ▼
+   parsed dict
+        │  compose.select_repositories(tags)   → (key, spec, selected_packages) sorted
+        │  compose.to_repos_entries            → key -> {type,url,version,packages}
+        │  compose.provenance_header           → # comment lines
+        ▼
+   compose.render_repos → header + YAML
+        │  cli: --stdout → print, else workspace.find_repo_root + output_path → write
+        ▼
+   <repo_root>/repositories/<name>.repos      → `vcs import < …`
+```
+
+## Registry contract this CLI is coupled to
+
+`compose` reads, but does not own, the v2 distribution schema
+(`autoware-index/schema/distribution.schema.json`). The fields it depends on:
+
+| Path | Use |
+|------|-----|
+| `schema_version == "2"` | hard gate in `registry.load_distribution` |
+| `ros_distro` | must equal the requested distro |
+| `repositories.<key>` | entry key → `.repos` key + clone dir |
+| `repositories.<key>.url` | `.repos` `url` (required) |
+| `repositories.<key>.ref.value` | `.repos` `version` (required; `kind` ignored) |
+| `repositories.<key>.packages.<name>.tags` | `--tags` selection |
+
+Lockstep (one ref per repository, no per-package ref) is what lets a monorepo
+collapse to a single `.repos` entry; ref skew is unrepresentable upstream, so
+the CLI never has to reconcile divergent refs within a repository. If the
+registry bumps `schema_version`, this CLI must move in lockstep — bump
+`SUPPORTED_SCHEMA_VERSION` and the readers together; until then a newer document
+fails loudly rather than mis-composing.
+
+## Invariants & design decisions
+
+- **Fail loud, never empty.** Any unparseable/unsupported input is a non-zero
+  error with a specific message — there is no "best effort" partial `.repos`.
+- **Determinism.** `--no-timestamp` drops `generated_at`; repositories and
+  package names are sorted; `sort_keys=False` keeps field order. Same input →
+  byte-identical output, so generated `.repos` files diff cleanly.
+- **One clone per repository.** Keying `.repos` by the registry repo key (not a
+  URL basename) is what makes monorepo dedup correct and collision-free.
+- **`compose` is pure + offline-capable.** `select_repositories`/
+  `to_repos_entries`/`render_repos`/`provenance_header` take plain dicts and do
+  no I/O, so they unit-test without network or filesystem.
+- **Two error types, one catch.** `RegistryError` (load/version) and
+  `ComposeError` (shape) are distinct at the raise site but handled uniformly
+  in `_cmd_compose`.
+
+## Deliberately absent
+
+- `import` / `sync` / `check` / `refresh` are parser stubs that exit `2`. They
+  exist so `--help` lists the planned surface; they hold no logic and bake in no
+  assumptions. (`check` is intended to read the `data` branch history for drift;
+  `import` would wrap `vcs import`.)
+- No build/validate/version-resolution — those are the registry's job (see
+  *What this is and is not*).
+
+## Testing
+
+`pytest` (config in `pyproject.toml`: `pythonpath = ["src"]`, `testpaths =
+["tests"]`). One test module per source module — `test_registry.py`,
+`test_compose.py`, `test_cli.py`, `test_workspace.py` — plus `conftest.py`.
+Coverage includes the schema_version gate (v1/missing/garbage rejection),
+monorepo collapse and tag-filtered subsetting, the malformed-shape error
+paths, and `--no-timestamp` determinism.
+
+## Extending it (adding a real command)
+
+1. Add a subparser in `_build_parser()` and a `_cmd_<name>` handler;
+   `set_defaults(func=…)`. Remove the name from `STUB_COMMANDS`.
+2. Reuse `registry.load_distribution` for any registry read — do not re-fetch or
+   re-gate elsewhere; the version gate must stay single-sourced.
+3. Keep transforms pure where possible (mirror `compose.py`) and push I/O to the
+   handler so the logic stays unit-testable.
+4. Raise `RegistryError`/`ComposeError` (or a new sibling) for expected
+   failures; let `_cmd_*` map them to `error: …` + a non-zero exit.
+5. Add a `tests/test_<name>.py`; assert the failure messages, not just exit
+   codes.
+
+[index]: https://github.com/autowarefoundation/autoware-index
+[vcstool]: https://github.com/dirk-thomas/vcstool

aw_index_cli-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+__pycache__/
+*.py[cod]
+.pytest_cache/
+dist/
+build/
+log/
+*.egg-info/
+.venv/
+.idea/

aw_index_cli-0.1.0/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.