xmas-core

Formerly xplan-tools: from 2.0 the distribution is xmas-core. The xplan_tools import and the xplan-tools CLI are unchanged for now.

Documentation | Repository

A Python library to provide some useful means when working with XPlanung, XTrasse and XWaermeplan data, e.g. format conversion, version migration and database setup. Relies on Pydantic for a Python representation of the XPlanung/XTrasse/XWaermeplan model as well as serialization/de-serialization and validation.

While it comes with a CLI, its modules are also meant to provide other applications a Python representation as well as an interface for XPlanung/XTrasse/XWaermeplan data.

Features

• Conversion between GML, JSON-FG and DB encodings of XPlanung/XTrasse/XWaermeplan data.
• Migration from older versions of XPlanung to the latest one.
• Set up a PostgreSQL/PostGIS database to store XPlanung data.
• Adding style properties (stylesheetId, schriftinhalt) to XPlanung presentational objects based on defined rules.
• Typed: the package ships a py.typed marker (PEP 561), so its annotations reach a type checker in your own code. The few members typed with lxml (e.g. GMLRepository.content) stay Any unless you install lxml-stubs.

Installation

Pixi

This project uses Pixi for package management. To install this repo with a self-contained environment, run

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

Python >= v3.10

GDAL and its Python bindings are required, so you need to make sure the GDAL system library and Python package versions match.

Download the repository:

git clone https://gitlab.opencode.de/xleitstelle/xmas-core.git
cd xmas-core
pip install .

Or install from PyPI:

pip install xmas-core

Docker

Images are provided in the container registry (see docs).

Development

Make sure Pixi is installed and run

git clone https://gitlab.opencode.de/xleitstelle/xmas-core.git
cd xmas-core
make dev

Developer Guides

For work on development, architecture, or internal workflows, refer to the Developer Guide Overview

License

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

© XLeitstelle, 2025