Skip to main content

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)

Metadata

Release files for wmill 1.881.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.881.0
File Size Uploaded Provenance Actions
wmill-1.881.0.tar.gz 40.5 kB Without provenance Details for wmill-1.881.0.tar.gz

Built distribution (wheel)

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

Total release size: 81.3 kB

Release files / wmill-1.881.0.tar.gz

Download URL wmill-1.881.0.tar.gz
Size 40.5 kB
Tags Source
SHA-256 checksum
How to use checksums
92b179ba5caa1d24a28939b40fb0b3bbebea3a7584ff6082ebd3af871f9ac687
BLAKE2b-256 checksum
How to use checksums
85dfa683d420998536b19516f4e2f6998f304aabdfd4a0f5bca85a6f277ebf41
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.11.3 Linux/6.14.0-1018-aws

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

Download URL wmill-1.881.0-py3-none-any.whl
Size 40.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
86abe4541299994bb9c1d3ea26e2d8a4a36c665e26d0204cd8c96f6948d010ce
BLAKE2b-256 checksum
How to use checksums
d3c88d5f7bb6b3a52f8cbfad13915a3a96454ea5f06444e0c600522bb43d8c52
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/1.6.1 CPython/3.11.3 Linux/6.14.0-1018-aws

Security for wmill 1.881.0

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

1.881.0 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