Skip to content

Tutorials

Step-by-step guides to master PyCharter's features. The data contract is the single source of truth; all tutorials use contract name and contract version (or a contract file) where applicable.

Prefer a quick win?

Use the Cookbook (30-second recipes) or Start here before a full tutorial.

YAML starters

See Templates overview for contract, pipeline, streaming worker, and vocabulary template packs.

Visual workflow

See Contract → ETL → quality for diagrams of step contract: flags and row vs batch quality.

Quick start (30 seconds each)

Topic One snippet
ETL Pipeline(HTTPExtractor(url="...")) \| Rename({...}) \| FileLoader(path="out.json") then await pipeline.arun()
Contracts parse_contract_file("c.yaml") → metadata.to_data_contract() → Validator.from_dict(contract)
Quality check_quality(contract=contract, data=records) or QualityCheck(store).run(contract_name="user", contract_version="1.0.0", data=...)
Metadata store store.store_json_schema("user", "1.0.0", schema); store.get_contract("user", "1.0.0"); store.list_contracts()
API & UI pycharter api and pycharter ui serve

Learning paths

graph LR
    A[ETL Pipelines] --> B[Contracts & Validation]
    B --> C[Quality Monitoring]
    C --> D[Contract Store]
    D --> E[REST API & UI]
  1. Start here — score + pass/fail in one script
  2. Quality monitoring — Parts 1–2 and scheduling
  3. Periodic quality monitoring — cron, worker, pipelines
  4. Comparisons — vs Great Expectations, Soda, etc.

Available Tutorials

  • Building ETL Pipelines

    Learn to build data pipelines with extractors, transformers, and loaders.

    Duration: 30 minutes

    Start Tutorial

  • Data Contracts & Validation

    Define contracts, coercion rules, and validation logic for your data.

    Duration: 25 minutes

    Start Tutorial

  • Data Quality Monitoring

    Monitor quality metrics, track violations, and set threshold alerts.

    Duration: 20 minutes

    Start Tutorial

  • Contract Store & Schema Registry

    Store, version, and retrieve schemas using different backends.

    Duration: 20 minutes

    Start Tutorial

  • REST API & Web UI

    Use PyCharter's API server and interactive web interface.

    Duration: 15 minutes

    Start Tutorial

Prerequisites

Before starting the tutorials, ensure you have:

  • Python 3.11+ installed
  • PyCharter installed (pip install pycharter[server,pipeline])
  • Basic knowledge of Python async/await
  • Familiarity with JSON Schema (helpful but not required)

Tutorial Format

Each tutorial includes:

  1. Overview - What you'll learn
  2. Prerequisites - What you need before starting
  3. Step-by-step instructions - Hands-on coding
  4. Code examples - Copy-paste ready snippets
  5. Exercises - Practice what you've learned
  6. Next steps - Where to go from here

Getting Help

If you get stuck: