worph 0.1.5__tar.gz

worph-0.1.5/.ci_shims/morph_kgc/__init__.py

@@ -0,0 +1 @@
+from worph import *

worph-0.1.5/.ci_shims/morph_kgc/__main__.py

@@ -0,0 +1,3 @@
+from worph.__main__ import main
+if __name__ == "__main__":
+    raise SystemExit(main())

worph-0.1.5/.github/workflows/ci.yml

@@ -0,0 +1,153 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+      - rewrite/**
+    tags:
+      - "[0-9]*.[0-9]*.[0-9]*"
+      - "v[0-9]*.[0-9]*.[0-9]*"
+  pull_request:
+
+jobs:
+  test-and-examples:
+    runs-on: ubuntu-latest
+    timeout-minutes: 45
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Install dependencies
+        run: |
+          uv sync --extra test
+          uv pip install pandas pyarrow
+
+      - name: Install package
+        run: uv pip install -e .
+
+      - name: Create CI compatibility shim (morph_kgc -> worph)
+        run: |
+          mkdir -p .ci_shims/morph_kgc
+          cat > .ci_shims/morph_kgc/__init__.py <<'PY'
+          from worph import *
+          PY
+          cat > .ci_shims/morph_kgc/__main__.py <<'PY'
+          from worph.__main__ import main
+          if __name__ == "__main__":
+              raise SystemExit(main())
+          PY
+
+      - name: Run all tests
+        env:
+          PYTHONPATH: .ci_shims:src
+        run: |
+          uv run pytest -q
+
+      - name: Prepare example fixtures
+        run: |
+          uv run python - <<'PY'
+          import sqlite3
+          from pathlib import Path
+          import pandas as pd
+
+          # postgres example local sqlite DB
+          pdb = Path("examples/postgres/example.db")
+          pdb.parent.mkdir(parents=True, exist_ok=True)
+          con = sqlite3.connect(pdb)
+          con.execute("DROP TABLE IF EXISTS postgres_tablename")
+          con.execute("CREATE TABLE postgres_tablename (id TEXT)")
+          con.executemany("INSERT INTO postgres_tablename (id) VALUES (?)", [("1",), ("2",), ("3",)])
+          con.commit()
+          con.close()
+
+          # rdb example local sqlite DB built from CSV sample files
+          gdb = Path("examples/rdb/gtfs.db")
+          if gdb.exists():
+              gdb.unlink()
+          con = sqlite3.connect(gdb)
+          base = Path("examples/csv/data")
+          for name in [
+              "STOP_TIMES",
+              "TRIPS",
+              "ROUTES",
+              "AGENCY",
+              "STOPS",
+              "CALENDAR",
+              "CALENDAR_DATES",
+              "FEED_INFO",
+              "SHAPES",
+              "FREQUENCIES",
+          ]:
+              csv_path = base / f"{name}.csv"
+              if csv_path.exists():
+                  df = pd.read_csv(csv_path)
+                  df.to_sql(name, con, index=False, if_exists="replace")
+          con.close()
+
+          # s3_parquet example local parquet file
+          parquet_path = Path("examples/s3_parquet/data.parquet")
+          parquet_path.parent.mkdir(parents=True, exist_ok=True)
+          pd.DataFrame({"id": [1, 2, 3]}).to_parquet(parquet_path, index=False)
+          PY
+
+      - name: Run example matrix
+        env:
+          PYTHONPATH: .ci_shims:src
+        run: |
+          set -euo pipefail
+
+          run_example() {
+            name="$1"
+            shift
+            echo "== $name =="
+            "$@"
+          }
+
+          run_example "csv-config" uv run python -m worph examples/csv/config.ini
+          run_example "json-config" uv run python -m worph examples/json/config.ini
+          run_example "xml-config" uv run python -m worph examples/xml/config.ini
+          run_example "postgres-config" uv run python -m worph examples/postgres/config.ini
+          run_example "rdb-config" bash -lc 'cd examples/rdb && uv run python -m worph config.ini'
+          run_example "s3-parquet-config" uv run python -m worph examples/s3_parquet/config.ini
+          run_example "dataframe-script" uv run python examples/dataframe/kg_generation.py
+          run_example "dict-script" uv run python examples/dict/kg_generation.py
+          run_example "dynamic-api-token" uv run python examples/dynamic_api_token.py
+
+  publish:
+    if: startsWith(github.ref, 'refs/tags/')
+    needs: test-and-examples
+    runs-on: ubuntu-latest
+    timeout-minutes: 20
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Setup uv
+        uses: astral-sh/setup-uv@v5
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          print-hash: true

worph-0.1.5/.gitignore

@@ -0,0 +1,10 @@
+__pycache__/
+*.py[cod]
+*.so
+.pytest_cache/
+.mypy_cache/
+.venv/
+venv/
+dist/
+build/
+*.egg-info/

worph-0.1.5/AGENTS.md

@@ -0,0 +1,93 @@
+# AGENTS.md
+
+Repository-level instructions for agents working in `worph`.
+
+## Scope and Precedence
+
+- This file applies to the whole repository.
+- These rules override higher-level defaults when they conflict.
+
+## Required Context Discovery
+
+Before proposing or implementing changes:
+
+1. Read [README.md](README.md).
+2. Read [CONTRIBUTING.md](CONTRIBUTING.md) if present.
+3. Inspect [pyproject.toml](pyproject.toml) for dependencies and extras.
+4. Inspect the relevant area under `src/worph/` and matching tests under `test/`.
+5. If present and relevant, read `specs/lessons-learned.md`.
+
+Do not change code before understanding the local module boundaries and nearby tests.
+
+## Project Layout and Boundaries
+
+- Python package code lives in `src/worph/`.
+- Main entry points:
+  - CLI: `src/worph/__main__.py`
+  - Public API: `src/worph/__init__.py`
+  - Materialization flow: `src/worph/materializer.py`
+- Core submodules:
+  - `core/`: configuration, mapping parsing, source loading, term maps, and emitters.
+  - `fnml/`: FNML built-ins and execution.
+
+Respect these boundaries. Keep orchestration in `materializer`, parsing/loading in `core`, and function execution logic in `fnml`.
+
+## Build, Environment, and Dependency Rules
+
+- Build backend: `hatchling` (configured in `pyproject.toml`).
+- Preferred environment manager: `uv`.
+- Install for development/testing:
+  - `uv sync` when lock/config supports it, otherwise:
+  - `uv pip install -e '.[test]'`
+  - Fallback if `uv` is unavailable: `pip install -e '.[test]'`
+- Do not add new dependencies unless the user explicitly approves.
+
+## Testing and Verification
+
+- Test framework: `pytest`.
+- Start with smallest relevant scope:
+  - Single test file or directory under `test/...`
+  - Expand only if required by impact.
+- Typical commands:
+  - `uv run pytest test/<area>/<case>/test_*.py`
+  - `uv run pytest test/issues/issue_<n>`
+  - `PYTHONPATH=.ci_shims:src uv run pytest -q` (compat mode/full suite)
+  - `uv run pytest` (full suite, non-shim mode)
+- For behavior changes, update/add tests in the closest existing test area.
+- Do not claim completion without reporting what tests were run and their results.
+
+## Change Discipline
+
+- Keep patches minimal and focused; avoid unrelated refactors.
+- Preserve existing coding style and naming in touched files.
+- Reuse existing helpers/utilities before introducing new abstractions.
+- Avoid architecture changes unless explicitly requested.
+- Do not modify unrelated files.
+- In specs/docs, use relative paths only. Do not use absolute paths.
+
+## Repository Subagents (`specs/agents`)
+
+- Use only the minimum specialist set needed for the task.
+- Keep the loaded agent set small (max 3 specialists for most tasks).
+- Default specialist pair when uncertain: `python-expert` + `reviewer`.
+- Available specialist briefs live in `specs/agents/`:
+  - `python-expert.md`
+  - `oop-gof-expert.md`
+  - `yarrrml-rml-rdf-xpath-expert.md`
+  - `gh-expert.md`
+  - `reviewer.md`
+
+## Safety and Git Rules
+
+- Never use destructive git commands (for example `git reset --hard`) unless explicitly requested.
+- Do not push, open PRs, or rewrite history unless explicitly instructed.
+- If unexpected repository changes appear while working, stop and ask how to proceed.
+
+## Communication Expectations
+
+At task completion, report:
+
+1. What was changed.
+2. Which files were modified.
+3. Which tests were run and outcomes.
+4. Any residual risks or follow-up work.

worph-0.1.5/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.

worph-0.1.5/PKG-INFO

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: worph
+Version: 0.1.5
+Summary: Rewrite baseline for Morph-KGC v2
+License-File: LICENSE
+Requires-Python: >=3.10
+Requires-Dist: morph-kgc<3.0.0,>=2.10.0
+Requires-Dist: odfpy<2.0.0,>=1.4.0
+Requires-Dist: openpyxl<4.0.0,>=3.1.0
+Requires-Dist: pyarrow<100.0.0,>=17.0.0
+Requires-Dist: pyshp<4.0.0,>=2.3.0
+Requires-Dist: pyyaml<7.0.0,>=6.0.0
+Requires-Dist: shapely<3.0.0,>=2.0.0
+Requires-Dist: sqlalchemy<3.0.0,>=2.0.0
+Provides-Extra: test
+Requires-Dist: pytest<9.0.0,>=8.0.0; extra == 'test'
+Description-Content-Type: text/markdown
+
+<p align="center">
+  <img src="assets/worph-logo.png" alt="worph logo" width="180">
+</p>
+
+# worph
+
+[![CI](https://github.com/wordlift/worph/actions/workflows/ci.yml/badge.svg)](https://github.com/wordlift/worph/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/worph.svg)](https://pypi.org/project/worph/)
+[![Python](https://img.shields.io/badge/python-3.10%20to%203.13-3776AB?logo=python&logoColor=white)](https://github.com/wordlift/worph/blob/main/pyproject.toml)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+
+`worph` is a public project at [`wordlift/worph`](https://github.com/wordlift/worph), forked from [`morph-kgc`](https://github.com/morph-kgc/morph-kgc). It keeps compatibility with retained `morph_kgc` imports while evolving the primary implementation under `src/worph/`.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Repository Layout](#repository-layout)
+- [Quick Start](#quick-start)
+- [CLI Commands](#cli-commands)
+- [Testing](#testing)
+- [Compatibility](#compatibility)
+- [Documentation](#documentation)
+- [Release](#release)
+- [License](#license)
+
+## Overview
+
+`worph` provides RML/YARRRML materialization flows with compatibility for existing `morph_kgc` consumers. The codebase includes regression suites and compatibility shims used in CI to validate behavior against retained tests.
+
+## Repository Layout
+
+- `src/worph/`: primary package implementation
+- `.ci_shims/morph_kgc/`: compatibility shim re-exporting from `worph`
+- `test/`: regression and issue-driven test suites
+- `examples/`: runnable configs and sample scripts
+- `specs/`: compatibility, playbook, and agent-guidance documents
+- `specs/agents/`: specialist subagent briefs used during planning/review
+- `docs/`: operational documentation
+
+## Quick Start
+
+```bash
+uv sync --extra test
+uv run python -m worph examples/csv/config.ini
+```
+
+## CLI Commands
+
+Run using the package entrypoint:
+
+```bash
+uv run worph examples/json/config.ini
+```
+
+Equivalent module form:
+
+```bash
+uv run python -m worph examples/xml/config.ini
+```
+
+## Testing
+
+Run full CI-aligned tests with shim compatibility enabled:
+
+```bash
+PYTHONPATH=.ci_shims:src uv run pytest -q
+```
+
+Run the explicit shim validation test:
+
+```bash
+PYTHONPATH=.ci_shims:src uv run pytest -q test/test_ci_shim_uses_worph.py
+```
+
+## Compatibility
+
+Some retained tests still import `morph_kgc`. CI sets `PYTHONPATH=.ci_shims:src` so imports resolve to `.ci_shims/morph_kgc` first, then delegate to `worph`.
+
+## Documentation
+
+- [docs/compatibility-shims.md](docs/compatibility-shims.md)
+- [specs/COMPATIBILITY.md](specs/COMPATIBILITY.md)
+- [specs/lessons-learned.md](specs/lessons-learned.md)
+
+## Release
+
+Publishing to PyPI is handled inside `.github/workflows/ci.yml`.
+
+- Trigger: push a version tag like `0.1.5` or `v0.1.5`
+- Gate: `publish` job runs only after `test-and-examples` succeeds
+- Auth: PyPI Trusted Publisher (OIDC)
+
+Trusted Publisher settings on `pypi.org`:
+
+- Owner: `wordlift`
+- Repository: `worph`
+- Workflow name: `ci.yml`
+- Environment: empty (unless you add one in GitHub)
+
+## License
+
+All code and documentation in this repository are licensed under the Apache License 2.0.

worph-0.1.5/README.md

@@ -0,0 +1,102 @@
+<p align="center">
+  <img src="assets/worph-logo.png" alt="worph logo" width="180">
+</p>
+
+# worph
+
+[![CI](https://github.com/wordlift/worph/actions/workflows/ci.yml/badge.svg)](https://github.com/wordlift/worph/actions/workflows/ci.yml)
+[![PyPI version](https://img.shields.io/pypi/v/worph.svg)](https://pypi.org/project/worph/)
+[![Python](https://img.shields.io/badge/python-3.10%20to%203.13-3776AB?logo=python&logoColor=white)](https://github.com/wordlift/worph/blob/main/pyproject.toml)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](LICENSE)
+
+`worph` is a public project at [`wordlift/worph`](https://github.com/wordlift/worph), forked from [`morph-kgc`](https://github.com/morph-kgc/morph-kgc). It keeps compatibility with retained `morph_kgc` imports while evolving the primary implementation under `src/worph/`.
+
+## Table of Contents
+
+- [Overview](#overview)
+- [Repository Layout](#repository-layout)
+- [Quick Start](#quick-start)
+- [CLI Commands](#cli-commands)
+- [Testing](#testing)
+- [Compatibility](#compatibility)
+- [Documentation](#documentation)
+- [Release](#release)
+- [License](#license)
+
+## Overview
+
+`worph` provides RML/YARRRML materialization flows with compatibility for existing `morph_kgc` consumers. The codebase includes regression suites and compatibility shims used in CI to validate behavior against retained tests.
+
+## Repository Layout
+
+- `src/worph/`: primary package implementation
+- `.ci_shims/morph_kgc/`: compatibility shim re-exporting from `worph`
+- `test/`: regression and issue-driven test suites
+- `examples/`: runnable configs and sample scripts
+- `specs/`: compatibility, playbook, and agent-guidance documents
+- `specs/agents/`: specialist subagent briefs used during planning/review
+- `docs/`: operational documentation
+
+## Quick Start
+
+```bash
+uv sync --extra test
+uv run python -m worph examples/csv/config.ini
+```
+
+## CLI Commands
+
+Run using the package entrypoint:
+
+```bash
+uv run worph examples/json/config.ini
+```
+
+Equivalent module form:
+
+```bash
+uv run python -m worph examples/xml/config.ini
+```
+
+## Testing
+
+Run full CI-aligned tests with shim compatibility enabled:
+
+```bash
+PYTHONPATH=.ci_shims:src uv run pytest -q
+```
+
+Run the explicit shim validation test:
+
+```bash
+PYTHONPATH=.ci_shims:src uv run pytest -q test/test_ci_shim_uses_worph.py
+```
+
+## Compatibility
+
+Some retained tests still import `morph_kgc`. CI sets `PYTHONPATH=.ci_shims:src` so imports resolve to `.ci_shims/morph_kgc` first, then delegate to `worph`.
+
+## Documentation
+
+- [docs/compatibility-shims.md](docs/compatibility-shims.md)
+- [specs/COMPATIBILITY.md](specs/COMPATIBILITY.md)
+- [specs/lessons-learned.md](specs/lessons-learned.md)
+
+## Release
+
+Publishing to PyPI is handled inside `.github/workflows/ci.yml`.
+
+- Trigger: push a version tag like `0.1.5` or `v0.1.5`
+- Gate: `publish` job runs only after `test-and-examples` succeeds
+- Auth: PyPI Trusted Publisher (OIDC)
+
+Trusted Publisher settings on `pypi.org`:
+
+- Owner: `wordlift`
+- Repository: `worph`
+- Workflow name: `ci.yml`
+- Environment: empty (unless you add one in GitHub)
+
+## License
+
+All code and documentation in this repository are licensed under the Apache License 2.0.