Python Client

A single-file Python module that implements the full WaterlyConnect payload model using only the standard library. No pip install required — copy the file alongside your script, import it, and you're submitting. Ideal for utility scripts, cron jobs, and lightweight adapter services.

Open API Reference Download Module

3.12+Python version

0External dependencies

.pySingle file artifact

Prerequisites

Python 3.12 or newer in the environment running the script.
A Waterly-provided submission URL, client token, and device identity (id and type).
The waterlyconnect_client.py module accessible to your script — either copied locally or added to PYTHONPATH.
Outbound HTTPS access to the WaterlyConnect endpoint.

Quick Start

1
Download the module. Place waterlyconnect_client.py in the same directory as your script or somewhere on PYTHONPATH.
2
Create the config. Provide your submission URL, client token, and a ClientDeviceInfo object with id and type.
3
Build tags and submit. Create a list of TagDatum objects and call client.submit_data(tags).

Submission Example

import time

from waterlyconnect_client import (
    ClientDeviceInfo,
    TagDatum,
    WaterlyConnectApiClient,
    WaterlyConnectApiClientConfig,
)

config = WaterlyConnectApiClientConfig(
    url="https://app.waterlyapp.com/connect/submit",
    client_token="your-client-token",
    client_device=ClientDeviceInfo(
        id="lift-station-04",
        type="Python Adapter",
    ),
)

client = WaterlyConnectApiClient(config)

tags = [
    TagDatum(
        name="WetWellLevel",
        value=12.7,
        last_change_timestamp=int(time.time()),
        unit="FT",
    ),
    TagDatum(
        name="PumpStatus",
        value=1.0,
        last_change_timestamp=int(time.time()),
    ),
]

client.submit_data(tags)

Files

Module download

The complete single-file client ready to copy into your project.

Download .py

Package README

Detailed usage, class reference, and configuration notes.

Open README

Source folder

Full source path in the waterlyconnect-docs repository.

View on GitHub ↗