PyFlume

What it is and what it does

PyFlume is a Python client library for the Flume water sensor API. It wraps Flume's REST endpoints to let developers programmatically fetch device information, retrieve water usage data, manage notifications and alerts, and detect leaks. The package handles authentication via JWT tokens and provides modules for each major Flume resource type—devices, data, notifications, usage alerts, and leak alerts.

The library depends on requests for HTTP calls, pyjwt for token handling, ratelimit for API throttling, and backports.zoneinfo for timezone support. It is designed for integration into home automation, water conservation monitoring, or IoT dashboards that need to pull Flume sensor readings and alerts programmatically.

Use it for:

• Fetch real-time or historical water usage data from Flume devices for consumption dashboards.
• Retrieve and process leak alerts and notifications to trigger automated responses or alerts.
• List and monitor multiple Flume devices and their current status via a custom application.
• Integrate Flume water data into home automation or smart home platforms.
• Build reporting tools that aggregate water usage alerts and usage trends over time.

Worth the install?

AI-flagged interpretation of the facts on this page — verify before relying

PyFlume provides Python bindings to interact with the Flume water sensor API, enabling retrieval and management of device data, notifications, alerts, and usage information.

Yes, if you own Flume hardware and need programmatic API access. The library is permissively licensed and has no known vulnerabilities. However, install with caution: the package is dormant (no updates in 781 days), so it may fall out of sync with Flume's API or Python ecosystem changes. Verify API compatibility before deploying to production, and be prepared to maintain a fork if Flume makes breaking changes.

Install

pyflume on PyPI

pip install pyflume

uv add pyflume

poetry add pyflume

Installing PyFlume

Before you install

Installation carries high friction due to four runtime dependencies (pyjwt, ratelimit, requests, backports.zoneinfo). The package is dormant—last release was 781 days ago with no recent commits beyond June 2024—so dependency updates and compatibility fixes are unlikely.

License in practice

Licensed under MIT (permissive), so commercial and private use are unrestricted, and modification is allowed provided the license text is retained.

Quickstart

pip install pyflume

from pyflume import FlumeAuth, FlumeData

auth = FlumeAuth(client_id, client_secret, username, password)
data = FlumeData(auth)
devices = data.get_devices()

Requires valid Flume API credentials (Client ID, Client Secret, username, password) obtainable from the Flume portal settings page.

Verify before relying

• Whether backports.zoneinfo is needed on Python 3.9+ (where zoneinfo is built-in) or only on earlier versions.
• Exact Python version support range, since requires_python is unspecified in the fact sheet.
• Current API compatibility with the live Flume service, given the 781-day gap since last release.

Package facts

Evidence: pyflume-0.8.7.tar.gz

Tags

More WWW/HTTP packages