xmas-app 0.9.0

The XLeitstelle model-driven application schema app.

XMAS-App

The XLeistelle model-driven application schema app is a Python web application to edit and create data according to geo-spatial standards of the XLeistelle, e.g. XPlanung, XTrasse. It is based on NiceGUI for a graphical user interface and XPlan-Tools for the data model and respective functionality.

While it could be advanced to a standalone application, its current focus is integration in QGIS to provide attribute forms etc.

Features

• Render attribute forms for features.
• Create and edit features in combination with the corresponding QGIS Plugin.
• Import GML documents into a database.
• Export GML, JSON-FG or GPKG files from a databse.
• Delete plans from a database.
• Display and edit relations of plan objects in a tree view.

Installation

Container Image

Container images are available in the registry. See here for configuration.

Python >= v3.11

GDAL and its Python bindings are required, so you need to make sure the GDAL system library and Python package versions match. QGIS installations come with GDAL and a Python environment that can readily be used to install the app.

Install with pip, e.g. via OSGeo4W Shell:

pip install xmas-app

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-app.git
cd xmas-app
pixi install

Running

Preconditions

A Postgres DB with PostGIS extension and adequate permissions for the used role. If no database schema was previously created with xplan-tools, it will be generated on initialization.

For convenience, you can run

docker compose -f compose.yaml up -d

This will spin up a readily usable XMAS-App container with a PostGIS backend.

Modes

QGIS Plugin mode

If XPlan-GUI was installed in the QGIS Python environment, it can be started from the plugin panel. Configuration parameters are handled by the plugin.

Standalone mode

Starting in standalone mode requires some configuration parameters which have to be provided as an .env file or via environment variables. The database connection parameters can be either user name, password etc. or a service definition.

Variable	Description	Required	Example
PGDATABASE	name of the database	(x)	coretable
PGHOST	host of the database	(x)	localhost
PGPORT	port of the database	(x)	55432
PGUSER	user of the database	(x)	foo
PGPASSWORD	password of the database user	(x)	bar
PGSERVICE	the databas service to use	(x)	coretable
APP_PORT	the port on which the app should run	x	1337
APPSCHEMA	the default appschema	x	xplan
APPSCHEMA_VERSION	the default appschema's version	x	6.0

First activate the pixi shell

pixi shell

then run

xplan-gui

Optional: batch import test data to the database using xplan-tools

Test data can be downloaded from https://gitlab.opencode.de/xleitstelle/xplanung/testdaten, e.g. a ZIP archive with BP_Plans in v 6.0.

To import all .gml files at once, extract the archive and use:

(on Linux/Mac/Wsl Bash):

for f in <pfad>/bp/*.gml; do
  xplan-tools convert "$f" postgresql://postgres:postgres@localhost:5432/postgres
done

(on Windows:):

for %f in (*.gml) do xplan-tools convert "%f" postgresql://postgres:postgres@127.0.0.1:55432/postgres
cd ```

### Notes

We set PGGSSENCMODE=disable and PGSSLMODE=disable at runtime to avoid Windows security and file locking issues in local development.
This does not affect production deployments, which can use secure defaults.