quadkit-testing 0.0.3__tar.gz → 0.0.4__tar.gz

quadkit_testing-0.0.4/.gitignore

@@ -0,0 +1,183 @@
+*
+!tests/
+!tests/**
+!README.md
+!AGENTS.md
+!DEVELOPMENT.md
+!QUICKGUIDE.md
+!MILESTONE*.md
+!TESTS*.md
+!CHANGELOG.md
+!AUDIT*.md
+!REF*.md
+!AUDIT*.json
+!LICENSE
+!LICENSE-MIT.txt
+!NOTICE
+!TRADEMARK.md
+!conftest.py
+!CONTRIBUTING.md
+!CODE_OF_CONDUCT.md
+!SECURITY.md
+!GOVERNANCE.md
+!pyproject.toml
+!uv.lock
+!docker-compose.yml
+!.env.example
+!.env.full.example
+!.importlinter
+!.superpowers/
+!.superpowers/**
+!.gitattributes
+!.editorconfig
+!Makefile
+!docker-compose.test.yml
+!quadkit.yaml.example
+!.github/
+!.github/workflows/
+!.github/workflows/**
+!.github/dependabot.yml
+!.devcontainer/
+!.devcontainer/**
+!tools/
+!tools/**
+!*example.yaml
+
+# Quadkit Packages
+!quadkit*/
+!quadkit*/pyproject.toml
+!quadkit*/CHANGELOG.md
+!quadkit*/README.md
+!quadkit*/alembic.ini
+!quadkit*/mypy.ini
+!quadkit*/*.yaml.example
+!quadkit*/src/
+!quadkit*/src/**
+!quadkit*/docs/
+!quadkit*/docs/**
+!quadkit*/tests/
+!quadkit*/tests/**
+
+# Keep quadkit docs
+!/docs/
+!docs/**
+
+# Session / cutover plans at the repo root
+!plans/
+!plans/**
+
+# Keep example files for README examples
+!/examples/
+!/examples/**
+
+# Re-ignore these AFTER negations (last match wins)
+*.tape
+examples/*/runs/
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+dist/
+build/
+.eggs/
+*.egg
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+test.db
+!quadkit*/tests/fixtures/test.db
+*.log
+*.tmp
+
+# Company-specific files (keep private, do not commit)
+.company/
+COMPANY_*.md
+company-config/
+internal-docs/
+# Editor swap files
+*.swp
+
+!core/
+!packages/
+!core/quadkit*/
+!packages/quadkit*/
+!core/quadkit*/pyproject.toml
+!packages/quadkit*/pyproject.toml
+!core/quadkit*/CHANGELOG.md
+!packages/quadkit*/CHANGELOG.md
+!core/quadkit*/README.md
+!packages/quadkit*/README.md
+!core/quadkit*/alembic.ini
+!packages/quadkit*/alembic.ini
+!core/quadkit*/mypy.ini
+!packages/quadkit*/mypy.ini
+!core/quadkit*/*.yaml.example
+!packages/quadkit*/*.yaml.example
+!core/quadkit*/src/
+!core/quadkit*/src/**
+!packages/quadkit*/src/
+!packages/quadkit*/src/**
+!core/quadkit*/tests/
+!core/quadkit*/tests/**
+!packages/quadkit*/tests/
+!packages/quadkit*/tests/**
+!core/quadkit*/docs/
+!core/quadkit*/docs/**
+!packages/quadkit*/docs/
+!packages/quadkit*/docs/**
+
+# dev/
+!dev/
+!dev/**
+
+# Admin dev playground (committed dev asset; local SQLite files stay ignored)
+!packages/quadkit-admin/playground/
+!packages/quadkit-admin/playground/serve.py
+
+# gatewai apps
+!apps/
+!apps/**
+!apps/gatewai/
+!apps/gatewai/**
+apps/**/node_modules/
+apps/**/dist/
+apps/**/__pycache__/
+apps/**/*.pyc
+apps/**/*.db
+apps/**/*.db-wal
+apps/**/*.db-shm
+
+# Re-exclude private content under the tiered paths.
+# MUST come after the !...docs/** negations above — last match wins.
+core/quadkit*/docs/plans/
+packages/quadkit*/docs/plans/
+core/quadkit*/docs/**/
+packages/quadkit*/docs/**/
+
+# Re-exclude tooling artifacts under the tiered paths
+__pycache__/
+*.pyc
+*.pyo
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.coverage
+coverage.xml
+test.db
+*.tmp
+*.log
+!core/quadkit*/tests/fixtures/test.db
+!packages/quadkit*/tests/fixtures/test.db
+
+# Allow the generated example gifs to be tracked (README hero images).
+!core/quadkit*/docs/gifs/
+!core/quadkit*/docs/gifs/**
+!packages/*/quadkit*/docs/gifs/
+!packages/*/quadkit*/docs/gifs/**
+examples/*/screenshot.png
+!banner*

quadkit_testing-0.0.4/PKG-INFO

@@ -0,0 +1,270 @@
+Metadata-Version: 2.5
+Name: quadkit-testing
+Version: 0.0.4
+Summary: Centralized testing infrastructure for Quadkit Framework - Fixtures, factories, and utilities
+Project-URL: Homepage, https://dbtinoy-.github.io/quadkit/
+Project-URL: Repository, https://github.com/dbtinoy-/quadkit
+Project-URL: Documentation, https://dbtinoy-.github.io/quadkit/
+Project-URL: Issues, https://github.com/dbtinoy-/quadkit/issues
+Project-URL: Changelog, https://github.com/dbtinoy-/quadkit/blob/main/CHANGELOG.md
+Author-email: Quadkit Framework Team <team@quadkit.dev>
+Maintainer-email: Quadkit Framework Team <team@quadkit.dev>
+License: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: async,factories,fixtures,framework,mocking,pytest,testing
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: AsyncIO
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+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: Topic :: Software Development :: Testing
+Classifier: Typing :: Typed
+Requires-Python: >=3.11
+Requires-Dist: pytest-asyncio<2,>=0.21.0
+Requires-Dist: pytest-cov<8,>=4.0.0
+Requires-Dist: pytest-mock<4,>=3.10.0
+Requires-Dist: pytest<10,>=8.0.0
+Requires-Dist: quadkit-contracts>=0.0.2
+Requires-Dist: quadkit>=0.0.2
+Provides-Extra: all
+Requires-Dist: aiosqlite<1,>=0.19.0; extra == 'all'
+Requires-Dist: asyncpg<1,>=0.29.0; extra == 'all'
+Requires-Dist: httpx2<3,>=2.0.0; extra == 'all'
+Requires-Dist: httpx<1,>=0.26.0; extra == 'all'
+Requires-Dist: quadkit-auth>=0.0.2; extra == 'all'
+Requires-Dist: quadkit-cache>=0.0.2; extra == 'all'
+Requires-Dist: quadkit-storage>=0.0.2; extra == 'all'
+Requires-Dist: starlette<2,>=0.28.0; extra == 'all'
+Provides-Extra: auth
+Requires-Dist: quadkit-auth>=0.0.2; extra == 'auth'
+Provides-Extra: cache
+Requires-Dist: quadkit-cache>=0.0.2; extra == 'cache'
+Provides-Extra: db
+Requires-Dist: aiosqlite<1,>=0.19.0; extra == 'db'
+Requires-Dist: asyncpg<1,>=0.29.0; extra == 'db'
+Requires-Dist: quadkit-sql>=0.0.2; extra == 'db'
+Provides-Extra: dev
+Requires-Dist: black<27,>=23.0.0; extra == 'dev'
+Requires-Dist: mypy<3,>=1.0.0; extra == 'dev'
+Requires-Dist: ruff<1,>=0.16.4; extra == 'dev'
+Provides-Extra: integration
+Requires-Dist: aiokafka<1,>=0.12.0; extra == 'integration'
+Requires-Dist: aiosqlite<1,>=0.19.0; extra == 'integration'
+Requires-Dist: asyncpg<1,>=0.29.0; extra == 'integration'
+Requires-Dist: elasticsearch[async]<10,>=8.12.0; extra == 'integration'
+Requires-Dist: motor<4,>=3.3.0; extra == 'integration'
+Requires-Dist: neo4j<7,>=5.18.0; extra == 'integration'
+Requires-Dist: qdrant-client<2,>=1.9.0; extra == 'integration'
+Requires-Dist: redis<9,>=5.0.0; extra == 'integration'
+Provides-Extra: storage
+Requires-Dist: quadkit-storage>=0.0.2; extra == 'storage'
+Provides-Extra: web
+Requires-Dist: httpx2<3,>=2.0.0; extra == 'web'
+Requires-Dist: httpx<1,>=0.26.0; extra == 'web'
+Requires-Dist: starlette<2,>=0.28.0; extra == 'web'
+Description-Content-Type: text/markdown
+
+# quadkit-testing
+
+![Quadkit](https://raw.githubusercontent.com/dbtinoy-/quadkit/main/banner.jpg)
+
+[![PyPI](https://img.shields.io/pypi/v/quadkit-testing?color=%2322c55e&label=pypi)](https://pypi.org/project/quadkit-testing/)
+[![Python](https://img.shields.io/pypi/pyversions/quadkit-testing?color=%2322c55e)](https://pypi.org/project/quadkit-testing/)
+[![License](https://img.shields.io/pypi/l/quadkit-testing?color=%2322c55e)](https://github.com/dbtinoy-/quadkit/blob/main/LICENSE)
+
+Test harnesses, fakes, and fixtures for Quadkit applications: boot the
+real application in-process, substitute bindings instead of mocking
+import sites, and assert on responses with helpers that say what
+failed.
+
+For anyone writing tests against Quadkit applications — and for tooling
+that needs drop-in implementations of the framework's protocols.
+
+## The quadkit family
+
+| Package | Role |
+| --- | --- |
+| [`quadkit-contracts`](https://pypi.org/project/quadkit-contracts/) | zero-dependency protocols, types, exception hierarchy |
+| [`quadkit`](https://pypi.org/project/quadkit/) | the framework core — DI container, modules, config, logging, `Result` |
+| [`quadkit-web`](https://pypi.org/project/quadkit-web/) | ASGI layer — controllers, routing, middleware, OpenAPI docs |
+| [`quadkit-cli`](https://pypi.org/project/quadkit-cli/) | project scaffolding and code generators |
+| [`quadkit-testing`](https://pypi.org/project/quadkit-testing/) | in-process test beds, fakes, fixtures |
+
+## Installation
+
+```bash
+uv add --dev quadkit-testing
+```
+
+Requires **Python >= 3.11**.
+
+## Minimal working example
+
+Test an HTTP route with the real application, in-process:
+
+```python
+import pytest
+
+from quadkit.testing import WebTestBed
+
+from my_app import create_app
+
+
+@pytest.mark.asyncio
+async def test_hello() -> None:
+    async with WebTestBed(create_app()) as bed:
+        response = bed.get("/hello", params={"name": "quadkit"})
+        response.assert_status(200)
+        assert response.json == {"message": "hello, quadkit"}
+```
+
+Or test services directly, with binding overrides:
+
+```python
+async def test_service() -> None:
+    from quadkit.testing import AppTestBed
+
+    async with AppTestBed.from_factory(
+        create_app, overrides={Cache: FakeCache()}
+    ) as bed:
+        service = await bed.app.container.resolve(UserService)
+```
+
+A pytest plugin registers automatically via entry points — no
+`conftest.py` wiring — and provides auto-registered fixtures including
+`fake_cache`, `fake_event_bus`, `fake_logger`, `fake_clock`,
+`fake_command_bus`, `fake_query_bus`, `fake_unit_of_work`,
+`fake_metrics`, `fake_config`, `fake_state_store`, `test_bed`,
+`test_container`, and `test_data`:
+
+```python
+import pytest
+
+from quadkit.contracts.domain.events import DomainEvent
+
+
+class UserCreated(DomainEvent):
+    user_id: str
+    email: str
+
+
+@pytest.mark.asyncio
+async def test_signup_publishes(fake_event_bus) -> None:
+    await fake_event_bus.publish(UserCreated(user_id="1", email="a@b.c"))
+    fake_event_bus.assert_published(UserCreated, user_id="1")
+
+
+def test_trial_expiry_is_deterministic(fake_clock) -> None:
+    t0 = fake_clock.now()
+    fake_clock.advance(30 * 24 * 3600)
+    assert (fake_clock.now() - t0).days == 30
+```
+
+## Optional extras
+
+| Extra | Contents |
+| --- | --- |
+| `[web]` | `httpx` + Starlette — the `WebTestBed` client transport |
+| `[db]` | `aiosqlite`, `asyncpg` — drivers for your async DB test suites |
+| `[integration]` | service clients for integration suites (Redis, MongoDB, Kafka, Elasticsearch, Neo4j, Qdrant, PostgreSQL, SQLite) |
+| `[dev]` | `ruff`, `mypy`, `black` |
+
+## Public API entry points
+
+### Test beds
+
+```python
+from quadkit.testing import AppTestBed, WebTestBed
+```
+
+- `AppTestBed.from_factory(factory, overrides=None)` /
+  `AppTestBed.from_app(app)` — application-level beds.
+- `WebTestBed(app_or_provider, raise_server_exceptions=True)` with
+  `get/post/put/patch/delete`, `override(Contract, impl)` (before
+  boot), and `TestResponse` — `status_code`, `headers`, `text`,
+  `json` (property), `assert_status`, `assert_json`,
+  `assert_json_path`, `assert_header`.
+- `quadkit.testing.fixtures.container.ContainerTestFixture` — DI-level
+  fixture with `mock()`, `override()`, `get()`, `get_optional()`.
+- `quadkit.testing.fixtures.bed.TestEnvironment` — programmatic
+  environment builder (`use_provider`, `override`, `fake`, `resolve`).
+- `quadkit.testing.lib.factory.TestDataFactory` — deterministic
+  `create_user()`, `create_task()`, `create_message()`,
+  `create_request()`.
+
+### Fakes (`quadkit.testing.fakes`)
+
+All in-process, async-native, implementing the same contracts as the
+real services:
+
+| Class | Covers |
+| --- | --- |
+| `FakeCache` / `FakeStateStore` | cache and state storage |
+| `FakeEventBus` | in-process events with `assert_published()`, `published_of_type()`, `assert_events_in_order()` and friends |
+| `FakeCommandBus` / `FakeQueryBus` | command / query dispatch |
+| `FakeUnitOfWork` | unit-of-work context |
+| `FakeClock` (+ `Clock`, `SystemClock`) | deterministic time |
+| `FakeConfig` | config overrides |
+| `FakeLogger` (+ `LogEntry`) | structlog-compatible sink |
+| `FakeMetricsCollector` / `FakeResourceUnitTracker` | metrics / resource tracking |
+| `FakeRedisClient` | Redis-protocol client |
+| `FakeAuditLogger` | audit records |
+| `FakeTracer` / `FakeSpan` | tracing |
+
+The published wheel carries the `ai`, `db` and `web` test clients and beds
+plus the fakes and fixtures that need no private package. The `auth`,
+`cache`, `events`, `search`, `storage`, `tasks`, `ui` test clients, the
+AI/DB/task fixture modules, the secrets fake and `IntegrationEnvironment`
+stay in this repository until their packages publish; asking the published
+wheel for one raises `AttributeError` naming the module.
+
+## Configuration
+
+None required — the pytest plugin self-registers. Mark suites for
+external services and gate them yourself (e.g.
+`uv run pytest -m "not integration"`).
+
+## Error handling
+
+Test beds surface failures, they don't hide them: with
+`raise_server_exceptions=True` (the default) unexpected exceptions
+re-raise into your test with their original traceback; HTTP-expected
+failures assert on the response instead.
+
+## Testing
+
+Ironically self-hosted: this package's public tests are among the
+suite the release executes from the exported tree against the built
+wheels.
+
+## Security
+
+Fakes are in-process and safe to wire into unit suites. Report
+vulnerabilities privately per [SECURITY.md](https://github.com/dbtinoy-/quadkit/blob/main/SECURITY.md).
+
+## Stability
+
+Version `0.0.3` in the `0.x` series, released in lockstep with the
+other four distributions; APIs may change between minor versions until
+1.0 — pin an exact version (`quadkit-testing==0.0.3`) or a tight range
+(`>=0.0.3,<0.1.0`). Full policy:
+[stability and compatibility](https://dbtinoy-.github.io/quadkit/reference/stability/).
+
+## Links
+
+- **Documentation** — <https://dbtinoy-.github.io/quadkit/>
+- **Getting started** — <https://dbtinoy-.github.io/quadkit/getting-started/installation/>
+- **Changelog** — <https://github.com/dbtinoy-/quadkit/blob/main/CHANGELOG.md>
+- **Issues** — <https://github.com/dbtinoy-/quadkit/issues>
+- **Security** — report privately per [SECURITY.md](https://github.com/dbtinoy-/quadkit/blob/main/SECURITY.md)
+- **Contributing** — [CONTRIBUTING.md](https://github.com/dbtinoy-/quadkit/blob/main/CONTRIBUTING.md)
+
+Apache-2.0 — see [LICENSE](https://github.com/dbtinoy-/quadkit/blob/main/LICENSE). "Quadkit" and the
+Quadkit logo are trademarks of the project — see
+[TRADEMARK.md](https://github.com/dbtinoy-/quadkit/blob/main/TRADEMARK.md).

quadkit_testing-0.0.3/PKG-INFO → quadkit_testing-0.0.4/README.md

@@ -1,61 +1,11 @@
-Metadata-Version: 2.5
-Name: quadkit-testing
-Version: 0.0.3
-Summary: Centralized testing infrastructure for Quadkit Framework - Fixtures, factories, and utilities
-Project-URL: Homepage, https://quadkit.dev
-Project-URL: Repository, https://github.com/dbtinoy-/quadkit
-Project-URL: Documentation, https://quadkit.dev
-Project-URL: Issues, https://github.com/dbtinoy-/quadkit/issues
-Project-URL: Changelog, https://github.com/dbtinoy-/quadkit/blob/main/CHANGELOG.md
-Author-email: Quadkit Framework Team <team@quadkit.dev>
-Maintainer-email: Quadkit Framework Team <team@quadkit.dev>
-License: Apache-2.0
-License-File: LICENSE
-License-File: NOTICE
-Keywords: async,factories,fixtures,framework,mocking,pytest,testing
-Classifier: Development Status :: 3 - Alpha
-Classifier: Framework :: AsyncIO
-Classifier: Framework :: Pytest
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-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: Topic :: Software Development :: Testing
-Classifier: Typing :: Typed
-Requires-Python: >=3.11
-Requires-Dist: pytest-asyncio>=0.21.0
-Requires-Dist: pytest-cov>=4.0.0
-Requires-Dist: pytest-mock>=3.10.0
-Requires-Dist: pytest>=8.0.0
-Requires-Dist: quadkit-contracts>=0.0.2
-Requires-Dist: quadkit>=0.0.2
-Provides-Extra: db
-Requires-Dist: aiosqlite>=0.19.0; extra == 'db'
-Requires-Dist: asyncpg>=0.29.0; extra == 'db'
-Provides-Extra: dev
-Requires-Dist: black>=23.0.0; extra == 'dev'
-Requires-Dist: mypy>=1.0.0; extra == 'dev'
-Requires-Dist: ruff>=0.16.4; extra == 'dev'
-Provides-Extra: integration
-Requires-Dist: aiokafka>=0.12.0; extra == 'integration'
-Requires-Dist: aiosqlite>=0.19.0; extra == 'integration'
-Requires-Dist: asyncpg>=0.29.0; extra == 'integration'
-Requires-Dist: elasticsearch[async]>=8.12.0; extra == 'integration'
-Requires-Dist: motor>=3.3.0; extra == 'integration'
-Requires-Dist: neo4j>=5.18.0; extra == 'integration'
-Requires-Dist: qdrant-client>=1.9.0; extra == 'integration'
-Requires-Dist: redis>=5.0.0; extra == 'integration'
-Provides-Extra: web
-Requires-Dist: httpx2>=2.0.0; extra == 'web'
-Requires-Dist: httpx>=0.26.0; extra == 'web'
-Requires-Dist: starlette>=0.28.0; extra == 'web'
-Description-Content-Type: text/markdown
-
 # quadkit-testing
 
+![Quadkit](https://raw.githubusercontent.com/dbtinoy-/quadkit/main/banner.jpg)
+
+[![PyPI](https://img.shields.io/pypi/v/quadkit-testing?color=%2322c55e&label=pypi)](https://pypi.org/project/quadkit-testing/)
+[![Python](https://img.shields.io/pypi/pyversions/quadkit-testing?color=%2322c55e)](https://pypi.org/project/quadkit-testing/)
+[![License](https://img.shields.io/pypi/l/quadkit-testing?color=%2322c55e)](https://github.com/dbtinoy-/quadkit/blob/main/LICENSE)
+
 Test harnesses, fakes, and fixtures for Quadkit applications: boot the
 real application in-process, substitute bindings instead of mocking
 import sites, and assert on responses with helpers that say what
@@ -64,6 +14,16 @@ failed.
 For anyone writing tests against Quadkit applications — and for tooling
 that needs drop-in implementations of the framework's protocols.
 
+## The quadkit family
+
+| Package | Role |
+| --- | --- |
+| [`quadkit-contracts`](https://pypi.org/project/quadkit-contracts/) | zero-dependency protocols, types, exception hierarchy |
+| [`quadkit`](https://pypi.org/project/quadkit/) | the framework core — DI container, modules, config, logging, `Result` |
+| [`quadkit-web`](https://pypi.org/project/quadkit-web/) | ASGI layer — controllers, routing, middleware, OpenAPI docs |
+| [`quadkit-cli`](https://pypi.org/project/quadkit-cli/) | project scaffolding and code generators |
+| [`quadkit-testing`](https://pypi.org/project/quadkit-testing/) | in-process test beds, fakes, fixtures |
+
 ## Installation
 
 ```bash
@@ -109,11 +69,32 @@ A pytest plugin registers automatically via entry points — no
 `fake_cache`, `fake_event_bus`, `fake_logger`, `fake_clock`,
 `fake_command_bus`, `fake_query_bus`, `fake_unit_of_work`,
 `fake_metrics`, `fake_config`, `fake_state_store`, `test_bed`,
-`test_container`, and `test_data`.
+`test_container`, and `test_data`:
+
+```python
+import pytest
+
+from quadkit.contracts.domain.events import DomainEvent
 
-## Optional extras
 
-Verified against the package's `pyproject.toml`:
+class UserCreated(DomainEvent):
+    user_id: str
+    email: str
+
+
+@pytest.mark.asyncio
+async def test_signup_publishes(fake_event_bus) -> None:
+    await fake_event_bus.publish(UserCreated(user_id="1", email="a@b.c"))
+    fake_event_bus.assert_published(UserCreated, user_id="1")
+
+
+def test_trial_expiry_is_deterministic(fake_clock) -> None:
+    t0 = fake_clock.now()
+    fake_clock.advance(30 * 24 * 3600)
+    assert (fake_clock.now() - t0).days == 30
+```
+
+## Optional extras
 
 | Extra | Contents |
 | --- | --- |
@@ -164,8 +145,12 @@ real services:
 | `FakeAuditLogger` | audit records |
 | `FakeTracer` / `FakeSpan` | tracing |
 
-Fakes that depend on packages outside the published set are not
-included in this distribution.
+The published wheel carries the `ai`, `db` and `web` test clients and beds
+plus the fakes and fixtures that need no private package. The `auth`,
+`cache`, `events`, `search`, `storage`, `tasks`, `ui` test clients, the
+AI/DB/task fixture modules, the secrets fake and `IntegrationEnvironment`
+stay in this repository until their packages publish; asking the published
+wheel for one raises `AttributeError` naming the module.
 
 ## Configuration
 
@@ -189,7 +174,7 @@ wheels.
 ## Security
 
 Fakes are in-process and safe to wire into unit suites. Report
-vulnerabilities privately per [SECURITY.md](../../SECURITY.md).
+vulnerabilities privately per [SECURITY.md](https://github.com/dbtinoy-/quadkit/blob/main/SECURITY.md).
 
 ## Stability
 
@@ -197,6 +182,17 @@ Version `0.0.3` in the `0.x` series, released in lockstep with the
 other four distributions; APIs may change between minor versions until
 1.0 — pin an exact version (`quadkit-testing==0.0.3`) or a tight range
 (`>=0.0.3,<0.1.0`). Full policy:
-[stability and compatibility](../../docs/reference/stability.md).
+[stability and compatibility](https://dbtinoy-.github.io/quadkit/reference/stability/).
+
+## Links
+
+- **Documentation** — <https://dbtinoy-.github.io/quadkit/>
+- **Getting started** — <https://dbtinoy-.github.io/quadkit/getting-started/installation/>
+- **Changelog** — <https://github.com/dbtinoy-/quadkit/blob/main/CHANGELOG.md>
+- **Issues** — <https://github.com/dbtinoy-/quadkit/issues>
+- **Security** — report privately per [SECURITY.md](https://github.com/dbtinoy-/quadkit/blob/main/SECURITY.md)
+- **Contributing** — [CONTRIBUTING.md](https://github.com/dbtinoy-/quadkit/blob/main/CONTRIBUTING.md)
 
-Issues: <https://github.com/dbtinoy-/quadkit/issues>
+Apache-2.0 — see [LICENSE](https://github.com/dbtinoy-/quadkit/blob/main/LICENSE). "Quadkit" and the
+Quadkit logo are trademarks of the project — see
+[TRADEMARK.md](https://github.com/dbtinoy-/quadkit/blob/main/TRADEMARK.md).