algomancy-scenario
Scenario modeling utilities for Algomancy: define algorithms and parameters, run scenarios against data, and compute KPIs.
Features
Scenariolifecycle with statuses (CREATED,QUEUED,PROCESSING,COMPLETE,FAILED)BaseAlgorithmand parameter classes to define pluggable algorithms- KPI framework (
BaseKPI) to compute metrics from algorithm results - Works with
algomancy-datadata sources and can be orchestrated from the GUI
Installation
pip install -e packages/algomancy-scenario
Requires Python >= 3.14.
Quick start
Define a simple algorithm and KPI, then run a Scenario:
from algomancy_scenario import (
Scenario, ScenarioStatus,
BaseAlgorithm, BaseParameterSet, BaseKPI,
)
from algomancy_data import DataSource, DataClassification
# Minimal parameters type
class ExampleParams(BaseParameterSet):
def serialize(self) -> dict:
return {"hello": "world"}
# Minimal algorithm
class ExampleAlgorithm(BaseAlgorithm):
def __init__(self):
super().__init__(name="Example", params=ExampleParams())
@staticmethod
def initialize_parameters() -> ExampleParams: # used by GUI tooling
return ExampleParams()
def run(self, data: DataSource) -> dict:
# do something with data and return a result dictionary
self.set_progress(100)
return {"count_tables": len(data.list_tables())}
# Minimal KPI
class CountTablesKPI(BaseKPI):
def __init__(self):
super().__init__(name="Tables", improvement_direction=None)
def compute_and_check(self, result: dict):
self.value = result["count_tables"]
# Prepare data
ds = DataSource(ds_type=DataClassification.MASTER_DATA, name="warehouse")
# Build and run scenario
scenario = Scenario(
tag="demo",
input_data=ds,
kpis={"tables": CountTablesKPI()},
algorithm=ExampleAlgorithm(),
)
scenario.process()
assert scenario.status == ScenarioStatus.COMPLETE
print("Tables KPI:", scenario.kpis["tables"].value)
Related docs and examples
- Example app demonstrates scenario wiring:
example/pages/ScenarioPageContent.py - Algorithm/KPI examples:
example/templates/algorithm/andexample/templates/kpi/
Metadata
Release files for algomancy-scenario 0.10.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| algomancy_scenario-0.10.0-py3-none-any.whl | Python 3 | none | any | Details for algomancy_scenario-0.10.0-py3-none-any.whl |
Release files / algomancy_scenario-0.10.0-py3-none-any.whl
| Download URL | algomancy_scenario-0.10.0-py3-none-any.whl |
|---|---|
| Size | 45.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
f0e79a22c929e79436991b9028eab753ec7f0f2b38d3fbb28edd4d77aecd4fec
|
|
BLAKE2b-256 checksum How to use checksums |
733b990179346eb9b4fa179980c92cb23f4e33acc3e51d684b3b727054107c79
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.3 {"installer":{"name":"uv","version":"0.12.3","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for algomancy-scenario 0.10.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.