XMAS-Core

Documentation | Repository

Model, encode, migrate and store XPlanung, XTrasse and XWärmeplan data. XMAS-Core represents the application schemas as Pydantic models and is meant as a library for other applications to build on; the xmas CLI exposes the same operations on the command line.

Supported appschemas:

• XPlanung 4.1, 5.4, 6.0, 6.1
• XTrasse 2.0, 2.1
• XWärmeplan 0.9

The UML model of each appschema is the single source of truth. Every schema version is generated from it into a Pydantic module that also records each class's and property's UML metadata: stereotype, type name, unit of measure and association ends. Everything else is driven by that metadata, not by per-class code. The GML and JSON-FG codecs encode and decode any class generically. The database stores every schema in one generic table, and the navigable roles it follows are derived from the associations. Migration and style rules are checked against the schemas when they load. A new schema version starts as generated code, not hand-written classes.

Features

• Reading and writing GML and JSON-FG, from files, stdin, URLs or a WFS.
• Storing plans in PostgreSQL/PostGIS, with Alembic-managed schemas and several tenant schemas served from one process.
• Migrating XPlanung documents to a later version, several hops in one call, with a per-feature report of what could not be carried over.
• Adding style properties (stylesheetId, schriftinhalt) to XPlanung presentational objects based on defined rules.

Installation

From PyPI (Python 3.14):

pip install xmas-core

GDAL and its Python bindings are required; the GDAL system library and Python package versions must match.

With Pixi, which brings GDAL along:

git clone https://gitlab.opencode.de/xleitstelle/xmas-core.git
cd xmas-core
pixi install -e prod

As a container: images are in the container registry (see usage).

Quickstart

xmas convert input.gml output.json                        # GML -> JSON-FG
xmas convert xplan41.gml xplan61.gml --to 6.1 --report issues.json
xmas db create-schema postgresql://user@host/db
xmas convert input.gml postgresql://user@host/db          # GML -> PostGIS

From Python:

from xmas_core import codec
from xmas_core.processing.transform import migrate

collection = codec.read("xplan41.gml")
result = migrate(collection, "6.1")

More in the how-to guides.

Development

With Pixi installed:

git clone https://gitlab.opencode.de/xleitstelle/xmas-core.git
cd xmas-core
pixi run dev                              # environment + pre-commit hooks
pixi run test                             # full suite with coverage
pixi run test tests/path.py::test_name    # one test
pixi run test -m db                       # by marker (see pyproject.toml)
pixi run docs-serve                       # documentation preview

DB tests start their own PostGIS container (podman or Docker).

The design is documented in the module docstrings; for architecture and workflows see the Developer Guide.

License

The code in this repository is licensed under the EUPL-1.2+

© XLeitstelle, 2025-2026