LDaCA Wordflow Backend

FastAPI service for LDaCA Wordflow. The package can run the API by itself or serve the bundled production frontend from the same process.

The authoritative source, issue tracker, CI, and package release workflow live in the LDaCA Wordflow monorepo.

Quick start

# Install and run (backend + frontend on one port)
uvx ldaca-wordflow

# Or run only the backend API
uvx ldaca-wordflow --backend

# Custom port
uvx ldaca-wordflow --port 9000

Notebook and BinderHub launch

Use the asynchronous launcher when Python must retain control of the event loop, such as a BinderHub notebook cell:

import os

from IPython.display import Markdown, display
from ldaca_wordflow import start_async_server

server = await start_async_server(port=8001)
proxy_path = (
    f"{os.environ['JUPYTERHUB_SERVICE_PREFIX'].rstrip('/')}"
    f"/proxy/{server.settings.backend_port}/"
)
display(Markdown(f"[Open Wordflow]({proxy_path})"))

start_async_server() returns only after ASGI lifespan startup succeeds. Its caller-owned handle supports waiting and bounded graceful shutdown. Under JupyterHub, the launcher derives the proxy root_path from JUPYTERHUB_SERVICE_PREFIX. Install ldaca-wordflow[deploy] in the Binder environment so jupyter-server-proxy is available to the Jupyter server. Do not run this cell while a CLI-launched instance already owns the same port.

When finished, stop the caller-owned server from another cell:

await server.close()

See the BinderHub runbook for image setup, terminal launch alternatives, proxy behavior, and storage expectations.

Development

Backend architecture: ../docs/architecture/backend/overview.md
HTTP endpoint inventory: ../docs/reference/backend-api.md
Settings reference: ../docs/reference/backend-settings.md
Lint: uv run ruff check .
Type check: uv run ty check
Tests: uv run pytest -q
OpenAPI export: uv run python scripts/export_openapi.py --output <path>

Download files

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

Source Distribution

ldaca_wordflow-0.7.2.tar.gz (6.6 MB view details)

Uploaded Aug 19, 2026 Source

Built Distribution

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

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

ldaca_wordflow-0.7.2-py3-none-any.whl (6.8 MB view details)

Uploaded Aug 19, 2026 Python 3

File details

Details for the file ldaca_wordflow-0.7.2.tar.gz.

File metadata

Download URL: ldaca_wordflow-0.7.2.tar.gz
Upload date: Aug 19, 2026
Size: 6.6 MB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for ldaca_wordflow-0.7.2.tar.gz
Algorithm	Hash digest
SHA256	`660994561608ed4b6de7e29f459d22f865bd559c9ff5effaf7805684b6c01ac6`
MD5	`f05f94b20fe4756a441471e2745f921a`
BLAKE2b-256	`efb103ab534a50bc4fef7f15c412dd5fb4b2681fb3cbb978d196411c95d9f817`

See more details on using hashes here.

Provenance

The following attestation bundles were made for ldaca_wordflow-0.7.2.tar.gz:

Publisher: release.yml on Australian-Text-Analytics-Platform/ldaca-wordflow

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: ldaca_wordflow-0.7.2.tar.gz
- Subject digest: 660994561608ed4b6de7e29f459d22f865bd559c9ff5effaf7805684b6c01ac6
- Sigstore transparency entry: 2514697917
- Sigstore integration time: Aug 19, 2026
Source repository:
- Permalink: Australian-Text-Analytics-Platform/ldaca-wordflow@8c7667edb292f1faf686ac34f57d292535b0d823
- Branch / Tag: refs/tags/v0.7.2
- Owner: https://github.com/Australian-Text-Analytics-Platform
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release.yml@8c7667edb292f1faf686ac34f57d292535b0d823
- Trigger Event: push