Skip to main content

Manage XPlanung data

Project description

XPlan-Tools

coverage report pipeline status Latest Release

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 database to store XPlanung data. Supports PostgreSQL/PostGIS as well as GeoPackage and SpatiaLite SQLite databases.
  • Transformation from XPlanung to INSPIRE PLU based on the official mappings.
  • Adding style properties (stylesheetId, schriftinhalt) to XPlanung presentational objects based on defined rules.

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/xplanung/xplan-tools.git
cd xplan-tools
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/xplanung/xplan-tools.git
cd xplan-tools
pip install .

Or install from PyPI:

pip install xplan-tools

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/xplanung/xplan-tools.git
cd xplan-tools
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

Project details


Download files

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

Source Distribution

xplan_tools-1.21.1.tar.gz (817.1 kB view details)

Uploaded Source

Built Distribution

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

xplan_tools-1.21.1-py3-none-any.whl (848.3 kB view details)

Uploaded Python 3

File details

Details for the file xplan_tools-1.21.1.tar.gz.

File metadata

  • Download URL: xplan_tools-1.21.1.tar.gz
  • Upload date:
  • Size: 817.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.13 Linux/5.4.0-205-generic

File hashes

Hashes for xplan_tools-1.21.1.tar.gz
Algorithm Hash digest
SHA256 0f67b079303c9e13a21efd60ef9df676ed2af095582373682a486428a17297ea
MD5 62311ea01f36b5deb7b6e2fecab1e10f
BLAKE2b-256 d562e45ede31f256b0c59648ea42ea8d5b11c0d687992a8d10353ac383c0b458

See more details on using hashes here.

File details

Details for the file xplan_tools-1.21.1-py3-none-any.whl.

File metadata

  • Download URL: xplan_tools-1.21.1-py3-none-any.whl
  • Upload date:
  • Size: 848.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.4.1 CPython/3.13.13 Linux/5.4.0-205-generic

File hashes

Hashes for xplan_tools-1.21.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4cedb51508790ed6378bdd77533c660476c0b29472e5c215f0ace1ca867b8dea
MD5 00c3285242bc5c6cefc47f0039ddccb8
BLAKE2b-256 1c433c895da9f6e59a6b3775e947f560f41596a91b6d50fbab010625f6f3a866

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page