wmill

The core client for the Windmill platform.

Usage

Basic Usage

The wmill package has several methods at the top-level for the most frequent operations you will need.

The following are some common examples:

import time

import wmill


def main():
    # Get the value of a variable
    wmill.get_variable("u/user/variable_path")
    
    # Run a script synchronously and get the result
    wmill.run_script("f/pathto/script", args={"arg1": "value1"})
    
    # Get the value of a resource
    wmill.get_resource("u/user/resource_path")
    
    # Set the script's state
    wmill.set_state({"ts": time.time()})
    
    # Get the script's state
    wmill.get_state()

Advanced Usage

The wmill package also exposes the Windmill class, which is the core client for the Windmill platform.

import time

from wmill import Windmill

def main():
    client = Windmill(
        # token=...  <- this is optional. otherwise the client will look for the WM_TOKEN env var
    )

    # Get the current version of the client
    client.version

    # Get the current user
    client.user
    
    # Convenience get and post methods exist for https://app.windmill.dev/openapi.html#/
    # these are thin wrappers around the httpx library's get and post methods
    # list worker groups
    client.get("/configs/list_worker_groups")
    # create a group
    client.post(
        f"/w/{client.workspace}/groups/create",
        json={
            "name": "my-group",
            "summary": "my group summary",
        }
    )
    
    # Get and set the state of the script
    now = time.time()
    client.state = {"ts": now}
    assert client.state == {"ts": now}
    
    # Run a job asynchronously
    job_id = client.run_script_async(path="path/to/script")
    # Get its status
    client.get_job_status(job_id)
    # Get its result
    client.get_result(job_id)

Release files for wmill 1.813.0

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

Source distribution (sdist)

Source distribution for wmill 1.813.0
File	Size	Uploaded
wmill-1.813.0.tar.gz	35.4 kB	Sep 16, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for wmill 1.813.0
File	Interpreter	ABI	Platform	Reset
wmill-1.813.0-py3-none-any.whl 35.8 kB Sep 16, 2026	Python 3	none	any	Details

Total release size: 71.2 kB

Release files / wmill-1.813.0.tar.gz

Download URL	wmill-1.813.0.tar.gz
Size	35.4 kB
Tags	Source
SHA-256 checksum How to use checksums	`b725a8cb679722115e7fa37fc8d23461799139b5f03c3d5cd676e26c4ee04e3f`
BLAKE2b-256 checksum How to use checksums	`b0bfcca6c4669bdd7c02ae427424075a104bcff6d0348449467e973933db76e2`
Upload date	Sep 16, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.6.1 CPython/3.11.3 Linux/6.14.0-1017-azure`

Release files / wmill-1.813.0-py3-none-any.whl

Download URL	wmill-1.813.0-py3-none-any.whl
Size	35.8 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`b0ba88659f92bbfb2001b3f1d44abd90e975acae91346967983f81f6d7299db3`
BLAKE2b-256 checksum How to use checksums	`a996c1b28b14e2148b65b3c7692d5410c8115273ce1c9251ccf88b71aff33cf5`
Upload date	Sep 16, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.6.1 CPython/3.11.3 Linux/6.14.0-1017-azure`