Algomancy 0.3.12__py3-none-any.whl

algomancy/__init__.py

@@ -0,0 +1,9 @@
+"""A module for orchestrating components in a content creation and data analysis system.
+
+This module integrates various components of a content creation and data-driven
+workflow, including content creator library management, logging, data processing,
+and scenario simulation. It serves as a central manager for handling interdependencies
+and interactions between these subsystems.
+"""
+
+__version__ = "0.2.4"

algomancy/gui_launcher.py

@@ -0,0 +1,162 @@
+from typing import Dict, Any, Union
+import importlib.metadata
+import os
+
+from waitress import serve
+import dash_auth
+from dash import get_app, Dash, html, dcc
+from dash_bootstrap_components.themes import BOOTSTRAP
+
+from algomancy_gui.layout import LayoutCreator
+from algomancy_gui.contentregistry import ContentRegistry
+from algomancy_gui.settingsmanager import SettingsManager
+from algomancy_gui.sessionmanager import SessionManager
+from algomancy_gui.componentids import ACTIVE_SESSION
+from algomancy_gui.appconfiguration import AppConfiguration
+from algomancy_content.librarymanager import LibraryManager as lm
+from algomancy_utils.logger import MessageStatus
+
+
+class GuiLauncher:
+    @staticmethod
+    def build(cfg: Union[AppConfiguration, Dict[str, Any]]) -> Dash:
+        # Normalize configuration to AppConfiguration for a single source of truth
+        if isinstance(cfg, dict):
+            cfg_obj = AppConfiguration(**cfg)
+        elif isinstance(cfg, AppConfiguration):
+            cfg_obj = cfg
+        else:
+            raise TypeError("DashLauncher.build expects AppConfiguration or dict")
+
+        session_manager: SessionManager = SessionManager.from_config(cfg_obj)
+
+        # Create the app
+        app = GuiLauncher._construct(
+            cfg=cfg_obj,
+            session_manager=session_manager,
+        )
+
+        # register authentication if enabled
+        if cfg_obj.use_authentication:
+            if not os.getenv("APP_USERNAME") or not os.getenv("APP_PASSWORD"):
+                raise ValueError(
+                    "Environment variables 'APP_USERNAME' and 'APP_PASSWORD' must be set"
+                )  # todo document where to set username and password
+
+            # add authentication to the app
+            dash_auth.BasicAuth(
+                app,
+                [[os.getenv("APP_USERNAME"), os.getenv("APP_PASSWORD")]],
+                secret_key="secret-key",
+            )
+
+        return app
+
+    @staticmethod
+    def _construct(
+        cfg: AppConfiguration,
+        session_manager: SessionManager,
+    ) -> Dash:
+        # Initialize the app
+        external_stylesheets = [
+            BOOTSTRAP,
+            "https://use.fontawesome.com/releases/v5.15.4/css/all.css",
+        ]
+
+        from pathlib import Path
+
+        assets_path = Path(os.getcwd()) / Path(cfg.assets_path)
+
+        app = Dash(
+            external_stylesheets=external_stylesheets,
+            suppress_callback_exceptions=True,
+            assets_folder=str(assets_path),
+        )
+        app.title = cfg.title
+
+        # register the scenario manager on the app object
+        app.server.session_manager = session_manager
+
+        # register the styling configuration on the app object
+        app.server.styling_config = cfg.styling_config
+
+        # register the settings manager on the app object for access in callbacks
+        app.server.settings = SettingsManager(cfg.as_dict())
+
+        # fetch standard pages
+        home_page, data_page, scenario_page, compare_page, overview_page = lm.get_pages(
+            cfg.as_dict()
+        )
+
+        # register the content register functions
+        content_registry = ContentRegistry()
+        app.server.content_registry = content_registry
+
+        # register pages
+        content_registry.register_pages(
+            home_page, data_page, scenario_page, compare_page, overview_page
+        )
+
+        # fill and run the app
+        app.layout = html.Div(
+            [
+                LayoutCreator.create_layout(cfg.styling_config),
+                dcc.Store(
+                    id=ACTIVE_SESSION,
+                    storage_type="session",
+                    data=session_manager.start_session_name,
+                ),
+            ]
+        )
+
+        return app
+
+    @staticmethod
+    def run(
+        app: Dash,
+        host: str,
+        port: int,
+        threads: int = 8,
+        connection_limit: int = 100,
+        debug: bool = False,
+    ) -> None:
+        sm = get_app().server.session_manager
+
+        algomancy_version = importlib.metadata.version("algomancy")
+        sm.log(f"Algomancy version: {algomancy_version}", MessageStatus.INFO)
+
+        if not debug:
+            sm.log(
+                "--------------------------------------------------------------------",
+                MessageStatus.SUCCESS,
+            )
+            sm.log(
+                f"Starting Dashboard server with Waitress on {host}:{port}...",
+                MessageStatus.SUCCESS,
+            )
+            sm.log(
+                f"  threads:{threads}, connection limit: {connection_limit}",
+                MessageStatus.SUCCESS,
+            )
+            sm.log(
+                "--------------------------------------------------------------------",
+                MessageStatus.SUCCESS,
+            )
+            serve(
+                app.server,
+                host=host,
+                port=port,
+                threads=threads,
+                connection_limit=connection_limit,
+            )
+        else:
+            sm.log(
+                f"Starting Dashboard server in debug mode on {host}:{port}...",
+                MessageStatus.SUCCESS,
+            )
+            app.run(
+                debug=debug,
+                host=host,
+                port=port,
+                dev_tools_silence_routes_logging=False,
+            )

algomancy-0.3.12.dist-info/METADATA

@@ -0,0 +1,178 @@
+Metadata-Version: 2.4
+Name: Algomancy
+Version: 0.3.12
+Summary: A dashboarding framework for visualizing performances of algorithms or simulations in various scenarios.
+Keywords: visualization,algorithm,simulation,scenario
+Author: Pepijn Wissing
+Author-email: Pepijn Wissing <pepijn.wissing@cqm.nl>
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Programming Language :: Python
+Requires-Dist: algomancy-cli>=0.3.12
+Requires-Dist: algomancy-content>=0.3.12
+Requires-Dist: algomancy-data>=0.3.12
+Requires-Dist: algomancy-gui>=0.3.12
+Requires-Dist: algomancy-scenario>=0.3.12
+Requires-Dist: algomancy-utils>=0.3.12
+Requires-Dist: pytest>=8.4.2
+Requires-Dist: ruff>=0.13.1
+Requires-Dist: strenum>=0.4.15
+Maintainer: Pepijn Wissing, Bart Post
+Maintainer-email: Pepijn Wissing <pepijn.wissing@cqm.nl>, Bart Post <bart.post@cqm.nl>
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# Algomancy
+
+A lightweight framework for building interactive dashboards to visualize the performance of algorithms and/or simulations across scenarios. It provides data ingestion (ETL), scenario orchestration, KPI computation, and a Dash-based UI with modular pages.
+
+### Overview
+- Language/stack: Python 3.14+, Dash (frontend/server), Waitress (production WSGI), PyTest (tests), Ruff (lint). Optional: uv as package manager (uv.lock present).
+- Package layout: Installable Python package (setuptools/pyproject). Library entry points are in algomancy/, with an example executable script main-example.py.
+- Use cases: Rapid prototyping of algorithm scenario experiments and visual inspection of results.
+
+### Requirements
+- Python: 3.14+
+- OS: Windows, macOS, or Linux
+- Dependencies (core): dash, dash-bootstrap-components, dash-auth (optional), dash-extensions, dash-iconify, pandas, fastparquet, openpyxl, diskcache, strenum, tabulate, waitress, python-dotenv
+- Dev/test tools: pytest, ruff, wheel
+- Optional tools: uv (if you prefer uv over pip)
+
+## Installation
+You can install the published package from the private Azure Artifacts feed (keep this section) or install locally in editable/development mode.
+
+### From PyPI
+- Install Algomancy:
+```
+uv add algomancy
+```
+
+### Running the Example App
+This repo includes an example application that exercises the framework components.
+- CLI
+  python main-example.py --host 127.0.0.1 --port 8050 --threads 8 --connections 100 --debug False
+- Defaults
+  If flags are omitted, sensible defaults are applied inside main() (e.g., host differs by OS, port=8050).
+- After starting, open http://127.0.0.1:8050 (or the host/port you chose) in your browser.
+
+### Programmatic Usage (library)
+You can embed Algomancy into your own app using the DashLauncher helper.
+- Minimal sketch:
+
+```python
+from src.algomancy import BaseDataSource
+from src.algomancy.gui_launcher import GuiLauncher
+from algomancy_gui.appconfiguration import AppConfiguration
+
+configuration = {
+  "assets_path": "assets",
+  "data_path": "tests/data",
+  "has_persistent_state": True,
+  "save_type": "json",
+  "data_object_type": BaseDataSource,
+  "etl_factory": YourETLFactory,
+  "kpi_templates": your_kpi_templates,
+  "algo_templates": your_algorithm_templates,
+  "input_configs": your_input_configs,
+  "autorun": False,
+  "home_content": "placeholder",
+  "data_content": "placeholder",
+  "scenario_content": "placeholder",
+  "compare_content": "placeholder",
+  "compare_compare": "placeholder",
+  "compare_details": "placeholder",
+  "overview_content": "placeholder",
+  "home_callbacks": None,
+  "data_callbacks": None,
+  "scenario_callbacks": None,
+  "compare_callbacks": None,
+  "overview_callbacks": None,
+  "styling_config": None,  # see StylingConfigurator for options
+  "title": "My Algomancy Dashboard",
+  "use_authentication": False,
+}
+app_cfg = AppConfiguration.from_dict(configuration)  # or AppConfiguration(asset_path=...)
+
+app = GuiLauncher.build(app_cfg)
+GuiLauncher.run(app, host=app_cfg.host, port=app_cfg.port)
+```
+### Environment Variables
+- Authentication (optional): If configuration["use_authentication"] is True, set these before launching:
+  APP_USERNAME=<username>
+  APP_PASSWORD=<password>
+  If either is missing, DashLauncher.build will raise a ValueError.
+- Other env vars: Not required by default. You may use a .env file with python-dotenv if you extend the app. TODO: Document any project-specific environment variables if/when they are introduced.
+
+### Scripts and Common Commands
+- Run example app:
+  python main-example.py
+- Run tests:
+  pytest -q
+- Run tests with verbose output:
+  pytest -vv
+- Lint with Ruff:
+  ruff check .
+- Format with Ruff (if you choose to enable it):
+  ruff format .
+
+### Testing
+- Framework uses pytest; tests are under tests/.
+- Example dataset is in tests/data and tests/data/example_data.
+- Some tests are marked xfail intentionally (e.g., missing setters) to capture current behavior. You can run them as-is to verify baseline expectations.
+
+### Project Structure
+High-level layout (non-exhaustive):
+- algomancy/                Core package
+  - launcher.py             Build and run Dash app (DashLauncher)
+  - dataengine/             Data loading, ETL, schema, validation
+  - scenarioengine/         Scenario orchestration, algorithms, KPIs
+  - components/             Dash UI components and pages
+  - contentcreatorlibrary/  Ready-made content creators (examples/standard/placeholder)
+  - dashboardlogger/        Logging utilities
+  - settingsmanager.py      Shared runtime settings access
+  - stylingconfigurator.py  Theme, colors, layout selection
+- example_implementation/   Example ETL, pages, and templates
+- assets/                   Static assets (images/styles)
+- tests/                    PyTest suites and data files
+- main-example.py           Example app entry point
+- pyproject.toml            Build configuration (setuptools)
+- uv.lock                   Lock file for uv (optional)
+
+### Entry Points
+- Example executable: main-example.py (CLI and default run)
+- Library: DashLauncher in algomancy/launcher.py
+- There are no console_scripts defined in pyproject.toml.
+
+### Configuration Notes
+- Styling: See algomancy/stylingconfigurator.py for layout and color options.
+- Content registration: algomancy/contentcreatorlibrary and algomancy/contentregistry.py provide standard/example/placeholder content.
+- Server: DashLauncher.run uses Waitress in non-debug mode; Dash’s built-in server is used for debug.
+
+### Package Management
+- The project is defined via pyproject.toml with setuptools. Use pip for installs by default.
+- A uv.lock file is present; you may use uv if preferred. This repository does not mandate uv.
+
+### CI/CD
+- Pipelines configuration files are present under Pipelines/ (Azure DevOps YAML). TODO: Document pipeline triggers, variables, and publishing steps if relevant.
+
+### License
+- License: Restricted (as declared in pyproject.toml). Distribution and usage may be limited. Consult the project owners for permissions.
+
+### Changelog
+- See changelog.md for notable changes.
+
+### Contributing
+- Open issues and pull requests as needed. Run ruff and pytest locally before pushing.
+- TODO: Add contributor guidelines and code style policy if required.
+
+### Support
+- Maintainers: See pyproject.toml authors/maintainers fields.
+- For private package feed access or deployment, contact project maintainers.
+
+# Update version
+Option A: Update Pipfile to point to the existing wheel (preferred)
+In Pipfile, replace the algomancy source pointing to 0.2.5 with the local 0.2.6 wheel path:
+Example: algomancy = {path = "dist/algomancy-0.2.6-py3-none-any.whl"}
+Then regenerate lockfile and install:
+pipenv lock --clear
+pipenv install

algomancy-0.3.12.dist-info/RECORD

@@ -0,0 +1,7 @@
+algomancy/__init__.py,sha256=g3AqZHGkN5Ap2EHhnBnnAV9u2OhXy3MlAWTJOLp478s,409
+algomancy/gui_launcher.py,sha256=TL-PkZgKCjMO9K0v1uekR3mYNsaqhPlOSe70_TQ_B_s,5324
+algomancy-0.3.12.dist-info/licenses/LICENSE,sha256=pAZXnNE2dxxwXFIduGyn1gpvPefJtUYOYZOi3yeGG94,1068
+algomancy-0.3.12.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+algomancy-0.3.12.dist-info/entry_points.txt,sha256=GjvkaIZyYVjM-PUQOiReMb_8MUJ944VU6LV0WqXSD9M,59
+algomancy-0.3.12.dist-info/METADATA,sha256=J5zuWguYFs0PmGh1rRkahLDCjChRjL0IMuRbrsjQ1kY,7810
+algomancy-0.3.12.dist-info/RECORD,,

algomancy-0.3.12.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.9.28
+Root-Is-Purelib: true
+Tag: py3-none-any

algomancy-0.3.12.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+algomancy-cli = algomancy_cli.main:main
+

algomancy-0.3.12.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [year] [fullname]
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.