.generation

geoengine-openapi-client - Code Generation

Auto-generated Python Client API for Geo Engine

Dependencies

• Python
• Podman

Requirements

• Postgres instance running on localhost:5432 with
  • geoengine:geoengine credentials and
  • geoengine database

Generation

From the root of the repository run:

.generation/generate.py python

Dev-Mode

To fetch the OpenAPI spec from the backend, run:

cargo run --features pro
wget http://localhost:3030/api/api-docs/openapi.json -O - \
    | python -m json.tool --indent 2 > .generation/input/openapi.json

To run the generation in dev mode, run:

.generation/generate.py --no-spec-fetch --no-container-build python

This will skip the running of the container and instead use the local files. It will also stop building the customized generator container.

Update config.ini

To update the config.ini file, run:

.generation/update_config.py --backendTag pro-nightly-2023-11-28

This will set a new backend tag and increment the version number.