Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,13 @@ adheres to [Semantic Versioning](https://semver.org/).

## [Unreleased]

### Added
- P1 repair-layer primitives for validator bridges, schema drift
harmonization, duplicate/replay defense, and human review queues.
- Top-level bridge adapters: `freshdata.from_gx`, `freshdata.from_dbt_failures`,
`freshdata.from_pandera_errors`, `freshdata.emit_gx_expectations`, and
`freshdata.emit_dbt_tests`.

### Fixed
- **Outliers: an explicit `outlier_action` is now honored.** Under the default
`strategy="balanced"`, `outlier_action="cap"` (and `"remove"`) was silently
Expand Down
54 changes: 54 additions & 0 deletions docs/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,60 @@ top-level attribute of `freshdata` (e.g. `import freshdata as fd; fd.clean(...)`

::: freshdata.compare_clean

## Validator bridges

::: freshdata.from_gx

::: freshdata.from_dbt_failures

::: freshdata.from_pandera_errors

::: freshdata.emit_gx_expectations

::: freshdata.emit_dbt_tests

::: freshdata.ValidationBridgeResult

::: freshdata.ValidationFailure

## Schema drift

::: freshdata.SchemaHarmonizer

::: freshdata.SchemaContract

::: freshdata.ColumnContract

::: freshdata.SchemaColumnMapping

::: freshdata.SchemaHarmonizationResult

::: freshdata.MigrationDiff

::: freshdata.QuarantineResult

## Duplicate and replay defense

::: freshdata.DuplicateDefense

::: freshdata.DuplicateDefenseReport

::: freshdata.DuplicateExplanation

::: freshdata.IdempotencyKey

::: freshdata.BatchManifest

## Human review queues

::: freshdata.ReviewQueue

::: freshdata.ReviewDataset

::: freshdata.ReviewTask

::: freshdata.ReviewOption

## Configuration

::: freshdata.CleanConfig
Expand Down
49 changes: 49 additions & 0 deletions src/freshdata/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,24 @@
"""

from .api import clean, infer_roles, plan, profile, repair, suggest_plan
from .bridges import (
ValidationBridgeResult,
ValidationFailure,
emit_dbt_tests,
emit_gx_expectations,
from_dbt_failures,
from_gx,
from_pandera_errors,
)
from .cleaner import Cleaner
from .config import CleanConfig
from .duplicate_defense import (
BatchManifest,
DuplicateDefense,
DuplicateDefenseReport,
DuplicateExplanation,
IdempotencyKey,
)
from .explain import ExplainReport, explain_clean
from .plan import (
CleanPlan,
Expand All @@ -37,27 +53,60 @@
)
from .profile import ColumnProfile, Profile
from .report import Action, CleanReport
from .review import ReviewDataset, ReviewOption, ReviewQueue, ReviewTask
from .schema_drift import (
ColumnContract,
MigrationDiff,
QuarantineResult,
SchemaColumnMapping,
SchemaContract,
SchemaHarmonizationResult,
SchemaHarmonizer,
)

__version__ = "1.0.0"

__all__ = [
"Action",
"BatchManifest",
"CleanConfig",
"CleanPlan",
"CleanReport",
"Cleaner",
"ColumnPlan",
"ColumnContract",
"DuplicateDefense",
"DuplicateDefenseReport",
"DuplicateExplanation",
"ExplainReport",
"ColumnProfile",
"IdempotencyKey",
"MigrationDiff",
"Profile",
"QuarantineResult",
"RepairPatch",
"RepairPlan",
"ReviewItem",
"ReviewDataset",
"ReviewOption",
"ReviewQueue",
"ReviewTask",
"SchemaColumnMapping",
"SchemaContract",
"SchemaHarmonizationResult",
"SchemaHarmonizer",
"ValidationBridgeResult",
"ValidationFailure",
"__version__",
"clean",
"compare_clean",
"compare_plans",
"emit_dbt_tests",
"emit_gx_expectations",
"explain_clean",
"from_dbt_failures",
"from_gx",
"from_pandera_errors",
"infer_roles",
"plan",
"profile",
Expand Down
Loading
Loading