behave-data 0.1.2__tar.gz → 0.1.4__tar.gz

behave_data-0.1.4/.github/workflows/docs.yml

@@ -0,0 +1,53 @@
+name: Docs
+
+on:
+  push:
+    branches: [main]
+    tags: ["v*"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e ".[docs,all]"
+
+      - name: Build Sphinx docs
+        run: |
+          sphinx-build -W -b html docs docs/_build/html
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/_build/html
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

{behave_data-0.1.2 → behave_data-0.1.4}/CHANGELOG.md

@@ -5,6 +5,39 @@ All notable changes to this project will be documented in this file.
 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).
 
+## [0.1.4] - 2026-07-17
+
+### Added
+
+- Sphinx documentation site with furo theme
+- 13 documentation pages: quickstart, installation, typed tables, null handling, diff, raw tables, dynamic examples, fixtures, builders, secrets, tags, hooks, configuration, API reference, migration guide, changelog
+- GitHub Actions workflow `docs.yml` to build and deploy docs to GitHub Pages
+- Documentation URL in `pyproject.toml`
+- `docs` and `all` optional dependency extras
+
+### Fixed
+
+- `test_to_pandas_raises_without_pandas` now uses `monkeypatch` on `sys.modules["pandas"]` for robustness when `pandas` extra is installed
+
+## [0.1.3] - 2026-07-17
+
+### Added
+
+- 75 edge case unit tests covering hooks, secrets, examples, raw_table, yaml, types, diff, fixtures, loaders, config, and manager
+- 4 new E2E Behave integration features: fixtures_builders, secrets, typed_table_edge, dynamic_examples
+- 27 E2E scenarios with 64 steps testing all behave-data features in real Behave
+
+### Fixed
+
+- `tags.py` now strips `@` prefix from Behave tags (Behave strips `@` from scenario tags)
+- `tags.py` `@needs_data` now sets attribute on context in addition to `_behave_data_loaded`
+- `tags.py` cleanup functions now support both `func(context)` and `func()` signatures
+
+### Changed
+
+- Coverage increased from 94% to 98%
+- Total tests: 411 passed, 1 skipped (pandas optional)
+
 ## [0.1.2] - 2026-07-17
 
 ### Fixed

{behave_data-0.1.2 → behave_data-0.1.4}/PKG-INFO

@@ -1,8 +1,9 @@
 Metadata-Version: 2.4
 Name: behave-data
-Version: 0.1.2
+Version: 0.1.4
 Summary: Data management for Behave — typed tables, diff, dynamic examples, fixtures, secrets
 Project-URL: Homepage, https://github.com/MathiasPaulenko/behave-data
+Project-URL: Documentation, https://mathiaspaulenko.github.io/behave-data
 Project-URL: Repository, https://github.com/MathiasPaulenko/behave-data
 Project-URL: Issues, https://github.com/MathiasPaulenko/behave-data/issues
 Project-URL: Changelog, https://github.com/MathiasPaulenko/behave-data/blob/main/CHANGELOG.md
@@ -23,6 +24,14 @@ Classifier: Typing :: Typed
 Requires-Python: >=3.11
 Requires-Dist: behave-tables>=1.3.0
 Requires-Dist: behave>=1.2.6
+Provides-Extra: all
+Requires-Dist: boto3>=1.34; extra == 'all'
+Requires-Dist: hvac>=2.0; extra == 'all'
+Requires-Dist: openpyxl>=3.1; extra == 'all'
+Requires-Dist: pandas>=2.0; extra == 'all'
+Requires-Dist: pyyaml>=6.0; extra == 'all'
+Requires-Dist: requests>=2.31; extra == 'all'
+Requires-Dist: sqlalchemy>=2.0; extra == 'all'
 Provides-Extra: aws
 Requires-Dist: boto3>=1.34; extra == 'aws'
 Provides-Extra: dev
@@ -31,6 +40,10 @@ Requires-Dist: mypy>=1.10; extra == 'dev'
 Requires-Dist: pytest-cov>=5.0; extra == 'dev'
 Requires-Dist: pytest>=8.0; extra == 'dev'
 Requires-Dist: ruff>=0.5; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: furo>=2024.0; extra == 'docs'
+Requires-Dist: myst-parser>=3.0; extra == 'docs'
+Requires-Dist: sphinx>=7.0; extra == 'docs'
 Provides-Extra: excel
 Requires-Dist: openpyxl>=3.1; extra == 'excel'
 Provides-Extra: pandas

{behave_data-0.1.2 → behave_data-0.1.4}/behave_data/__init__.py

@@ -38,7 +38,7 @@ from behave_data.tags import process_tags_after_scenario, process_tags_before_sc
 from behave_data.typed_table import TypedTableWrapper, typed_wrap
 from behave_data.types import TYPE_CONVERTERS, convert_cell, parse_column_header, register_type
 
-__version__ = "0.1.2"
+__version__ = "0.1.4"
 
 __all__ = [
     "BehaveDataError",

{behave_data-0.1.2 → behave_data-0.1.4}/behave_data/tags.py

@@ -29,15 +29,17 @@ def process_tags_before_scenario(context: Any, scenario: Any) -> None:
         context._behave_data_loaded = {}
 
     for tag in tags:
-        if tag.startswith("@needs_data:"):
-            name = tag[len("@needs_data:") :]
+        tag = tag.lstrip("@")
+        if tag.startswith("needs_data:"):
+            name = tag[len("needs_data:") :]
             data = context.data.fixture(name)
             context._behave_data_loaded[name] = data
-        elif tag.startswith("@with_fixture:"):
-            name = tag[len("@with_fixture:") :]
+            setattr(context, name, data)
+        elif tag.startswith("with_fixture:"):
+            name = tag[len("with_fixture:") :]
             data = context.data.fixture(name)
             setattr(context, name, data)
-        elif tag == "@cleanup_after":
+        elif tag == "cleanup_after":
             context._behave_data_cleanup = True
             if not hasattr(context, "_behave_data_cleanup_funcs"):
                 context._behave_data_cleanup_funcs = []
@@ -58,6 +60,9 @@ def process_tags_after_scenario(context: Any, scenario: Any) -> None:
 
     funcs = getattr(context, "_behave_data_cleanup_funcs", [])
     for func in funcs:
-        func(context)
+        try:
+            func(context)
+        except TypeError:
+            func()
 
     context._behave_data_cleanup = False

behave_data-0.1.4/docs/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: a4ddf93e9c365b00b073590171868741
+tags: 645f666f9bcd5a90fca523b33c5a78b7

behave_data-0.1.4/docs/_build/html/.buildinfo.bak

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 3198f64f2fecbc5093ae7e98c6b29ae3
+tags: 645f666f9bcd5a90fca523b33c5a78b7

behave_data-0.1.4/docs/_build/html/_images/logo.svg

@@ -0,0 +1,7 @@
+<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100" width="100" height="100">
+  <rect width="100" height="100" rx="20" fill="#2563eb"/>
+  <rect x="20" y="25" width="60" height="8" rx="2" fill="white"/>
+  <rect x="20" y="42" width="60" height="8" rx="2" fill="white"/>
+  <rect x="20" y="59" width="40" height="8" rx="2" fill="white"/>
+  <circle cx="75" cy="63" r="8" fill="#fbbf24"/>
+</svg>

behave_data-0.1.4/docs/_build/html/_sources/api.md.txt

@@ -0,0 +1,165 @@
+# API Reference
+
+## typed_wrap
+
+```python
+from behave_data import typed_wrap
+
+typed_wrap(table, config=None)
+```
+
+Wraps a Behave `Table` in `TypedTableWrapper`.
+
+- `table`: a `behave.model.Table` or any `TableLike` object.
+- `config`: optional `Config` instance.
+
+Returns a `TypedTableWrapper`.
+
+## raw_table
+
+```python
+from behave_data import raw_table
+
+raw_table(table)
+```
+
+Wraps a table in `RawTable` for header-included access.
+
+## TypedTableWrapper
+
+```python
+from behave_data import TypedTableWrapper
+
+wrapper = TypedTableWrapper(table, config)
+```
+
+Methods:
+
+- `typed_dicts()` → `list[dict[str, Any]]`
+- `typed_objects(cls)` → `list[T]`
+- `clean_headers()` → `list[str]`
+- All `behave-tables` `TableWrapper` methods.
+
+## DataManager
+
+```python
+from behave_data import DataManager, Config
+
+dm = DataManager(Config())
+```
+
+### fixture
+
+```python
+dm.fixture(name, **overrides)
+```
+
+Get fixture data with optional overrides.
+
+### build
+
+```python
+dm.build(name, count=1, overrides=None)
+```
+
+Build data. Returns a list if `count > 1`, otherwise a single dict.
+
+### resolve
+
+```python
+dm.resolve(value)
+```
+
+Resolve a placeholder string. Non-string values pass through.
+
+### mask
+
+```python
+dm.mask(value)
+```
+
+Return `"***"` if `value` is a resolved secret, else original value.
+
+## FixtureRegistry
+
+```python
+from behave_data import FixtureRegistry, data_fixture
+
+registry = FixtureRegistry()
+registry.register("user", lambda: {"name": "Alice"})
+```
+
+`@data_fixture(name, scope="scenario", params=None)` decorator registers a fixture in the global registry.
+
+## BuilderRegistry
+
+```python
+from behave_data import BuilderRegistry, data_builder
+
+registry = BuilderRegistry()
+registry.register("product", lambda o: {"name": "Widget", **o})
+```
+
+`@data_builder(name)` decorator registers a builder.
+
+## Config
+
+```python
+from behave_data import Config
+
+config = Config()
+config = Config.from_file("behave_data.yml")
+```
+
+## diff
+
+```python
+from behave_data import diff
+
+diff(expected, actual, ordered=True, ignore_columns=None, surplus_columns=True)
+```
+
+Raises `TableDiffError` if tables differ.
+
+## resolve_placeholder
+
+```python
+from behave_data import resolve_placeholder
+
+resolve_placeholder(value, config, manager=None)
+```
+
+Resolve `env:`, `file:`, `secret:`, `ref:` placeholders.
+
+## register_type
+
+```python
+from behave_data import register_type
+
+register_type("upper", lambda v: v.upper())
+```
+
+Register a custom type converter for typed table headers.
+
+## Hooks
+
+```python
+from behave_data import (
+    setup_data,
+    before_feature_hook,
+    before_scenario_hook,
+    before_step_hook,
+    after_scenario_hook,
+)
+```
+
+## Exceptions
+
+- `BehaveDataError` — base exception
+- `TypeConversionError` — invalid type conversion
+- `TableDiffError` — table mismatch
+- `ColumnMismatchError` — column mismatch in table operations
+- `LoaderNotFoundError` — unknown loader schema
+- `FixtureNotFoundError` — unknown fixture
+- `BuilderNotFoundError` — unknown builder
+- `OptionalDependencyError` — missing optional dependency

behave_data-0.1.4/docs/_build/html/_sources/builders.md.txt

@@ -0,0 +1,82 @@
+# Builders
+
+Builders construct test data. Unlike fixtures, they are designed for derived fields and batch generation.
+
+## Basic builder
+
+```python
+# features/environment.py
+from behave_data import data_builder
+
+
+@data_builder("product")
+def product(overrides):
+    return {
+        "name": "Widget",
+        "price": 9.99,
+        **overrides,
+    }
+```
+
+Use in a step:
+
+```python
+@when("I build a product")
+def step_build_product(context):
+    context.product = context.data.build("product")
+```
+
+Result:
+
+```python
+{"name": "Widget", "price": 9.99}
+```
+
+## With overrides
+
+```python
+product = context.data.build(
+    "product",
+    overrides={"name": "Gadget", "price": 19.99},
+)
+# {"name": "Gadget", "price": 19.99}
+```
+
+## Build multiple instances
+
+```python
+products = context.data.build("product", count=3)
+# 3 products with default values
+```
+
+## Derived fields
+
+Use previous overrides inside the builder:
+
+```python
+@data_builder("user")
+def user(overrides):
+    base = {
+        "first_name": "Alice",
+        "last_name": "Smith",
+    }
+    base["full_name"] = f"{base['first_name']} {base['last_name']}"
+    return {**base, **overrides}
+```
+
+## Manual registration
+
+```python
+from behave_data import DataManager
+
+dm = DataManager()
+dm.builders.register("order", lambda o: {"items": [], **o})
+order = dm.build("order")
+```
+
+## Builder not found
+
+```python
+context.data.build("unknown")
+# raises BuilderNotFoundError
+```

behave_data-0.1.4/docs/_build/html/_sources/changelog.md.txt

@@ -0,0 +1,4 @@
+# Changelog
+
+```{include} ../CHANGELOG.md
+```

behave_data-0.1.4/docs/_build/html/_sources/configuration.md.txt

@@ -0,0 +1,81 @@
+# Configuration
+
+behave-data can be configured via a YAML or JSON file, or directly in code.
+
+## behave_data.yml
+
+Create a `behave_data.yml` in the root of your project:
+
+```yaml
+null_markers:
+  - ""
+  - "null"
+  - "None"
+  - "N/A"
+  - "n/a"
+
+secret_backend: file
+secret_path: secrets/
+load_base_dir: features/data/
+```
+
+## behave_data.json
+
+```json
+{
+  "null_markers": ["", "null", "None", "N/A"],
+  "secret_backend": "file",
+  "secret_path": "secrets/",
+  "load_base_dir": "features/data/"
+}
+```
+
+## In code
+
+```python
+from behave_data import Config
+
+config = Config(
+    null_markers=frozenset({"", "null", "N/A"}),
+    secret_backend="env",
+    secret_path="secrets/",
+    load_base_dir="features/data/",
+)
+```
+
+## Options
+
+| Option | Default | Description |
+|--------|---------|-------------|
+| `null_markers` | `{"", "null", "None", "N/A"}` | Values converted to `None` |
+| `secret_backend` | `"file"` | Backend for `secret:` placeholders |
+| `secret_path` | `"secrets/"` | Base path for `file:` secrets |
+| `load_base_dir` | `"features/data/"` | Base path for dynamic Examples |
+
+## Loading config manually
+
+```python
+from behave_data import Config
+
+config = Config.from_file("behave_data.yml")
+```
+
+If the file does not exist, a default `Config()` is returned.
+
+## Passing config to setup_data
+
+```python
+from behave_data import setup_data, Config
+
+def before_all(context):
+    setup_data(context, Config.from_file("config/behave_data.yml"))
+```
+
+## Passing config to typed_wrap
+
+```python
+from behave_data import typed_wrap, Config
+
+config = Config(null_markers=frozenset({"", "missing"}))
+result = typed_wrap(context.table, config).typed_dicts()
+```