Skip to content

API Reference

Complete reference for Nyctea's public API.

  • Validation Engine

    ValidationResult, ValidationReport, ColumnValidationStats, ErrorReportConfig.

    Engine

  • Schema Models

    Configuration types from nyctea.schema: ColumnSchema, Parser, Check, FrameParser, FrameCheck.

    Schema

  • Validator Registry

    Extension types from nyctea.validators: ValidatorRegistry, ColumnParser, ColumnCheck, FrameParser, FrameCheck.

    Registry

  • Data Ingestion

    Schema-aware readers for CSV and Parquet.

    Ingest

Public API layers

The root package contains the common workflow:

from nyctea import (
    SchemaModel, Registry, register_builtins, checker, parser,
    ErrorReportConfig, ValidationReport, ValidationResult,
    NycteaError, PipelineError, ValidationError, ValidatorError,
)

Advanced types use explicit namespaces so similarly named schema specifications and validator classes cannot be confused:

from nyctea.schema import Check, ColumnSchema, FrameCheck, FrameParser, Parser
from nyctea.validators import ColumnCheck, ColumnParser, ValidatorMetadata
from nyctea.engine import ColumnValidationStats