Skip to main content

Kawa Python Server

It is the python runtime for the Kawa platform. Please refer to this documentation to register python runtime in the Kawa platform: Register python runtimes.

Configure the server

Create a .env file in the root of the venv. It must contain the following environment variables:

# This is the secret for this server.
# It will need to be set on KAWA platform too 
# to communicate with this server.
# You can generate it like that: head /dev/urandom | sha256sum | cut -d ' ' -f 1
# (REQUIRED)
KAWA_AUTOMATION_SERVER_AES_KEY=8c180b7df391a24fcdf5504fadbd37f2df79ead5c4b36987acb683bd8e8bc465

# This defines the URL of the KAWA platform this python server will be paired with
# (OPTIONAL) Defaults to http://localhost:8080
KAWA_URL=http://localhost:8080

# This will define on which host/port the python server will listen
# (OPTIONAL) Defaults to 0.0.0.0, port 8815
# KAWA_AUTOMATION_SERVER_HOST=0.0.0.0
# KAWA_AUTOMATION_SERVER_PORT=8815

# This will override the path to the pex executable.
# pex is used by the script runner to package dependencies
# https://docs.pex-tool.org/
# (OPTIONAL) Defaults to pex
# KAWA_AUTOMATION_PEX_EXECUTABLE_PATH=pex

# Defines the working dir of the python server
# It will store pex files and sync files
# (OPTIONAL) Defaults to /tmp
# KAWA_AUTOMATION_SERVER_WORKING_DIRECTORY=/tmp

# If set to true, PEX will use pip config.
# This is important if some specific configuration is required (such as a private package registry etc)
# (OPTIONAL) Defaults to false
# KW_PEX_USE_PIP_CONFIG=false

Starting the server

Just run kawapythonserver

Health

The server answers two Flight actions.

  • health proves that the server answers: {"status": "OK", "version": "…"}. The KAWA server calls it before each script run.
  • health_report tells whether the server can run a script right now. The KAWA server shows the result in the pythonRunner field of its /health page.

health_report answers a status, OK or KO, and one line per check: OK, or a sentence that says what is wrong.

Check It fails when
kawaServer the KAWA server has not been reached for 30 seconds: wrong KAWA_URL, wrong key, network. Scripts stay pending.
pollingThread the thread that picks up jobs is dead.
workers none of the threads that run jobs is alive.
workingDirectory a small file cannot be written in the working directory: missing, read-only, disk full.
pex the pex executable is not found.
scriptRunner the script_runner.py file is not found.

It also gives, for information: the versions (server, kywy, Python), the URL of the KAWA server, the number of worker threads alive, and the free space of the working directory's disk.

No script is run and the KAWA server is not called: the polling thread already asks it every second.

Version

The Flight action version tells what the server was built from. The KAWA server and the workflow engine answer the same five fields on their GET /version.

{
  "component": "kawa-python-runner",
  "version": "0.37.11",
  "commitHash": "520bc14",
  "buildDate": "2026-11-11 22:21:40",
  "pipelineId": "2145778812"
}

version is the package version, from pyproject.toml. The commit, the date (UTC) and the GitLab CI pipeline are stamped into the package when it is built: python stamp_build_info.py writes src/kawapythonserver/_build_info.py, which git ignores and the package carries. The CI runs it before python -m build, and so does build_and_publish.sh.

A checkout that was never built says dev for these three. A build outside the CI says dev for the pipeline.

Metadata

Release files for kawapythonserver 0.37.11

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for kawapythonserver 0.37.11
File Size Uploaded Provenance Actions
kawapythonserver-0.37.11.tar.gz 50.1 kB Without provenance Details for kawapythonserver-0.37.11.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for kawapythonserver 0.37.11
File Interpreter ABI Platform Actions
kawapythonserver-0.37.11-py3-none-any.whl Python 3 none any Details for kawapythonserver-0.37.11-py3-none-any.whl

Total release size: 116.2 kB

Release files / kawapythonserver-0.37.11.tar.gz

Download URL kawapythonserver-0.37.11.tar.gz
Size 50.1 kB
Tags Source
SHA-256 checksum
How to use checksums
779c2e842d761ce6a3635da888f9f485491634d225c47a3b629abb111ddfb821
BLAKE2b-256 checksum
How to use checksums
95f6f3aef248e5662049d0107cbe5691b83452dcd2e875fa3d577c5df2dc94fc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.0

Release files / kawapythonserver-0.37.11-py3-none-any.whl

Download URL kawapythonserver-0.37.11-py3-none-any.whl
Size 66.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
a59a99fc6db7c0e6458b623768bbdbdd72a49c8c8b675a0ae92d79d2fe5cf89c
BLAKE2b-256 checksum
How to use checksums
ddb876dea5acac9e630eb67a2e8fe2c68664b1494a99881baf2537aeeaa7067a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.12.0

Security for kawapythonserver 0.37.11

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.37.11 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page