executable-stories-pytest 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

executable_stories/_collector.py

@@ -16,6 +16,7 @@ class _Collector:
     def __init__(self) -> None:
         self._lock = threading.Lock()
         self._cases: list[dict[str, Any]] = []
+        self._features: dict[str, dict[str, Any]] = {}
 
     def record(self, test_case: dict[str, Any]) -> None:
         """Append a completed RawTestCase dict."""
@@ -27,10 +28,24 @@ class _Collector:
         with self._lock:
             return list(self._cases)
 
+    def record_feature(self, feature: dict[str, Any]) -> None:
+        """Store a declaration, replacing an earlier one for the same file.
+
+        A re-declaration then reads the way it does in source order.
+        """
+        with self._lock:
+            self._features[feature.get("sourceFile", "")] = feature
+
+    def get_features(self) -> list[dict[str, Any]]:
+        """Return all declared features."""
+        with self._lock:
+            return list(self._features.values())
+
     def clear(self) -> None:
         """Reset the collector."""
         with self._lock:
             self._cases.clear()
+            self._features.clear()
 
 
 # Module-level singleton

executable_stories/_json_writer.py

@@ -4,18 +4,28 @@ from __future__ import annotations
 
 import json
 import os
+import tempfile
 from typing import Any
 
 
 def write_raw_run(raw_run: dict[str, Any], output_path: str) -> None:
     """Write a RawRun dict to a JSON file.
 
-    Creates parent directories if they don't exist.
+    Creates parent directories if they don't exist. The file appears whole:
+    it is written alongside the destination and then renamed over it, so a
+    reader never sees a half-written run and a crash mid-write leaves the
+    previous file intact.
     """
-    parent = os.path.dirname(output_path)
-    if parent:
-        os.makedirs(parent, exist_ok=True)
+    parent = os.path.dirname(output_path) or "."
+    os.makedirs(parent, exist_ok=True)
 
-    with open(output_path, "w", encoding="utf-8") as f:
-        json.dump(raw_run, f, indent=2)
-        f.write("\n")
+    fd, temp_path = tempfile.mkstemp(dir=parent, prefix=".raw-run-", suffix=".json")
+    try:
+        with os.fdopen(fd, "w", encoding="utf-8") as f:
+            json.dump(raw_run, f, indent=2)
+            f.write("\n")
+        os.replace(temp_path, output_path)
+    except BaseException:
+        if os.path.exists(temp_path):
+            os.unlink(temp_path)
+        raise

executable_stories/_plugin.py

@@ -6,8 +6,10 @@ Registered via the ``pytest11`` entry point in pyproject.toml.
 from __future__ import annotations
 
 import os
+import subprocess
+import sys
 import time
-import traceback
+from importlib.metadata import PackageNotFoundError, version
 from typing import Any
 
 import pytest
@@ -16,6 +18,18 @@ from executable_stories._collector import _collector
 from executable_stories._json_writer import write_raw_run
 from executable_stories._story_api import story
 
+#: Published raw-run schema, emitted as ``$schema`` so editors validate the
+#: output file as the adapter writes it.
+SCHEMA_URL = "https://executable-stories.dev/schemas/raw-run.schema.json"
+
+#: How long to wait for `git rev-parse` before giving up on the commit sha.
+GIT_TIMEOUT_SECONDS = 5
+
+#: Exit statuses that mean pytest got through everything it selected. Anything
+#: else — an interrupt, an internal error, a usage error — left files it had
+#: already visited only partly run.
+_COMPLETED_EXIT_STATUSES = (int(pytest.ExitCode.OK), int(pytest.ExitCode.TESTS_FAILED))
+
 # ── CI detection ──────────────────────────────────────────────────
 
 
@@ -72,17 +86,35 @@ def _detect_ci() -> dict[str, Any] | None:
     return None
 
 
-# ── Session-level timestamps ───────────────────────────────────────
+# ── Session state ──────────────────────────────────────────────────
 
 _started_at_ms: float = 0.0
 
+#: Every file this run executed a test in, so a file emptied of scenarios is
+#: distinguishable from one that never ran.
+_covered_files: set[str] = set()
+
+#: Files this run cannot speak for, so a consumer keeps what they last
+#: documented rather than treating the run as authoritative.
+_incomplete_files: set[str] = set()
+
 
 def pytest_sessionstart(session: pytest.Session) -> None:
     global _started_at_ms
     _started_at_ms = time.time() * 1000
+    _covered_files.clear()
+    _incomplete_files.clear()
     _collector.clear()
 
 
+def pytest_collectreport(report: pytest.CollectReport) -> None:
+    """A module that failed to import reports none of the stories inside it."""
+    if report.failed:
+        source_file = report.nodeid.split("::")[0]
+        if source_file:
+            _incomplete_files.add(source_file)
+
+
 # ── Per-test hooks ─────────────────────────────────────────────────
 
 # We store per-test start times keyed by node id.
@@ -104,22 +136,59 @@ _STATUS_MAP = {
 }
 
 
+def _record_file_inventory(report: pytest.TestReport, source_file: str, has_story: bool) -> None:
+    """Note what this run can and cannot say about ``source_file``."""
+    if report.skipped:
+        # Scenario identity comes from the title the body passes to story.init,
+        # and a body that never ran has none to give.
+        _incomplete_files.add(source_file)
+        return
+    if report.when != "call":
+        if report.failed:
+            _incomplete_files.add(source_file)
+        return
+    _covered_files.add(source_file)
+    if report.failed and not has_story:
+        # It broke before it declared anything, so its scenario is missing
+        # because the run failed rather than because someone deleted it.
+        _incomplete_files.add(source_file)
+
+
 @pytest.hookimpl(hookwrapper=True)
 def pytest_runtest_makereport(item: pytest.Item, call: pytest.CallInfo[None]) -> Any:
     """Capture test result on the 'call' phase and record it."""
     outcome = yield
     report: pytest.TestReport = outcome.get_result()
 
+    story_meta = story._get_meta() if report.when == "call" else None
+
+    # The file the item was collected from, which is pytest's own
+    # `report.fspath`. Not `item.location[0]`: that is where the test function
+    # was defined, so an inherited method would be filed under its base class.
+    source_file = item.nodeid.split("::")[0]
+    if source_file:
+        _record_file_inventory(report, source_file, story_meta is not None)
+
     if report.when != "call":
         return
 
-    # Build the test case dict
+    # A red test shows how far its story got without opening the report. A
+    # section, not longrepr, so the recorded error message stays as it was.
+    if report.failed:
+        trail = story._step_trail()
+        if trail:
+            report.sections.append(("Story steps", trail))
+
     start_ms = _test_start_times.pop(item.nodeid, 0.0)
     now_ms = time.time() * 1000
     duration_ms = now_ms - start_ms if start_ms else 0.0
 
-    # Status mapping
-    if hasattr(report, "wasxfail"):
+    # Status mapping. A planned declaration only counts when the test itself
+    # came out clean: code after story.planned() can still fail, and reporting
+    # that failure as "planned" would hide it.
+    if story.is_planned() and report.outcome == "passed":
+        status = "todo"
+    elif hasattr(report, "wasxfail"):
         status = "skip"
     else:
         status = _STATUS_MAP.get(report.outcome, "unknown")
@@ -139,17 +208,13 @@ def pytest_runtest_makereport(item: pytest.Item, call: pytest.CallInfo[None]) ->
         "retries": retries,
     }
 
-    # Source file info
-    try:
-        fspath = str(item.fspath)
-        if fspath:
-            test_case["sourceFile"] = fspath
-        if item.location and item.location[1] is not None:
-            test_case["sourceLine"] = item.location[1] + 1  # 0-based to 1-based
-    except Exception:
-        pass
-
-    # Error info
+    if source_file:
+        test_case["sourceFile"] = source_file
+    # Only when the body lives in the file it was collected from: an inherited
+    # test's line points into another module.
+    if item.location and item.location[1] is not None and item.location[0] == source_file:
+        test_case["sourceLine"] = item.location[1] + 1  # 0-based to 1-based
+
     if report.failed and report.longrepr:
         error: dict[str, str] = {}
         if isinstance(report.longrepr, tuple):
@@ -161,11 +226,8 @@ def pytest_runtest_makereport(item: pytest.Item, call: pytest.CallInfo[None]) ->
             error["stack"] = repr_str
         test_case["error"] = error
 
-    # Story metadata
-    story_meta = story._get_meta()
     if story_meta is not None:
         test_case["story"] = story_meta
-        # Build stepEvents from steps with durationMs
         step_events: list[dict[str, Any]] = []
         if "steps" in story_meta:
             for i, step in enumerate(story_meta["steps"]):
@@ -180,42 +242,195 @@ def pytest_runtest_makereport(item: pytest.Item, call: pytest.CallInfo[None]) ->
         if step_events:
             test_case["stepEvents"] = step_events
 
-    # Attachments
     attachments = story._get_attachments()
     if attachments:
         test_case["attachments"] = attachments
 
     _collector.record(test_case)
 
-    # Clear story context for next test
     story._clear()
 
 
 # ── Session finish — write output ──────────────────────────────────
 
 
+def _run_scope(config: Any) -> str | None:
+    """How much of each source file this run covered.
+
+    ``"filtered"`` when pytest was pointed at part of a file rather than all of
+    it — ``-k``, ``-m``, ``--deselect``, ``--last-failed``, or a node id naming
+    a single test — and ``"full"`` when none of those applied. ``None`` when
+    there is no option object to inspect: some entry points build a config
+    without one. ``None`` means unknown, and a consumer keeps what an
+    unknown-scope run did not report rather than retiring it on a guess.
+    """
+    option = getattr(config, "option", None)
+    if option is None:
+        return None
+    if bool(getattr(option, "keyword", "")) or bool(getattr(option, "markexpr", "")):
+        return "filtered"
+    if getattr(option, "deselect", None) or getattr(option, "lf", False):
+        return "filtered"
+    # `pytest tests/test_cart.py::test_totals` runs one test out of a file, so
+    # the file's other scenarios simply were not part of this run.
+    if any("::" in str(arg) for arg in getattr(option, "file_or_dir", None) or []):
+        return "filtered"
+    return "full"
+
+
+def _relative_source(source: str, project_root: str) -> str:
+    """``source`` relative to the project root, in POSIX form."""
+    try:
+        relative = os.path.relpath(source, project_root)
+    except ValueError:  # a different drive on Windows
+        return source
+    if relative.startswith(".."):
+        return source
+    return relative.replace(os.sep, "/")
+
+
+def _git_sha(project_root: str) -> str | None:
+    """The commit this run describes, so a report says which code it documents.
+
+    CI exports it, and asking Git is the fallback. The call is bounded: a Git
+    that hangs would otherwise hold up the end of the test run.
+    """
+    for key in ("GITHUB_SHA", "GIT_COMMIT", "CI_COMMIT_SHA"):
+        value = os.environ.get(key)
+        if value:
+            return value
+    try:
+        result = subprocess.run(
+            ["git", "rev-parse", "HEAD"],
+            cwd=project_root,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.DEVNULL,
+            text=True,
+            timeout=GIT_TIMEOUT_SECONDS,
+            check=False,
+        )
+    except (OSError, subprocess.SubprocessError):
+        return None
+    if result.returncode != 0:
+        return None
+    return result.stdout.strip() or None
+
+
+def _package_version() -> str | None:
+    """Version of this adapter, so a report says what produced it."""
+    try:
+        return version("executable-stories-pytest")
+    except PackageNotFoundError:
+        return None
+
+
+def _resolve_output_path(project_root: str) -> str:
+    """Where the run file lands.
+
+    A relative ``EXECUTABLE_STORIES_OUTPUT`` is resolved against the project
+    root rather than the working directory, so the file lands where the docs
+    say it does however pytest was invoked. An absolute one passes through.
+    """
+    declared = os.environ.get("EXECUTABLE_STORIES_OUTPUT")
+    if not declared:
+        return os.path.join(project_root, ".executable-stories", "raw-run.json")
+    return os.path.join(project_root, declared)
+
+
+def _stopped_early(session: pytest.Session, exitstatus: int) -> bool:
+    """Whether the run ended before it got through everything it selected.
+
+    ``-x`` and ``--maxfail`` set a flag on the session. Ctrl-C, an internal
+    error and a usage error do not, and only the exit status shows them. Either
+    way a file this run visited was left partly run, so the run cannot be
+    treated as the complete contents of that file.
+    """
+    if bool(getattr(session, "shouldstop", False)) or bool(getattr(session, "shouldfail", False)):
+        return True
+    try:
+        return int(exitstatus) not in _COMPLETED_EXIT_STATUSES
+    except (TypeError, ValueError):
+        return True
+
+
 def pytest_sessionfinish(session: pytest.Session, exitstatus: int) -> None:
     test_cases = _collector.get_all()
-    if not test_cases:
+    covered = sorted(_covered_files)
+    incomplete = sorted(_incomplete_files)
+    # A run that reached files but produced no scenario still has something to
+    # say: those files are now empty, and only a written run retires them. So
+    # does one that broke before reaching anything, which keeps them instead.
+    if not test_cases and not covered and not incomplete:
         return
 
     finished_at_ms = time.time() * 1000
+    project_root = str(session.config.rootpath)
 
     raw_run: dict[str, Any] = {
+        # $schema first so editors pick it up and validate the file as it is
+        # written; `executable-stories doctor` also reports its presence.
+        "$schema": SCHEMA_URL,
         "schemaVersion": 1,
         "testCases": test_cases,
-        "projectRoot": str(session.config.rootdir),  # type: ignore[attr-defined]
+        "projectRoot": project_root,
         "startedAtMs": round(_started_at_ms, 2),
         "finishedAtMs": round(finished_at_ms, 2),
     }
 
+    package_version = _package_version()
+    if package_version is not None:
+        raw_run["packageVersion"] = package_version
+
+    git_sha = _git_sha(project_root)
+    if git_sha is not None:
+        raw_run["gitSha"] = git_sha
+
+    features = _collector.get_features()
+    if features:
+        # Declarations run at import time, where the stack is the only source
+        # of the module path, so they arrive absolute.
+        for feature in features:
+            declared_in = feature.get("sourceFile")
+            if declared_in:
+                feature["sourceFile"] = _relative_source(declared_in, project_root)
+        raw_run["features"] = features
+
     ci = _detect_ci()
     if ci is not None:
         raw_run["ci"] = ci
 
-    output_path = os.environ.get(
-        "EXECUTABLE_STORIES_OUTPUT",
-        os.path.join(str(session.config.rootdir), ".executable-stories", "raw-run.json"),  # type: ignore[attr-defined]
-    )
+    # Absent means pytest gave us nothing to inspect; consumers then keep what
+    # this run did not report rather than retiring it on a guess.
+    scope = _run_scope(session.config)
+    if scope == "full" and _stopped_early(session, exitstatus):
+        scope = "filtered"
+    if scope is not None:
+        raw_run["runScope"] = scope
+
+    if covered:
+        raw_run["coveredSourceFiles"] = covered
+
+    if incomplete:
+        raw_run["incompleteSourceFiles"] = incomplete
+
+    output_path = _resolve_output_path(project_root)
 
     write_raw_run(raw_run, output_path)
+    _print_next_step(output_path)
+
+
+def _print_next_step(output_path: str) -> None:
+    """Tell the user how to turn the run JSON into a report.
+
+    The JS adapters render reports in-process, so their users never need to know
+    the CLI exists. pytest hands off to the CLI instead, so without this the run
+    ends with a file and no indication of what to do with it. stderr keeps piped
+    output clean; EXECUTABLE_STORIES_QUIET silences it in CI.
+    """
+    if os.environ.get("EXECUTABLE_STORIES_QUIET"):
+        return
+    print(f"\nexecutable-stories: wrote {output_path}", file=sys.stderr)
+    print(
+        f"  next: executable-stories format {output_path} --format html",
+        file=sys.stderr,
+    )

executable_stories/_story_api.py

@@ -13,14 +13,21 @@ Usage in tests::
 
 from __future__ import annotations
 
+import inspect
 import json
 import os
 import threading
 import time
-from typing import Any, Callable, TypeVar
+from collections.abc import Sequence
+from typing import Any, Callable, TypeVar, Union
+
+from executable_stories._collector import _collector
 
 _T = TypeVar("_T")
 
+#: A ticket id, a ticket object, or a list mixing the two.
+TicketArg = Union[str, dict[str, Any], Sequence[Union[str, dict[str, Any]]], None]
+
 
 class _StoryContext:
     """Per-test story context stored in thread-local storage."""
@@ -30,6 +37,7 @@ class _StoryContext:
         "steps",
         "tags",
         "tickets",
+        "covers",
         "meta",
         "suite_path",
         "docs",
@@ -40,6 +48,9 @@ class _StoryContext:
         "active_timers",
         "timer_counter",
         "otel_spans",
+        "planned",
+        "started_at_ms",
+        "failed_step",
     )
 
     def __init__(
@@ -48,12 +59,14 @@ class _StoryContext:
         *,
         tags: list[str] | None = None,
         tickets: list[dict[str, Any]] | None = None,
+        covers: list[str] | None = None,
         meta: dict[str, Any] | None = None,
     ) -> None:
         self.scenario = scenario
         self.steps: list[dict[str, Any]] = []
         self.tags = tags or []
         self.tickets: list[dict[str, Any]] = tickets or []
+        self.covers = covers or []
         self.meta = meta or {}
         self.suite_path: list[str] = []
         self.docs: list[dict[str, Any]] = []
@@ -64,6 +77,10 @@ class _StoryContext:
         self.active_timers: dict[int, dict[str, Any]] = {}
         self.timer_counter: int = 0
         self.otel_spans: list[dict[str, Any]] | None = None
+        self.planned: bool = False
+        self.started_at_ms: float = time.time() * 1000
+        # The wrapped step whose body raised, if one did.
+        self.failed_step: dict[str, Any] | None = None
 
 
 class Story:
@@ -82,26 +99,26 @@ class Story:
         return getattr(self._local, "ctx", None)
 
     @staticmethod
-    def _normalize_tickets(ticket: Any) -> list[dict[str, Any]] | None:
+    def _normalize_tickets(ticket: TicketArg) -> list[dict[str, Any]] | None:
         """Normalize ticket input to list of ``{"id": ...}`` dicts."""
         if ticket is None:
             return None
-        if not isinstance(ticket, list):
-            ticket = [ticket]
-        return [{"id": t} if isinstance(t, str) else t for t in ticket]
+        tickets = [ticket] if isinstance(ticket, (str, dict)) else ticket
+        return [{"id": t} if isinstance(t, str) else dict(t) for t in tickets]
 
     def init(
         self,
         scenario: str,
         *,
         tags: list[str] | None = None,
-        ticket: str | list[str] | dict | list[dict | str] | None = None,
+        ticket: TicketArg = None,
+        covers: list[str] | None = None,
         meta: dict[str, Any] | None = None,
         trace_url_template: str | None = None,
     ) -> None:
         """Start a new story context for the current test."""
         tickets = self._normalize_tickets(ticket)
-        self._local.ctx = _StoryContext(scenario, tags=tags, tickets=tickets, meta=meta)
+        self._local.ctx = _StoryContext(scenario, tags=tags, tickets=tickets, covers=covers, meta=meta)
 
         # OTel bridge: detect active span, flow data bidirectionally
         ctx = self._local.ctx
@@ -137,6 +154,80 @@ class Story:
         except Exception:
             pass  # OTel not available or no active span
 
+    def feature(
+        self,
+        title: str,
+        *,
+        kind: str | None = None,
+        narrative: str | None = None,
+        tags: list[str] | None = None,
+        glossary: list[dict[str, str]] | None = None,
+        source_file: str | None = None,
+    ) -> None:
+        """Declare what a module's scenarios are for, ahead of the examples.
+
+        Scenarios say what the system does. A declaration says why the feature
+        exists and who it serves, so a reader meets the intent before the
+        examples. Call it once per test module, at module scope::
+
+            story.feature(
+                "Anyone can do arithmetic without a calculator app",
+                kind="ability",
+                narrative="Switching apps for a quick sum loses your place.",
+            )
+
+        ``kind`` is ``"feature"`` by default. ``"ability"`` frames it as
+        something a person can now do; ``"business-need"`` covers cross-cutting
+        concerns like security or performance that nobody asks for by name.
+
+        The source file is taken from the caller, so the declaration lands on
+        the module that made it.
+        """
+        declared: dict[str, Any] = {
+            "title": title,
+            "sourceFile": source_file or _caller_file(),
+        }
+        if kind is not None:
+            declared["kind"] = kind
+        if narrative is not None:
+            declared["narrative"] = narrative
+        if tags:
+            declared["tags"] = tags
+        if glossary:
+            declared["glossary"] = [{"term": t["term"], "definition": t["definition"]} for t in glossary]
+
+        _collector.record_feature(declared)
+
+    def planned(
+        self,
+        scenario: str,
+        *,
+        tags: list[str] | None = None,
+        ticket: TicketArg = None,
+        covers: list[str] | None = None,
+        meta: dict[str, Any] | None = None,
+    ) -> None:
+        """Declare a scenario that is specified but not built yet.
+
+        It appears in the report marked "planned" and stops being planned once
+        someone writes it as a real story with ``story.init``::
+
+            def test_checkout_blocks_suspended_account():
+                story.planned("checkout is blocked for a suspended account")
+
+        ``pytest.mark.skip`` means "do not run this now", which is a different
+        claim from "we have not built this yet", so this does not skip for you.
+        """
+        self.init(scenario, tags=tags, ticket=ticket, covers=covers, meta=meta)
+        ctx = self._ctx
+        if ctx is not None:
+            ctx.planned = True
+
+    def is_planned(self) -> bool:
+        """True when the current test declared a planned scenario."""
+        ctx = self._ctx
+        return bool(ctx and ctx.planned)
+
     def _get_meta(self) -> dict[str, Any] | None:
         """Return the StoryMeta dict for the current test, or None."""
         ctx = self._ctx
@@ -150,6 +241,8 @@ class Story:
             result["tags"] = list(ctx.tags)
         if ctx.tickets:
             result["tickets"] = list(ctx.tickets)
+        if ctx.covers:
+            result["covers"] = list(ctx.covers)
         if ctx.meta:
             result["meta"] = dict(ctx.meta)
         if ctx.suite_path:
@@ -158,8 +251,29 @@ class Story:
             result["docs"] = list(ctx.docs)
         if ctx.otel_spans:
             result["otelSpans"] = ctx.otel_spans
+        # A planned scenario never ran, so it has no start time.
+        if not ctx.planned:
+            result["startedAtMs"] = ctx.started_at_ms
         return result
 
+    def _step_trail(self) -> str | None:
+        """The story's steps as a checklist for a failed test's report.
+
+        The failing step is the wrapped step whose body raised, else the last
+        step: a marker states a claim and the assertion that broke follows it.
+        When the last step is a wrapped body that finished, the failure came
+        after it.
+        """
+        ctx = self._ctx
+        if ctx is None or not ctx.steps:
+            return None
+        last = ctx.steps[-1]
+        failed = ctx.failed_step or (None if last.get("wrapped") else last)
+        lines = [f"  {'✗' if s is failed else '✓'} {s['keyword']} {s['text']}" for s in ctx.steps]
+        if failed is None:
+            lines.append("  ✗ (failed after the last step)")
+        return "\n".join(lines)
+
     def _get_attachments(self) -> list[dict[str, Any]]:
         """Return the attachments list for the current test."""
         ctx = self._ctx
@@ -191,13 +305,15 @@ class Story:
         ctx = self._ctx
         if ctx is None:
             raise RuntimeError(f"story.{keyword.lower()}() called before story.init()")
+        # A new step means the test caught an earlier wrapped step's exception.
+        ctx.failed_step = None
         # Auto-And: repeated primary keywords render as "And"
         if keyword in ("Given", "When", "Then"):
             if keyword in ctx.seen_primary_keywords:
                 keyword = "And"
             else:
                 ctx.seen_primary_keywords.add(keyword)
-        step: dict[str, Any] = {"keyword": keyword, "text": text}
+        step: dict[str, Any] = {"keyword": keyword, "text": text, "startedAtMs": time.time() * 1000}
         step["id"] = f"step-{ctx.step_counter}"
         ctx.step_counter += 1
         if mode is not None:
@@ -271,11 +387,22 @@ class Story:
         step = ctx._current_step
         assert step is not None
         step["wrapped"] = True
+        # Wrapping a claim is the only signal pytest can give that the step
+        # checked something: the body ran to completion. Setup steps arrange, so
+        # only a claim counts — tested against the keyword as written, since
+        # auto-And rewrites a repeated Then before the step is stored.
+        if keyword == "Then":
+            step["assertions"] = 1
 
         start = time.perf_counter()
         try:
             result = body()
             return result
+        except BaseException:
+            # A nested step that raised first keeps the mark.
+            if ctx.failed_step is None:
+                ctx.failed_step = step
+            raise
         finally:
             step["durationMs"] = (time.perf_counter() - start) * 1000.0
 
@@ -394,7 +521,8 @@ class Story:
         last = ctx.steps[-1]
         if "docs" not in last:
             last["docs"] = []
-        return last["docs"]
+        docs: list[dict[str, Any]] = last["docs"]
+        return docs
 
     def _story_docs(self) -> list[dict[str, Any]]:
         """Return the story-level docs list."""
@@ -459,7 +587,9 @@ class Story:
         self._attach_doc(entry)
         return entry
 
-    def code(self, label: str, content: str, *, lang: str | None = None, children: list[dict[str, Any]] | None = None) -> dict[str, Any]:
+    def code(
+        self, label: str, content: str, *, lang: str | None = None, children: list[dict[str, Any]] | None = None
+    ) -> dict[str, Any]:
         """Add a code block."""
         entry: dict[str, Any] = {
             "kind": "code",
@@ -475,7 +605,9 @@ class Story:
         self._attach_doc(entry)
         return entry
 
-    def table(self, label: str, columns: list[str], rows: list[list[str]], *, children: list[dict[str, Any]] | None = None) -> dict[str, Any]:
+    def table(
+        self, label: str, columns: list[str], rows: list[list[str]], *, children: list[dict[str, Any]] | None = None
+    ) -> dict[str, Any]:
         """Add a table."""
         entry: dict[str, Any] = {
             "kind": "table",
@@ -513,7 +645,9 @@ class Story:
         self._attach_doc(entry)
         return entry
 
-    def mermaid(self, code: str, *, title: str | None = None, children: list[dict[str, Any]] | None = None) -> dict[str, Any]:
+    def mermaid(
+        self, code: str, *, title: str | None = None, children: list[dict[str, Any]] | None = None
+    ) -> dict[str, Any]:
         """Add a Mermaid diagram."""
         entry: dict[str, Any] = {"kind": "mermaid", "code": code, "phase": "runtime"}
         if title is not None:
@@ -524,7 +658,9 @@ class Story:
         self._attach_doc(entry)
         return entry
 
-    def screenshot(self, path: str, *, alt: str | None = None, children: list[dict[str, Any]] | None = None) -> dict[str, Any]:
+    def screenshot(
+        self, path: str, *, alt: str | None = None, children: list[dict[str, Any]] | None = None
+    ) -> dict[str, Any]:
         """Add a screenshot reference."""
         entry: dict[str, Any] = {"kind": "screenshot", "path": path, "phase": "runtime"}
         if alt is not None:
@@ -535,6 +671,73 @@ class Story:
         self._attach_doc(entry)
         return entry
 
+    def video(
+        self,
+        path: str,
+        *,
+        caption: str | None = None,
+        poster: str | None = None,
+        children: list[dict[str, Any]] | None = None,
+    ) -> dict[str, Any]:
+        """Add a video reference, played inline in HTML reports."""
+        entry: dict[str, Any] = {"kind": "video", "path": path, "phase": "runtime"}
+        if caption is not None:
+            entry["caption"] = caption
+        if poster is not None:
+            entry["poster"] = poster
+        if children:
+            entry["children"] = children
+            self._dedup_children(children)
+        self._attach_doc(entry)
+        return entry
+
+    def state(
+        self, value: Any, *, label: str | None = None, children: list[dict[str, Any]] | None = None
+    ) -> dict[str, Any]:
+        """Add a state snapshot (storyboard frame). Value must be JSON-serializable."""
+        entry: dict[str, Any] = {"kind": "state", "value": value, "phase": "runtime"}
+        if label is not None:
+            entry["label"] = label
+        if children:
+            entry["children"] = children
+            self._dedup_children(children)
+        self._attach_doc(entry)
+        return entry
+
+    def html(
+        self,
+        *,
+        path: str | None = None,
+        url: str | None = None,
+        content: str | None = None,
+        title: str | None = None,
+        height: int | str | None = None,
+        children: list[dict[str, Any]] | None = None,
+    ) -> dict[str, Any]:
+        """Embed HTML in an always-sandboxed iframe.
+
+        Exactly one of ``path``, ``url``, or ``content`` must be provided.
+        """
+        sources = [s for s in (path, url, content) if s is not None]
+        if len(sources) != 1:
+            raise ValueError("story.html() requires exactly one of path, url, or content")
+        entry: dict[str, Any] = {"kind": "html", "phase": "runtime"}
+        if path is not None:
+            entry["path"] = path
+        if url is not None:
+            entry["url"] = url
+        if content is not None:
+            entry["content"] = content
+        if title is not None:
+            entry["title"] = title
+        if height is not None:
+            entry["height"] = height
+        if children:
+            entry["children"] = children
+            self._dedup_children(children)
+        self._attach_doc(entry)
+        return entry
+
     def custom(self, type: str, data: Any, *, children: list[dict[str, Any]] | None = None) -> dict[str, Any]:
         """Add a custom doc entry."""
         entry: dict[str, Any] = {
@@ -552,3 +755,22 @@ class Story:
 
 # Module-level singleton
 story = Story()
+
+
+def _caller_file() -> str:
+    """Source file of whoever called into this module.
+
+    ``story.feature(...)`` runs at import time, before pytest has a current
+    item, so the stack is the only place the module path is available.
+    """
+    frame = inspect.currentframe()
+    try:
+        while frame is not None:
+            filename = frame.f_code.co_filename
+            if not filename.endswith(os.sep + "_story_api.py"):
+                return filename
+            frame = frame.f_back
+    finally:
+        del frame
+
+    return ""

executable_stories/_types.py

@@ -6,7 +6,11 @@ At runtime everything is just dicts serialized to JSON.
 
 from __future__ import annotations
 
-from typing import Any, NotRequired, TypedDict
+from typing import TYPE_CHECKING, Any, TypedDict
+
+if TYPE_CHECKING:
+    # typing.NotRequired is 3.11+; annotations are strings here, so only type checkers see it.
+    from typing_extensions import NotRequired
 
 # ── DocEntry variants ──────────────────────────────────────────────
 
@@ -83,6 +87,34 @@ class ScreenshotDoc(TypedDict):
     children: NotRequired[list["DocEntry"]]
 
 
+class VideoDoc(TypedDict):
+    kind: str  # "video"
+    path: str
+    phase: str
+    caption: NotRequired[str]
+    poster: NotRequired[str]
+    children: NotRequired[list["DocEntry"]]
+
+
+class StateDoc(TypedDict):
+    kind: str  # "state"
+    value: Any
+    phase: str
+    label: NotRequired[str]
+    children: NotRequired[list["DocEntry"]]
+
+
+class HtmlDoc(TypedDict):
+    kind: str  # "html"
+    phase: str
+    path: NotRequired[str]
+    url: NotRequired[str]
+    content: NotRequired[str]
+    title: NotRequired[str]
+    height: NotRequired[int | str]
+    children: NotRequired[list["DocEntry"]]
+
+
 class CustomDoc(TypedDict):
     kind: str  # "custom"
     type: str
@@ -92,7 +124,21 @@ class CustomDoc(TypedDict):
 
 
 # Union of all doc entry types
-DocEntry = NoteDoc | TagDoc | KvDoc | CodeDoc | TableDoc | LinkDoc | SectionDoc | MermaidDoc | ScreenshotDoc | CustomDoc
+DocEntry = (
+    NoteDoc
+    | TagDoc
+    | KvDoc
+    | CodeDoc
+    | TableDoc
+    | LinkDoc
+    | SectionDoc
+    | MermaidDoc
+    | ScreenshotDoc
+    | VideoDoc
+    | StateDoc
+    | HtmlDoc
+    | CustomDoc
+)
 
 
 # ── Ticket ────────────────────────────────────────────────────────
@@ -138,7 +184,12 @@ class StoryStep(TypedDict):
     id: NotRequired[str]
     mode: NotRequired[str]
     wrapped: NotRequired[bool]
+    # Assertions attributable to this step. pytest has no assertion counter, so
+    # this is set only when the author wraps a claim in expect/fn("Then", ...).
+    # An absent key means unobserved, which is not the same as zero.
+    assertions: NotRequired[int]
     durationMs: NotRequired[float]
+    startedAtMs: NotRequired[float]
     docs: NotRequired[list[DocEntry]]
 
 
@@ -150,10 +201,12 @@ class StoryMeta(TypedDict):
     steps: NotRequired[list[StoryStep]]
     tags: NotRequired[list[str]]
     tickets: NotRequired[list[TicketDoc]]
+    covers: NotRequired[list[str]]
     meta: NotRequired[dict[str, Any]]
     suitePath: NotRequired[list[str]]
     docs: NotRequired[list[DocEntry]]
     sourceOrder: NotRequired[int]
+    startedAtMs: NotRequired[float]
 
 
 # ── RawTestCase ────────────────────────────────────────────────────
@@ -204,3 +257,13 @@ class RawRun(TypedDict):
     gitSha: NotRequired[str]
     ci: NotRequired[RawCIInfo]
     meta: NotRequired[dict[str, Any]]
+    # How much of each source file this run covered: "full" (no name filter was
+    # applied), "filtered" (one was), or absent when it cannot be determined.
+    runScope: NotRequired[str]
+    # Every file this run executed a test in, whether or not it produced a
+    # story, so a file emptied of scenarios is distinguishable from one that
+    # never ran.
+    coveredSourceFiles: NotRequired[list[str]]
+    # Files this run cannot speak for, so a consumer keeps what they last
+    # documented rather than treating the run as authoritative.
+    incompleteSourceFiles: NotRequired[list[str]]

executable_stories_pytest-0.2.0.dist-info/METADATA

@@ -0,0 +1,111 @@
+Metadata-Version: 2.4
+Name: executable-stories-pytest
+Version: 0.2.0
+Summary: pytest plugin for executable-stories BDD documentation
+Author: Jag Reehal
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/jagreehal/executable-stories
+Project-URL: Repository, https://github.com/jagreehal/executable-stories.git
+Project-URL: Documentation, https://github.com/jagreehal/executable-stories#readme
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: otel
+Requires-Dist: opentelemetry-api>=1.20; extra == "otel"
+Provides-Extra: dev
+Requires-Dist: ruff>=0.6.0; extra == "dev"
+Requires-Dist: mypy>=1.5.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Dynamic: license-file
+
+# executable-stories-pytest
+
+pytest plugin for executable-stories.
+
+Adds BDD-style story helpers and emits raw story run JSON so pytest tests can be rendered into executable documentation.
+
+## Install
+
+```bash
+pip install executable-stories-pytest
+```
+
+The PyPI distribution name is `executable-stories-pytest`, but the import name is `executable_stories`:
+
+```python
+from executable_stories import story
+```
+
+## Usage
+
+```python
+from executable_stories import story
+
+
+def test_login_success():
+    story.init("User logs in", tags=["auth", "smoke"])
+    story.given("a registered user")
+    story.when("they submit valid credentials")
+    story.then("they see the dashboard")
+```
+
+## Features
+
+- BDD steps: `given`, `when`, `then`, `and_`, `but`
+- Aliases: `arrange`, `act`, `assert_`, `setup`, `context`, `execute`, `action`, `verify`
+- Rich docs: `note`, `tag`, `kv`, `json`, `code`, `table`, `link`, `section`, `mermaid`, `screenshot`, `video`, `html`, `state`, `custom`
+- `story.state(value, label=None)` — JSON-serializable snapshot of "what the world looks like" at this step (a storyboard frame); consecutive same-label states are diffed at render time
+- Feature declarations: `story.feature(...)` at module level heads every scenario in the file
+- Planned scenarios: `story.planned("…")` records behaviour that is specified but not built
+- Source coverage links: `covers=[...]` in `story.init(...)`
+- Step timing: `start_timer` / `end_timer`
+- Attachments: `attach(...)`
+- OTel spans + trace links: `attach_spans(...)`, `trace_url_template` in `story.init(...)`, `OTEL_TRACE_URL_TEMPLATE`
+
+## Output
+
+The plugin writes `.executable-stories/raw-run.json` under pytest's root directory when the
+session finishes. Set `EXECUTABLE_STORIES_OUTPUT` to move it: a relative path is resolved
+against the project root, an absolute one is used as given. The file is renamed into place,
+so a reader never sees a half-written run.
+
+Formatting the raw run updates one canonical report per source file under `reports/by-file/`.
+Each run says what it reached so those reports stay honest as tests come and go:
+
+- `coveredSourceFiles` — every file the run executed a test in, whether or not it produced a
+  story, so deleting a file's last scenario retires it
+- `incompleteSourceFiles` — files the run cannot speak for: a skipped test, a broken fixture
+  or teardown, a module that failed to import, or a test that failed before `story.init`
+- `runScope` — `"filtered"` for `-k`, `-m`, `--deselect`, `--last-failed`, a `file.py::test`
+  node id, or a run that ended early (`-x`, `--maxfail`, Ctrl-C, an internal or usage
+  error); otherwise `"full"`
+- `gitSha` and `packageVersion` — which commit the run describes, and what produced it
+
+Source paths are relative to the project root, so a report keeps its identity across machines
+and CI.
+
+pytest exposes no assertion counter. Use `story.expect("claim", callable)` to declare
+assertion evidence. A plain `story.then()` followed by Python `assert` remains unobserved,
+not zero.
+
+Pass that file to the `executable-stories` CLI (from the `executable-stories-formatters` package) to render reports:
+
+```bash
+npx --package executable-stories-formatters executable-stories format .executable-stories/raw-run.json --format html
+
+# The path is optional — `format` defaults to .executable-stories/raw-run.json
+npx --package executable-stories-formatters executable-stories format --format html
+
+# Diagnose the run JSON if a report won't generate (schema drift, empty run)
+npx --package executable-stories-formatters executable-stories doctor
+```
+
+Supported formats include `html`, `markdown`, `junit`, and the Cucumber outputs. Use `--output-dir` to choose where reports are written.
+
+## Verify
+
+From repo root:
+
+```bash
+pnpm run verify:pytest
+```

executable_stories_pytest-0.2.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+executable_stories/__init__.py,sha256=X-m5x5nt_kkzd8IGJZ52e6lfr6aDArhbXci9K0fLWLM,132
+executable_stories/_collector.py,sha256=gYQKlNTYpcCaNiTDbJXEV4IDWC4T7mF9zxqBz0zx_6k,1508
+executable_stories/_json_writer.py,sha256=FrRuskUN93R-0vVermZTfskv6GZ9Aj6E-khwvmEjnH8,987
+executable_stories/_plugin.py,sha256=IwhqMkrxjsJ9PFSyOFRRmeXTuUNSZ0VqRpcR-vpnguM,16199
+executable_stories/_story_api.py,sha256=u3I__cTQr_5h_2Z6vD_3ZZzO3xfPj1-DlnftkCYCwgY,29517
+executable_stories/_types.py,sha256=un-CvxwyX1KfO3Mf5RQxWkEqqkN9yuHwbA1zDCEEV6I,7459
+executable_stories_pytest-0.2.0.dist-info/licenses/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+executable_stories_pytest-0.2.0.dist-info/METADATA,sha256=E7d16fEgeTeoFioCBrcuE0uH4_0HnWbTlzZJp26NAgI,4546
+executable_stories_pytest-0.2.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+executable_stories_pytest-0.2.0.dist-info/entry_points.txt,sha256=NXzZqAD31EI6q3ovbbWQE7VOzsok09tPpmd-QPgSTiE,59
+executable_stories_pytest-0.2.0.dist-info/top_level.txt,sha256=0CmAUpeJrtl-ykfogdr3L373JMtP92uU1P7-GIlbF7I,19
+executable_stories_pytest-0.2.0.dist-info/RECORD,,

{executable_stories_pytest-0.1.0.dist-info → executable_stories_pytest-0.2.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (84.2.1)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

executable_stories_pytest-0.2.0.dist-info/licenses/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.

executable_stories_pytest-0.1.0.dist-info/METADATA

@@ -1,23 +0,0 @@
-Metadata-Version: 2.4
-Name: executable-stories-pytest
-Version: 0.1.0
-Summary: pytest plugin for executable-stories BDD documentation
-Author: Jag Reehal
-License-Expression: MIT
-Project-URL: Homepage, https://github.com/jagreehal/executable-stories
-Project-URL: Repository, https://github.com/jagreehal/executable-stories.git
-Project-URL: Documentation, https://github.com/jagreehal/executable-stories#readme
-Requires-Python: >=3.12
-Description-Content-Type: text/markdown
-Provides-Extra: otel
-Requires-Dist: opentelemetry-api>=1.20; extra == "otel"
-Provides-Extra: dev
-Requires-Dist: ruff>=0.6.0; extra == "dev"
-Requires-Dist: mypy>=1.5.0; extra == "dev"
-Requires-Dist: pytest>=7.4.0; extra == "dev"
-
-# executable-stories-pytest
-
-pytest plugin for executable-stories.
-
-Adds BDD-style story helpers and structured story metadata so pytest tests can generate executable documentation.

executable_stories_pytest-0.1.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-executable_stories/__init__.py,sha256=X-m5x5nt_kkzd8IGJZ52e6lfr6aDArhbXci9K0fLWLM,132
-executable_stories/_collector.py,sha256=JCl4crRHdAx1qqqW6ia7ABWi2yG4NN91IPZgB-VWVOs,932
-executable_stories/_json_writer.py,sha256=l0wlGiijxTtEzdQ4N0oQJZI4uEHer-aIAUNlFQ-wgws,528
-executable_stories/_plugin.py,sha256=f-QhkcyndouaymIiM38GOg63HRrvVN9U7lXnIiZZAyA,7190
-executable_stories/_story_api.py,sha256=jOSf4-9MJGumVGhlKrX6hbEsD7tXY3V0D99Fxp3wGMw,21381
-executable_stories/_types.py,sha256=iIoBdZ63eT6TIkimO7o_PXMzVSBBsope5L4gGL5ulAw,5648
-executable_stories_pytest-0.1.0.dist-info/METADATA,sha256=nQLaU3J04FiaKUgN1wGAxJqYBk5Ho3wqimVZl_aP_oY,882
-executable_stories_pytest-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-executable_stories_pytest-0.1.0.dist-info/entry_points.txt,sha256=NXzZqAD31EI6q3ovbbWQE7VOzsok09tPpmd-QPgSTiE,59
-executable_stories_pytest-0.1.0.dist-info/top_level.txt,sha256=0CmAUpeJrtl-ykfogdr3L373JMtP92uU1P7-GIlbF7I,19
-executable_stories_pytest-0.1.0.dist-info/RECORD,,