groundskeeping

groundskeeping is a reusable Textual shell for operator tools that inspect, configure, and care for a working environment. It provides page and workbench contracts, safe actions and in-process jobs, setup wizards, oa-configurator inspection and write-flow mechanics, and normalized telemetry primitives.

Consuming applications own their production pages, domain services, safety policy, persistence, and environment-specific help. Groundskeeping owns the consistent interaction around them.

Groundskeeping demo layout

Start here

You want to…	Read…
Use an application built with Groundskeeping	Using a Groundskeeping app
Integrate Groundskeeping into an application	Developer quickstart
Add configuration inspection or a write flow	Configuration guide
Understand package boundaries	What belongs where
Browse public contracts	API reference

Install

Groundskeeping requires Python 3.12 or newer.

uv add groundskeeping

Run the self-contained demo:

uv run groundskeeping

The Configuration page uses a deterministic fake provider, so you can try branching, review, and apply behavior without writing a file.

Minimal composition

A Groundskeeping application starts with an OperatorAppSpec. The application wires its own services into its own page factories, then gives the resulting pages to the shell.

from groundskeeping.app import OperatorApp, OperatorAppSpec
from groundskeeping.contracts import PageRegistration, PageRoute

setup_route = PageRoute(
    key="setup",
    label="Setup",
    purpose="Check whether this environment is ready.",
)

spec = OperatorAppSpec(
    app_id="my-tool",
    title="My Tool",
    subtitle="environment setup",
    pages=(
        PageRegistration(
            route=setup_route,
            factory=lambda context: SetupPage(setup_service),
        ),
    ),
)

OperatorApp(spec).run()

SetupPage and setup_service stay in the consuming application. Groundskeeping supplies the frame around them.

Development

uv sync --all-extras --dev
uv run pytest -q
uv run ruff check .
uv run ty check src/

The full documentation is at AustralianCancerDataNetwork.github.io/groundskeeping.

Download files

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

Source Distribution

groundskeeping-0.4.0.tar.gz (187.6 kB view details)

Uploaded Aug 17, 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.

groundskeeping-0.4.0-py3-none-any.whl (64.6 kB view details)

Uploaded Aug 17, 2026 Python 3

File details

Details for the file groundskeeping-0.4.0.tar.gz.

File metadata

Download URL: groundskeeping-0.4.0.tar.gz
Upload date: Aug 17, 2026
Size: 187.6 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for groundskeeping-0.4.0.tar.gz
Algorithm	Hash digest
SHA256	`635d23afcf100a25f60cc6d0bc0fe8892cf955bbc3faa855df4cca675556d0c0`
MD5	`1168e1c5bbf415a7023e4dc6d3013088`
BLAKE2b-256	`9b80d9a2bc164e806862305ecb6cecf49f6e257f1830ec6024f792269fede17c`

See more details on using hashes here.

Provenance

The following attestation bundles were made for groundskeeping-0.4.0.tar.gz:

Publisher: publish.yml on AustralianCancerDataNetwork/groundskeeping

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: groundskeeping-0.4.0.tar.gz
- Subject digest: 635d23afcf100a25f60cc6d0bc0fe8892cf955bbc3faa855df4cca675556d0c0
- Sigstore transparency entry: 2499667764
- Sigstore integration time: Aug 17, 2026
Source repository:
- Permalink: AustralianCancerDataNetwork/groundskeeping@7036d936ba0f966b535c03fe3e57ebc0b6ce0b2c
- Branch / Tag: refs/tags/v0.4.0
- Owner: https://github.com/AustralianCancerDataNetwork
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: publish.yml@7036d936ba0f966b535c03fe3e57ebc0b6ce0b2c
- Trigger Event: push