Fluss+ API Client
Project description
Fluss API Client
A Python client for the Fluss REST API — control gates, doors, and access devices programmatically.
Installation
pip install fluss_api
Usage
import asyncio
from fluss_api import FlussApiClient
async def main():
client = FlussApiClient(api_key="your-api-key")
# List all devices
devices = await client.async_get_devices()
# Get device status
status = await client.async_get_device_status("device-id")
# Trigger a device
await client.async_trigger_device("device-id")
# Trigger with optional parameters
await client.async_trigger_device("device-id", action="pulse", duration=3)
# Open a device
await client.async_open_device("device-id")
# Close a device
await client.async_close_device("device-id")
await client.close()
asyncio.run(main())
Custom Session
You can pass your own aiohttp.ClientSession if needed:
from aiohttp import ClientSession
from fluss_api import FlussApiClient
async with ClientSession() as session:
client = FlussApiClient(api_key="your-api-key", session=session)
devices = await client.async_get_devices()
API Methods
| Method | Description |
|---|---|
async_get_devices() |
List all devices on your account |
async_get_device_status(device_id) |
Get current status of a device |
async_trigger_device(device_id, **kwargs) |
Trigger a device |
async_open_device(device_id, **kwargs) |
Open a gate/door |
async_close_device(device_id, **kwargs) |
Close a gate/door |
close() |
Close the HTTP session |
Building from Source
python -m pip install --upgrade build
python -m build
License
MIT
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file fluss_api-0.2.4.tar.gz.
File metadata
- Download URL: fluss_api-0.2.4.tar.gz
- Upload date:
- Size: 4.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
350f0201ee62caf4e1d29aab4ca2b90ba854c879eb28efd4c878972529d96c8c
|
|
| MD5 |
51c3b2de47b8e5c884c0756a66a52425
|
|
| BLAKE2b-256 |
3273f63761ed9d871d97d4b0cd0c2ed0355860efe2ce7626d2a3d7210320c965
|
Provenance
The following attestation bundles were made for fluss_api-0.2.4.tar.gz:
Publisher:
python-publish.yml on fluss/Fluss_Python_Library
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fluss_api-0.2.4.tar.gz -
Subject digest:
350f0201ee62caf4e1d29aab4ca2b90ba854c879eb28efd4c878972529d96c8c - Sigstore transparency entry: 1270380249
- Sigstore integration time:
-
Permalink:
fluss/Fluss_Python_Library@bf05301c6b14bb704c3422ca3f9aaa6ecc1e260a -
Branch / Tag:
refs/tags/v0.2.4 - Owner: https://github.com/fluss
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@bf05301c6b14bb704c3422ca3f9aaa6ecc1e260a -
Trigger Event:
push
-
Statement type:
File details
Details for the file fluss_api-0.2.4-py3-none-any.whl.
File metadata
- Download URL: fluss_api-0.2.4-py3-none-any.whl
- Upload date:
- Size: 4.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3e0de872ffce5675fd5f5209b0979c3c08cd549b3d85092e4bbc7e48b5c7a4d8
|
|
| MD5 |
16c547dd9d287babbf17ba22b5617c4b
|
|
| BLAKE2b-256 |
e4afc90028f2ec03d51c4ab4df24f74d37214ad922a98405489bdeb80f7d0f12
|
Provenance
The following attestation bundles were made for fluss_api-0.2.4-py3-none-any.whl:
Publisher:
python-publish.yml on fluss/Fluss_Python_Library
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
fluss_api-0.2.4-py3-none-any.whl -
Subject digest:
3e0de872ffce5675fd5f5209b0979c3c08cd549b3d85092e4bbc7e48b5c7a4d8 - Sigstore transparency entry: 1270380287
- Sigstore integration time:
-
Permalink:
fluss/Fluss_Python_Library@bf05301c6b14bb704c3422ca3f9aaa6ecc1e260a -
Branch / Tag:
refs/tags/v0.2.4 - Owner: https://github.com/fluss
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@bf05301c6b14bb704c3422ca3f9aaa6ecc1e260a -
Trigger Event:
push
-
Statement type: