Skip to main content

alteryx2fabric

Release PyPI Release workflow License: MIT Python 3.10+

A toolkit for migrating Alteryx workflows (.yxmd) to Microsoft Fabric (Lakehouse + Notebooks + Data Pipelines), with a medallion (Bronze / Silver / Gold) architecture.

How it works

flowchart TD
    subgraph IN["Inputs"]
        direction LR
        YXMD["Alteryx .yxmd"]
        DATA["Source files<br/>CSV / Excel"]
        REF["Alteryx reference<br/>outputs"]
    end

    subgraph LOCAL["Local · deterministic a2f CLI"]
        direction TB
        PARSE["parse → ir.json"]
        PLAN["plan → risk + confidence"]
        GATE{"Manual or<br/>high-risk?"}
        APPROVE["Engineer approval"]
        GEN["generate<br/>Bronze · Silver · Gold"]
        VALID["validate bodies<br/>syntax · placeholders"]
    end

    subgraph FAB["Microsoft Fabric · after approval"]
        direction TB
        PRE["preflight<br/>auth · workspace · lakehouse"]
        DEPLOY["deploy notebooks<br/>+ Data Pipeline"]
        RUN["run pipeline<br/>Bronze → Silver → Gold"]
        OUT[("OneLake<br/>Files/Output")]
    end

    subgraph CHECK["Parity"]
        direction TB
        CMP{"Match Alteryx<br/>outputs?"}
        DONE(["Migration complete"])
        FIX["diagnose + fix"]
    end

    COPILOT["Optional: Copilot agent<br/>skill + Fabric Spark skills"]

    YXMD --> PARSE --> PLAN --> GATE
    GATE -->|no| GEN
    GATE -->|yes| APPROVE --> GEN
    DATA --> GEN --> VALID --> PRE
    PRE --> DEPLOY --> RUN --> OUT --> CMP
    REF --> CMP
    CMP -->|yes| DONE
    CMP -->|no| FIX -->|regenerate| GEN

    COPILOT -. assists .-> GEN
    COPILOT -. diagnoses .-> FIX
    VALID -. "resume state · .a2f/migration.json" .-> PARSE

    classDef in fill:#eef2f7,stroke:#5b6b7f,color:#1b2733;
    classDef local fill:#e6f2ff,stroke:#1f77c0,color:#0f2a43;
    classDef fabric fill:#e7f6ec,stroke:#25873a,color:#123420;
    classDef gate fill:#fff3d4,stroke:#b7791f,color:#4a2c0a;
    classDef done fill:#d7f5e6,stroke:#12855a,color:#0e3a2b;
    classDef repair fill:#ffe7e4,stroke:#c0443a,color:#48150f;

    class YXMD,DATA,REF in;
    class PARSE,PLAN,GEN,VALID,APPROVE local;
    class PRE,DEPLOY,RUN,OUT fabric;
    class GATE,CMP gate;
    class DONE done;
    class FIX,COPILOT repair;

The CLI owns deterministic and auditable operations. Copilot is optional: it reads the same plan and migration state, applies the repository skill when judgment is required, and delegates Fabric notebook authoring or failed-run diagnosis to the matching Fabric skills. Every guided migration is resumable because completed stages and the source workflow fingerprint are persisted in .a2f/migration.json.

The toolkit has two complementary halves:

Half Purpose Where it lives
CLI (a2f) Deterministic planning, preflight, packaging, deployment, execution, and validation. src/alteryx2fabric/
Copilot plugin Agent orchestration plus semantic YXMD/formula guidance and Fabric-skill delegation. .github/ and skill/

Use the CLI for everything that should be automated. Use the Skill (via a Copilot-aware editor) for the parts that need judgment — interpreting custom formulas, mapping macros, deciding when to use a Notebook vs. a Dataflow Gen2.

Install

From PyPI (recommended):

pip install alteryx2fabric

From a GitHub Release wheel:

pip install https://github.com/navintkr/alteryx-fabric-migrator/releases/download/v0.2.1/alteryx2fabric-0.2.1-py3-none-any.whl

From source (editable, for development):

git clone https://github.com/navintkr/alteryx-fabric-migrator.git
cd alteryx-fabric-migrator
pipx install --editable .

Verify:

a2f --help

Quick start

One command, workflow to running Fabric pipeline:

az login --tenant <your-tenant-id>

# Parse -> plan -> generate -> preflight -> provision -> upload -> deploy -> run -> validate.
# --ship implies --to-fabric --run-pipeline --yes; --workspace-id bootstraps state (no `a2f init`).
a2f migrate path/to/workflow.yxmd --workspace-id <fabric-ws-guid> --inputs ./inputs \
    --reference ./reference_outputs --outputs ./fabric_outputs --ship

Step-by-step (review before deploying):

# 1. Install (see Install section above) and authenticate
az login --tenant <your-tenant-id>

# 2. Initialise a migration project
a2f init my-migration --workspace-id <fabric-ws-guid>
cd my-migration

# 3. Plan, generate, and validate local artifacts (resumable)
a2f migrate path/to/workflow.yxmd --inputs ./inputs

# 4. Review .a2f/migration-plan.md, then deploy with explicit approval
a2f migrate path/to/workflow.yxmd --inputs ./inputs --to-fabric --yes --run-pipeline \
    --reference ./reference_outputs --outputs ./fabric_outputs

# 5. Download and validate against Alteryx reference outputs
a2f download Files/Output --out ./fabric_outputs
a2f validate --ref ./reference_outputs --gen ./fabric_outputs

Tip: Just want to scope a migration without any Azure setup? Skip straight to Portfolio analysis — it runs entirely offline on a folder of .yxmd files.

AI-assisted generation

The CLI can call a frontier model (Claude Opus 4-class or your choice) to draft notebook bodies from the parsed IR. Auth via GitHub Models (uses GITHUB_TOKEN or gh auth token) or Anthropic API directly (ANTHROPIC_API_KEY).

# Generate all three notebook bodies from ir.json
a2f generate all --inputs ./inputs --out-dir notebooks

# Override provider / model
a2f generate --provider anthropic --model claude-opus-4-20250514 silver

# Explain one Alteryx tool
a2f explain 37

# Patch a notebook from a validate diff report
a2f validate --ref ref --gen gen > diff.txt
a2f fix --notebook notebooks/nb_silver.py --diff diff.txt

The system prompt embeds the skill's hard rules (Delta column mapping, year-9999, NULL arithmetic, etc.) so generated code follows them by default.

GitHub Models is the CLI's embedded inference provider. GitHub Copilot CLI is an optional orchestration layer supplied through the repository plugin; a2f does not launch Copilot as a subprocess.

Planning, preflight, and notebook packaging

a2f plan path/to/workflow.yxmd
a2f doctor --offline --json-output
a2f doctor --json-output
a2f package-notebooks

a2f plan classifies every tool as native, partial, manual, or unknown and emits confidence, risks, proposed artifacts, and a review recommendation. a2f deploy fails closed unless all three generated notebook bodies are present, syntactically valid, and free of scaffold placeholders.

The guided a2f migrate command records each stage in .a2f/migration.json. Rerunning resumes completed work; use --restart to invalidate all stages. --workspace-id bootstraps project state and folders so no separate a2f init is required, and --ship is a one-shot shorthand for --to-fabric --run-pipeline --yes. Fabric writes always require explicit approval (--to-fabric --yes, or --ship). With --run-pipeline, it downloads Files/Output and validates parity automatically when reference outputs are available.

Copilot plugin

The workspace includes:

  • .github/plugin/plugin.json for Copilot CLI plugin packaging.
  • .github/agents/Alteryx2Fabric.agent.md for the end-to-end migration agent.
  • .github/prompts/migrate-alteryx.prompt.md for an on-demand VS Code workflow.
  • .github/skills/alteryx2fabric/SKILL.md as the standard discovery entry point.

The agent delegates current notebook conventions and failure diagnosis to the installed Fabric spark-authoring-cli, spark-operations-cli, and medallion architecture skills. It does not require or invoke Foundry MCP.

Portfolio analysis (batch)

Have a folder of dozens or hundreds of .yxmd files and need to scope the migration? Use a2f analyze:

a2f analyze C:\path\to\workflows --out .\analysis

Outputs in ./analysis/:

File Contents
workflow_report.csv Tool counts, support coverage, confidence, risks, effort days, and recommended migration wave
workflow_dependencies.csv Edges upstream → downstream whenever an output file of one workflow is consumed as an input by another
workflow_duplicates.csv Exact (identical structure hash) and near-duplicate (Jaccard ≥ threshold) clusters — candidates for consolidation
workflow_analysis.xlsx All three sheets in one Excel workbook
workflow_dependencies.mmd Mermaid diagram of the dependency graph
portfolio_summary.json Aggregate workflow/tool counts, engineering days, confidence, risk, duplicates, dependencies, and capacity-assessment flag

Tune near-duplicate sensitivity with --near-threshold 0.85 (default 0.9).

Workflow parameterization

Alteryx workflows often expose runtime knobs through user constants, question constants (%Question.X%), or interface tools (TextBox, Date, DropDown, NumericUpDown, etc.). The toolkit detects these automatically and surfaces them in three places:

  1. a2f parse — the IR (ir.json) now includes a parameters array.
  2. a2f analyze — adds a parameter_count / parameters column to the workflow report and a dedicated workflow_parameters.csv (and Excel sheet) listing every parameter across the portfolio.
  3. a2f deploy — automatically creates matching Fabric Data Pipeline parameters (with type and default) and wires each notebook activity to receive them via @pipeline().parameters.<Name>.

At run time, override any parameter with --param:

a2f run --param RegionCode=EU --param AsOfDate=2024-12-31 --param BatchSize=1000

Skip parameterization for a workflow with a2f deploy --no-parameters.

What the toolkit does NOT do

  • It does not silently approve every Alteryx mapping. Macros, spatial/predictive tools, custom tools, and uncertain formulas are surfaced as review gates.
  • It does not provision capacities or workspaces. Use az / Fabric portal for those.
  • It does not generate Dataflow Gen2 mashup PQ. Bronze ingestion currently uses notebooks; DFG2 emission is on the roadmap.

Architecture

YXMD → parse → deterministic plan → notebook generation → local preflight
                                                        ↓
Alteryx references ← parity validation ← Fabric run ← approved deployment

Copilot plugin: optional planning/review/orchestration layer around the same CLI

Known gotchas baked in

These come from real engagements and are encoded in both the CLI defaults and the skill instructions:

  • Delta column mapping (name mode, reader v2 / writer v5) — required for Alteryx-style column names with spaces or special characters.
  • timestampNtz Delta feature — avoid by serialising datetimes as strings before writing.
  • Year-9999 sentinel dates — pandas datetime64[ns] overflows; use Python datetime objects or datetime64[us].
  • NULL arithmetic — Alteryx propagates NULLs through sums. Use skipna=False in pandas.
  • Join key normalisation — Alteryx treats NaN / "" / " " as equal in joins. Strip + fill before merging.

See skill/instructions/known-gotchas.md for the full catalogue.

Repo layout

alteryx2fabric/
├── src/alteryx2fabric/        # CLI package
├── skill/                     # Agent skill (SKILL.md + instructions)
├── examples/sales-rollup-demo/ # Synthetic example workflow
├── docs/                      # Quickstart + architecture notes
├── tests/                     # Unit tests
└── pyproject.toml

License

MIT. See LICENSE.

Metadata

Release files for alteryx2fabric 0.2.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for alteryx2fabric 0.2.1
File Size Uploaded
alteryx2fabric-0.2.1.tar.gz 53.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for alteryx2fabric 0.2.1
File Interpreter ABI Platform
alteryx2fabric-0.2.1-py3-none-any.whl Python 3 none any Details

Total release size: 101.9 kB

Release files / alteryx2fabric-0.2.1.tar.gz

Download URL alteryx2fabric-0.2.1.tar.gz
Size 53.0 kB
Tags Source
SHA-256 checksum
How to use checksums
c086dbdc912bc1113107c96f151affd236234ad2a5eff918e4abe1af37f0baa1
BLAKE2b-256 checksum
How to use checksums
e44bd643bddc55ab209728dbdc402b88102e901f7698f1df602a49d3b2d166c7
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 11, 2026.

Transparency log

Release files / alteryx2fabric-0.2.1-py3-none-any.whl

Download URL alteryx2fabric-0.2.1-py3-none-any.whl
Size 48.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e307c7a13120afbf809e43ed0df4261f9ba835b0fd779df815480f49335b3bd3
BLAKE2b-256 checksum
How to use checksums
7f3508ea13587e83d4a7b9a1b9b6cd87533869a1cbdc21e22a87834ab4fbd072
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Aug 11, 2026.

Transparency log

Release history Release notifications | RSS feed

This release

0.2.1 This release

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page