Metadata-Version: 2.5
Name: fluksio
Version: 0.2.0
Summary: Node-based automation engine: flows, dashboards, batch runs
Project-URL: Homepage, https://fluksio.com
Project-URL: Documentation, https://docs.fluksio.com
Project-URL: Getting started, https://docs.fluksio.com/getting-started/data-science/
Author-email: Fluksio <stroblme@posteo.de>
License-Expression: AGPL-3.0-or-later
License-File: LICENSE
Keywords: automation,dataflow,experiment-tracking,mlops,workflow
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Home Automation
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: System :: Distributed Computing
Requires-Python: >=3.12
Requires-Dist: alembic<2.0.0,>=1.12.1
Requires-Dist: croniter>=1.3.0
Requires-Dist: cryptography>=44.0.0
Requires-Dist: email-validator<3.0.0.0,>=2.1.0.post1
Requires-Dist: fastapi[standard-no-fastapi-cloud-cli]<1.0.0,>=0.114.2
Requires-Dist: fluksio-worker<0.3,>=0.2
Requires-Dist: http-ece>=1.2
Requires-Dist: httpx<1.0.0,>=0.25.1
Requires-Dist: jinja2<4.0.0,>=3.1.4
Requires-Dist: mcp<3,>=2.3
Requires-Dist: orjson>=3.10
Requires-Dist: pwdlib[argon2,bcrypt]>=0.3.0
Requires-Dist: pydantic-settings<3.0.0,>=2.2.1
Requires-Dist: pydantic>2.0
Requires-Dist: pyjwt<3.0.0,>=2.8.0
Requires-Dist: python-multipart<1.0.0,>=0.0.7
Requires-Dist: redis>=7.1.0
Requires-Dist: rich>=13
Requires-Dist: sqlmodel<1.0.0,>=0.0.21
Requires-Dist: textual>=1.0
Requires-Dist: threadpoolctl>=3.5
Requires-Dist: uv>=0.13.4
Requires-Dist: websockets>=14
Provides-Extra: email
Requires-Dist: emails<1.0,>=0.6; extra == 'email'
Provides-Extra: influx
Requires-Dist: influxdb-client[async]>=1.40.0; extra == 'influx'
Provides-Extra: ml
Requires-Dist: numpy>=2.2.6; extra == 'ml'
Provides-Extra: mqtt
Requires-Dist: aiomqtt>=2.0.0; extra == 'mqtt'
Provides-Extra: parquet
Requires-Dist: pyarrow>=17; extra == 'parquet'
Provides-Extra: sentry
Requires-Dist: sentry-sdk[fastapi]>=2.20.0; extra == 'sentry'
Provides-Extra: server
Requires-Dist: aiomqtt>=2.0.0; extra == 'server'
Requires-Dist: emails<1.0,>=0.6; extra == 'server'
Requires-Dist: influxdb-client[async]>=1.40.0; extra == 'server'
Requires-Dist: numpy>=2.2.6; extra == 'server'
Requires-Dist: sentry-sdk[fastapi]>=2.20.0; extra == 'server'
Description-Content-Type: text/markdown

# Fluksio

Turn Python functions into connected nodes, run experiments, and keep their
metrics and artifacts together. Start an engine with Python 3.12 or newer
on Linux or macOS:

```sh
pip install fluksio
fluksio serve
```

The first start prints an admin password and opens a terminal dashboard.
For a browser dashboard, connect the instance to the optional
[portal](https://docs.fluksio.com/interface/portal/).

## For data science

Save this small experiment as `study.py`. No dataset or GPU needed:

```python
import math

from fluksio import Flow, Port, node

@node(
    requires=[Port("lr", "float")],
    provides=[Port("loss", "float", stream=True), Port("final_loss", "float")],
)
def fit(lr, epochs=25):
    for epoch in range(epochs):
        loss = math.exp(-lr * (epoch + 1))
        yield {"loss": loss}
    return {"final_loss": loss}


train = Flow(
    "train",
    nodes=[fit],
    inputs=[Port("lr", "float", initial=0.01)],
    outputs=["final_loss"],
)
```

Matching message names connect the nodes and determine their order. After
syncing the project, start a run:

```sh
fluksio sync study
fluksio run train --lr 0.05 --wait
```

Each yield records a point on the loss curve. Replace the toy calculation
with your own training code when you're ready. For artifacts and comparisons, try the
[data science guide](https://docs.fluksio.com/getting-started/data-science/).

## More to explore

- **Flows**: typed messages between nodes, wired by name, edited on a canvas
  or declared in code. Every change is a commit in a git repository you own.
- **Runs**: an experiment and a CI-style job are the same entity. Parameters,
  seed, result, per-node timings, artifacts and the commit it ran at.
- **Dashboards**: charts and controls bound to the same messages the flows
  carry, with no separate metrics pipeline.
- **Remote workers**: `pip install fluksio-worker` on the GPU box; it dials
  *out* over one websocket, so nothing there has to be reachable.

For sensors, devices and live automation, try the
[facility automation guide](https://docs.fluksio.com/getting-started/facility-automation/).

## License

Copyright (C) 2026 Melvin Strobl - [GNU Affero General Public License v3.0 or
later](https://www.gnu.org/licenses/agpl-3.0.en.html). Running a modified
version over a network obliges you to offer its users the corresponding source
(AGPL §13).
