airflow-pytest-operator 0.1.0__tar.gz

airflow_pytest_operator-0.1.0/.gitignore

@@ -0,0 +1,70 @@
+# Byte-compiled / optimized
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+.Python
+build/
+dist/
+downloads/
+*.egg-info/
+*.egg
+wheels/
+share/python-wheels/
+.installer/
+MANIFEST
+
+# Virtual environments
+.venv/
+venv/
+env/
+ENV/
+.env
+env.bak/
+venv.bak/
+
+# Test / coverage / type-check caches
+.pytest_cache/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+*.cover
+.cache/
+.mypy_cache/
+.dmypy.json
+dmypy.json
+.ruff_cache/
+.tox/
+.nox/
+nosetests.xml
+
+# Airflow runtime artifacts (in case someone runs this near an AIRFLOW_HOME)
+airflow.cfg
+airflow.db
+airflow-webserver.pid
+standalone_admin_password.txt
+logs/
+
+# pytest report outputs produced by the operator itself
+junit.xml
+pytest_report_*/
+report/
+
+# IDE / editor
+.idea/
+.vscode/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# Jupyter
+.ipynb_checkpoints/
+
+# Local secrets / env overrides
+*.local
+.env.*
+!.env.example

airflow_pytest_operator-0.1.0/CHANGELOG.md

@@ -0,0 +1,41 @@
+# Changelog
+
+All notable changes to this project are documented here.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-05-23
+
+Initial release.
+
+### Added
+- `PytestOperator` — runs a pytest suite as an Airflow task, parses the JUnit
+  report into a structured result, optionally pushes a summary to XCom under the
+  `pytest_result` key, and fails the task on test failure (configurable via
+  `fail_on_test_failure`).
+- `PytestRunner` abstraction with a default `SubprocessPytestRunner` that runs
+  `python -m pytest` in a child process using the worker's own interpreter and
+  virtualenv.
+- `ResultParser` abstraction with a default `JUnitResultParser` (uses
+  `defusedxml` when available via the `secure-xml` extra).
+- Airflow 2.x / 3.x compatibility through a single `compat.airflow` shim.
+- Graceful cancellation: `on_kill` terminates the whole pytest process tree
+  (`SIGTERM` → `grace_period` → `SIGKILL`), covering `xdist` workers and nested
+  processes.
+- Automatic working-directory resolution so relative paths in pytest `addopts`
+  (e.g. Allure's `--alluredir`) resolve next to the tests.
+- Temporary report-directory cleanup with `cleanup` policy
+  (`"always"` | `"on_success"` | `"never"`); user-supplied `report_dir` is never
+  removed; cleanup also runs on task kill.
+- `run` timeout support and clear `TestExecutionError` when pytest produces no
+  report (collection error, crash, wrong path).
+- `push_result=False` suppresses all XCom output, including Airflow's automatic
+  return-value push.
+- Packaged as an Airflow provider (`get_provider_info` entry point), Apache-2.0
+  licensed.
+
+[Unreleased]: https://github.com/IKrysanov/airflow-pytest-operator/compare/v0.1.0...HEAD
+[0.1.0]: https://github.com/IKrysanov/airflow-pytest-operator/releases/tag/v0.1.0

airflow_pytest_operator-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing
+
+Thanks for your interest in improving **airflow-pytest-operator**! This guide covers how to set up a dev environment, the checks your change must pass, and how to submit it.
+
+## Getting started
+
+The package targets Python 3.9+ and supports Airflow 2.x and 3.x. You do **not** need Airflow installed to develop or run the test suite — the suite stubs `BaseOperator` when Airflow is absent.
+
+```bash
+git clone https://github.com/IKrysanov/airflow-pytest-operator
+cd airflow-pytest-operator
+python -m venv .venv && source .venv/bin/activate
+pip install -e ".[dev]"
+```
+
+## Quality gates
+
+Every change must pass all three checks. They run in CI and you should run them locally first:
+
+```bash
+ruff check src tests     # lint + import order
+mypy                     # strict static type checking
+pytest                   # full test suite
+```
+
+`ruff format src tests` will apply formatting. The configuration for all three tools lives in `pyproject.toml`.
+
+## Design principles
+
+This project follows SOLID deliberately; please keep new code consistent with it.
+
+- **The operator stays thin.** It orchestrates a runner and a parser and integrates with Airflow — nothing more. No subprocess logic, no XML parsing.
+- **Extend, don't modify.** New execution strategies are new `PytestRunner` subclasses; new report formats are new `ResultParser` subclasses. Avoid adding branches to existing classes for new behaviour.
+- **`compat/airflow.py` is the only module that imports Airflow.** Supporting a new Airflow version should be a change confined to that file.
+- **Domain models stay framework-free.** `models.py` must not import Airflow, pytest, or subprocess.
+- **Teardown must never raise.** `on_kill`, `cancel`, and `cleanup` run during termination; swallow and log their errors.
+
+## Tests
+
+- Add tests for any behaviour change; bug fixes should come with a regression test.
+- Prefer testing the operator with injected fakes (see `tests/test_operator.py`) over spinning up Airflow.
+- Runner tests use real child processes (see `tests/test_subprocess_runner.py`); keep them fast and deterministic.
+- New public exceptions should follow the `...Error` naming convention.
+
+## Commit messages and PRs
+
+- Use clear, imperative commit subjects (e.g. "Add Docker runner", "Fix temp dir leak on kill").
+- Keep PRs focused on one concern; smaller PRs review faster.
+- Describe the motivation and any platform-specific considerations (especially around process handling and Airflow version differences).
+- Update `README.md` and `CHANGELOG.md` when behaviour or the public API changes.
+
+## Developer Certificate of Origin (DCO)
+
+By contributing, you certify that you wrote the code or otherwise have the right to submit it under the project's Apache-2.0 license (see the [DCO](https://developercertificate.org/)). Sign off your commits:
+
+```bash
+git commit -s -m "Your message"
+```
+
+This adds a `Signed-off-by` line and is required for any future inclusion in the Apache Airflow ecosystem.
+
+## License
+
+By contributing, you agree that your contributions are licensed under the Apache License 2.0.

airflow_pytest_operator-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 2026 Ilya Krysanov
+
+   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.

airflow_pytest_operator-0.1.0/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: airflow-pytest-operator
+Version: 0.1.0
+Summary: Run pytest suites as Airflow tasks, with structured results in XCom.
+Project-URL: Homepage, https://github.com/IKrysanov/airflow-pytest-operator
+Project-URL: Repository, https://github.com/IKrysanov/airflow-pytest-operator
+Project-URL: Issues, https://github.com/IKrysanov/airflow-pytest-operator/issues
+Project-URL: Changelog, https://github.com/IKrysanov/airflow-pytest-operator/blob/main/CHANGELOG.md
+Author: Ilya Krysanov
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: airflow,ci,operator,provider,pytest,testing
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Apache Airflow
+Classifier: Framework :: Apache Airflow :: Provider
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Testing
+Requires-Python: >=3.9
+Provides-Extra: airflow2
+Requires-Dist: apache-airflow<3.0,>=2.6; extra == 'airflow2'
+Provides-Extra: airflow3
+Requires-Dist: apache-airflow<4.0,>=3.0; extra == 'airflow3'
+Provides-Extra: dev
+Requires-Dist: defusedxml>=0.7; extra == 'dev'
+Requires-Dist: mypy>=1.8; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: ruff>=0.4; extra == 'dev'
+Provides-Extra: secure-xml
+Requires-Dist: defusedxml>=0.7; extra == 'secure-xml'
+Description-Content-Type: text/markdown
+
+# airflow-pytest-operator
+
+Run a `pytest` suite as an Airflow task. The operator executes your tests in a child process, parses the JUnit report into a structured result, pushes a summary to XCom, and fails the task when tests fail (configurable).
+
+Works on **Airflow 2.x and 3.x** — all version-specific imports are isolated in a single compatibility module, so one wheel supports both.
+
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+## Why a child process
+
+Tests run via `{sys.executable} -m pytest`, i.e. in the **same virtualenv / interpreter as the Airflow worker** (same dependencies), but in a **child process**. This keeps pytest's global-state mutations (`sys.modules`, plugins, cwd, logging) out of the long-lived worker while still satisfying "same environment" semantics. A crashing or segfaulting test can't take the worker down, and the child can be killed cleanly on timeout or task termination.
+
+## Install
+
+```bash
+pip install airflow-pytest-operator
+# recommended: hardened XML parsing for untrusted reports
+pip install "airflow-pytest-operator[secure-xml]"
+```
+
+Airflow itself is **not** a hard dependency — the package installs into your existing Airflow environment. Pin a compatible Airflow via an extra if you want resolution help: `airflow-pytest-operator[airflow2]` or `[airflow3]`.
+
+## Usage
+
+```python
+import pendulum
+from airflow import DAG
+from airflow_pytest_operator import PytestOperator
+
+with DAG(
+    dag_id="run_tests",
+    start_date=pendulum.datetime(2024, 1, 1),
+    schedule=None,
+) as dag:
+    smoke = PytestOperator(
+        task_id="smoke_tests",
+        test_path="/opt/airflow/tests",      # next to your dags/ folder
+        pytest_args=["-k", "smoke", "-x"],   # any pytest CLI args
+        env={"ENV": "staging"},              # extra env for the run
+        fail_on_test_failure=True,           # task fails if any test fails
+        push_result=True,                    # summary -> XCom
+    )
+```
+
+The summary pushed to XCom (key `pytest_result`) looks like:
+
+```python
+{
+    "total": 12, "passed": 11, "failed": 1, "skipped": 0, "errors": 0,
+    "duration": 3.4, "exit_code": 1, "success": False,
+    "failed_node_ids": ["tests/test_api.py::test_timeout"],
+}
+```
+
+## Constructor options
+
+| Option | Default | Description |
+|---|---|---|
+| `test_path` | — | File or directory passed to pytest. Templated. |
+| `pytest_args` | `[]` | Extra pytest CLI args, e.g. `["-k", "smoke", "-x"]`. Templated. |
+| `env` | `{}` | Extra environment variables for the run. Templated. |
+| `fail_on_test_failure` | `True` | Fail the task on any test failure/error. If `False`, the task always succeeds and the outcome is only reflected in XCom. |
+| `push_result` | `True` | Push the summary dict under `pytest_result`. If `False`, **nothing** goes to XCom (also disables Airflow's automatic return-value push). |
+| `runner` | `SubprocessPytestRunner()` | Injectable execution strategy (see *Extending*). |
+| `parser` | `JUnitResultParser()` | Injectable report parser (see *Extending*). |
+
+The default `SubprocessPytestRunner` additionally accepts `python_executable`, `timeout`, `report_dir`, `cwd`, `grace_period`, and `cleanup` — see below.
+
+## pytest config, plugins, and Allure
+
+The operator runs real `python -m pytest`, so pytest discovers its own configuration (`pytest.ini`, `pyproject.toml`, `tox.ini`, `setup.cfg`) and `rootdir` exactly as on the command line. **Plugins and their options are picked up from your test folder's config automatically** — Allure, `pytest-xdist`, `pytest-cov`, markers, `addopts`, and so on. The operator only adds `--junitxml` (for its own parsing); everything else is yours.
+
+To make relative paths in `addopts` (e.g. `--alluredir=allure-results`) resolve next to your tests rather than the worker's working directory, the runner sets its working directory to the test folder by default: a directory `test_path` becomes the cwd, a file's parent becomes the cwd. Pass an explicit `cwd=` to override. The JUnit report path stays absolute, so this never misplaces it.
+
+```python
+# pytest.ini next to your tests, with allure-pytest installed on the worker:
+#   [pytest]
+#   addopts = --alluredir=allure-results
+# -> results land in <tests>/allure-results, as expected.
+```
+
+On distributed executors, make sure the plugins you reference (e.g. `allure-pytest`) are installed in the worker/pod environment, and write Allure output to persistent storage (volume/S3) rather than an ephemeral pod filesystem.
+
+## Report cleanup
+
+When `report_dir` is not given, the runner creates a temporary directory per run for the JUnit report. It is cleaned up according to the `cleanup` policy on `SubprocessPytestRunner`:
+
+| `cleanup` | Behaviour |
+|---|---|
+| `"always"` (default) | Remove the temp dir after every run, including on test failure and on task kill/timeout. |
+| `"on_success"` | Keep the temp dir when the run failed (for post-mortem); remove it on success. |
+| `"never"` | Never remove it (e.g. you upload it as a CI artifact). |
+
+A **user-supplied** `report_dir` is never removed — it's your data. Cleanup also runs from `on_kill`, so killed tasks don't leak temp directories.
+
+## Cancellation and timeouts
+
+When Airflow kills the task (execution timeout, manual clear/mark-failed, worker shutdown), the operator's `on_kill` delegates to the runner, which terminates the **entire pytest process tree** — not just the direct child. This matters because pytest spawns its own children (e.g. `xdist` workers). Termination is graceful by default: `SIGTERM`, wait `grace_period` seconds (default 10), then `SIGKILL`. Set `timeout=` on the runner to bound the run itself.
+
+> **Platform note:** process-group termination is fully supported on **Linux and macOS**. On Windows the package runs and cancels the direct process, but reliable whole-tree termination is not guaranteed; Airflow workers are Linux in virtually all deployments.
+
+## Where do the tests live?
+
+The operator runs whatever path exists **on the worker** at execute time, so it works with any executor (Local, Celery, Kubernetes, custom) — the runner spawns pytest wherever the task already runs. The practical constraint is *availability*: with `LocalExecutor` the tests sit next to `dags/`; with Celery/Kubernetes, make sure the test folder is synced to workers the same way DAGs are (git-sync, baked image, shared volume), or point `test_path` at wherever they land. If the path is missing, the task fails with a clear `TestExecutionError`.
+
+## Extending it
+
+The operator depends on two narrow abstractions and accepts them via constructor injection — no operator subclassing required. Provide your own to change *how* tests run or *how* results are parsed.
+
+### Custom runner
+
+```python
+from airflow_pytest_operator import PytestOperator, PytestRunner, RunArtifacts
+
+class DockerPytestRunner(PytestRunner):
+    def run(self, test_path, *, pytest_args=None, env=None) -> RunArtifacts:
+        # run pytest inside a container, write a JUnit xml, then:
+        return RunArtifacts(exit_code=..., junit_xml_path="/path/junit.xml")
+
+    # optional: override cancel() / cleanup() if you own resources
+    # (the base class provides safe no-op defaults)
+
+PytestOperator(task_id="t", test_path="tests/", runner=DockerPytestRunner())
+```
+
+### Custom parser
+
+```python
+from airflow_pytest_operator import PytestOperator, ResultParser, TestRunResult
+
+class JSONResultParser(ResultParser):
+    def parse(self, report_path, *, exit_code=0) -> TestRunResult:
+        ...  # read pytest-json-report output, return a TestRunResult
+
+PytestOperator(task_id="t", test_path="tests/", parser=JSONResultParser())
+```
+
+## Architecture
+
+| Concern | Type | Responsibility |
+|---|---|---|
+| `PytestOperator` | operator | orchestrate runner→parser, Airflow integration, fail/cleanup policy |
+| `PytestRunner` / `SubprocessPytestRunner` | runner | execute pytest, produce `RunArtifacts`, own cancel/cleanup |
+| `ResultParser` / `JUnitResultParser` | parser | turn a report file into `TestRunResult` |
+| `compat.airflow` | shim | the only place that imports Airflow |
+| `models` | domain | framework-free dataclasses |
+
+## Development
+
+The library's own tests run **without Airflow** by stubbing `BaseOperator` — itself a demonstration of the dependency-inversion design.
+
+```bash
+pip install -e ".[dev]"
+ruff check src tests
+mypy
+pytest
+```
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).