Skip to main content

synapse-controller

A Python CLI + backend that drives Azure Synapse Analytics from a single config.yaml. Wraps azure-synapse-artifacts to start, monitor, list, and cancel pipeline runs, and to run / debug notebooks against a Spark session.

See ARCHITECTURE.md for the architectural source of truth: stack, layout, config shape, CLI behavior, and project conventions.

Quickstart

uv sync --extra dev
uv run python -m synapse_controller --help

Copy config.example.yaml to config.yaml, fill in your workspace identity, then:

uv run python -m synapse_controller --config config.yaml --profile dev pipelines list

Note — invoke as python -m synapse_controller, not as a script entry point. Defender on Belastingdienst-managed Windows blocks executing binaries from .venv\Scripts\, so all tools (black, isort, flake8, mypy, pytest, this CLI) are launched via python -m.

Notebook output streaming caveatnotebooks run and notebooks debug execute a workspace notebook by submitting each code cell to a Livy Spark session. Synapse's Livy returns a cell's captured output only when the cell finishes, so per-line stdout during a long-running cell is not available. Feedback granularity is one cell.

Development

uv run python -m black .
uv run python -m isort .
uv run python -m flake8 src tests
uv run python -m mypy src tests
uv run python -m pytest

Authentication is always DefaultAzureCredential. Make sure you are signed in (e.g. az login) before running commands that touch the workspace.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

synapse_controller-0.1.1.tar.gz (29.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

synapse_controller-0.1.1-py3-none-any.whl (38.9 kB view details)

Uploaded Python 3

File details

Details for the file synapse_controller-0.1.1.tar.gz.

File metadata

  • Download URL: synapse_controller-0.1.1.tar.gz
  • Upload date:
  • Size: 29.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for synapse_controller-0.1.1.tar.gz
Algorithm Hash digest
SHA256 69edd39b6e0100e2fbb3b6de7f923f8ad597e40f1d03ee95e4e079150533a5e7
MD5 89be1592cd17a7e8388c9b77df71eb28
BLAKE2b-256 f395afb42ff51e1c2f2e40c4582770bde859a5bbc6a810d601d4069a0487a141

See more details on using hashes here.

Provenance

The following attestation bundles were made for synapse_controller-0.1.1.tar.gz:

Publisher: publish.yml on TheScriptingGuy/synapse-controller

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file synapse_controller-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for synapse_controller-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 ae500fbd6617a35255fac675974dda4febc84e7a14c5ce0dc1f5768779c62665
MD5 a3260c520c00a7feca35406d38ec984a
BLAKE2b-256 dd01cb8ef9d264f98c3e5b261be0fc24eb656a41a6bfe50dc049fa8d3b5e6124

See more details on using hashes here.

Provenance

The following attestation bundles were made for synapse_controller-0.1.1-py3-none-any.whl:

Publisher: publish.yml on TheScriptingGuy/synapse-controller

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

This release

0.1.1 This release

2 files

0.1.0

2 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