morphql · Python client

Python client for MorphQL — a declarative DSL for structural data transformation.

Delegates execution to the MorphQL CLI or a running MorphQL server. Zero external dependencies. Python >= 3.8.

Installation

pip install morphql

Quick start

from morphql import MorphQL

# One-shot static call (CLI provider)
result = MorphQL.execute(
    "from json to json transform set name = source.firstName",
    data={"firstName": "Alice"},
)
print(result)  # {"name":"Alice"}

# From a .morphql file
result = MorphQL.execute_file("transform.morphql", data={"x": 1})

# Instance with preset defaults (server provider)
morph = MorphQL(provider="server", server_url="http://localhost:3000")
result = morph.run("from json to json transform set x = source.x", data={"x": 42})
result = morph.run_file("transform.morphql", data={"x": 42})

Providers

Options

Priority: call kwarg > instance default > env var > hardcoded default.

API

Static

MorphQL.execute(query, data=None, **options) -> str
MorphQL.execute_file(query_file, data=None, **options) -> str

Instance

morph = MorphQL(**defaults)
morph.run(query, data=None, **options) -> str
morph.run_file(query_file, data=None, **options) -> str

data accepts str (JSON), dict, list, or None.

Exceptions

Running tests

cd packages/python
PYTHONPATH=src python -m unittest discover tests/
# or with pytest:
pip install pytest
pytest

License

MIT