algomancy-quickstart 0.7.0__py3-none-any.whl

algomancy_quickstart/templates/overview_page.py.jinja

@@ -0,0 +1,98 @@
+"""
+Custom overview page template for {{ project_name }}.
+
+This module defines a custom overview page for high-level dashboards and summaries.
+"""
+
+from typing import List
+from dash import html
+from algomancy_content import BaseOverviewPage
+from algomancy_scenario import Scenario
+
+
+class {{ class_name }}OverviewPage(BaseOverviewPage):
+    """
+    Custom overview page implementation for {{ project_name }}.
+
+    TODO: Customize the overview page layout and behavior.
+    """
+
+    @staticmethod
+    def create_content(scenarios: List[Scenario]) -> html.Div:
+        """
+        Define the layout and content of the overview page displaying multiple scenarios.
+
+        Args:
+            scenarios: A list of Scenario objects to display in the overview.
+
+        Returns:
+            A Dash html.Div containing the page content.
+
+        TODO: Implement your custom overview page layout.
+        """
+        # Get completed scenarios for display
+        completed_scenarios = [s for s in scenarios if s.is_completed()]
+
+        return html.Div(
+            [
+                html.H1("{{ project_name }} Overview Dashboard"),
+                html.P(
+                    f"Total scenarios: {len(scenarios)} | Completed: {len(completed_scenarios)}"
+                ),
+                html.Hr(),
+                html.Div(
+                    [
+                        html.H3("Scenarios Summary"),
+                        html.Div(
+                            [
+                                html.Div(
+                                    [
+                                        html.H5(scenario.tag),
+                                        html.P(f"Status: {scenario.status}"),
+                                        html.P(f"Algorithm: {scenario.algorithm_description}"),
+                                    ],
+                                    style={
+                                        "border": "1px solid #ddd",
+                                        "padding": "10px",
+                                        "marginBottom": "10px",
+                                        "borderRadius": "5px",
+                                    },
+                                )
+                                for scenario in scenarios
+                            ]
+                        )
+                        if scenarios
+                        else html.P("No scenarios found. Create your first scenario to get started."),
+                    ]
+                ),
+                html.Hr(),
+                html.Div(
+                    [
+                        html.H3("Dashboard Features"),
+                        html.Ul(
+                            [
+                                html.Li("Display key performance indicators across scenarios"),
+                                html.Li("Show summary statistics and trends"),
+                                html.Li("Compare scenario outcomes at a glance"),
+                                html.Li("Customize this page in src/pages/overview_page.py"),
+                            ]
+                        ),
+                    ]
+                ),
+                # TODO: Add KPI comparison table, summary charts, executive dashboard components
+            ],
+            style={"padding": "20px"},
+        )
+
+    @staticmethod
+    def register_callbacks() -> None:
+        """
+        Register Dash callbacks for this page if needed.
+
+        TODO: Add any interactive behavior for the overview page.
+        """
+        # Example:
+        # @app.callback(...)
+        # def filter_scenarios(...):
+        #     pass
+        pass

algomancy_quickstart/templates/scenario_page.py.jinja

@@ -0,0 +1,77 @@
+"""
+Custom scenario page template for {{ project_name }}.
+
+This module defines a custom scenario page for managing and comparing scenarios.
+"""
+
+from dash import html
+from algomancy_content import BaseScenarioPage
+from algomancy_scenario import Scenario
+
+
+class {{ class_name }}ScenarioPage(BaseScenarioPage):
+    """
+    Custom scenario page implementation for {{ project_name }}.
+
+    TODO: Customize the scenario page layout and behavior.
+    """
+
+    @staticmethod
+    def create_content(scenario: Scenario) -> html.Div:
+        """
+        Define the layout and content of the scenario page for the given scenario.
+
+        Args:
+            scenario: The Scenario object to display.
+
+        Returns:
+            A Dash html.Div containing the page content.
+
+        TODO: Implement your custom scenario page layout.
+        """
+        return html.Div(
+            [
+                html.H1("{{ project_name }} Scenario Details"),
+                html.Hr(),
+                html.Div(
+                    [
+                        html.H3("Scenario Information"),
+                        html.P(f"Tag: {scenario.tag}"),
+                        html.P(f"ID: {scenario.id}"),
+                        html.P(f"Status: {scenario.status}"),
+                        html.P(f"Algorithm: {scenario.algorithm_description}"),
+                        html.P(f"Dataset: {scenario.input_data_key}"),
+                    ],
+                    style={"marginBottom": "20px"},
+                ),
+                html.Hr(),
+                html.Div(
+                    [
+                        html.H3("Scenario Features"),
+                        html.Ul(
+                            [
+                                html.Li("View scenario configuration and parameters"),
+                                html.Li("Display scenario execution results"),
+                                html.Li("Visualize scenario outcomes and KPIs"),
+                                html.Li("Customize this page in src/pages/scenario_page.py"),
+                            ]
+                        ),
+                    ]
+                ),
+                # TODO: Add scenario-specific visualizations, results tables, charts
+            ],
+            style={"padding": "20px"},
+        )
+
+    @staticmethod
+    def register_callbacks() -> None:
+        """
+        Register Dash callbacks for this page if needed.
+
+        TODO: Add any interactive behavior for the scenario page.
+        """
+        # Example:
+        # @app.callback(...)
+        # def update_scenario_view(...):
+        #     pass
+        pass

algomancy_quickstart/templates/schema.py.jinja

@@ -0,0 +1,58 @@
+"""
+Schema definition for {{ project_name }} data.
+
+This module defines the data structure and types for your application's data.
+"""
+
+from algomancy_data import (
+    Column,
+    ColumnGroup,  # noqa: F401  # used for MULTI (multi-sheet) schemas
+    DataType,
+    FileExtension,
+    Schema,
+)
+from algomancy_data.schema import SchemaType
+
+
+class {{ class_name }}Schema(Schema):
+    """
+    Schema for {{ project_name }} data.
+
+    Declare each column as a class-level :class:`Column` attribute. Useful
+    keyword arguments:
+
+    * ``dtype``               — required, one of :class:`DataType`.
+    * ``primary_key=True``    — marks the column as part of the PK.
+    * ``optional=True``       — column may be absent in the source file.
+    * ``nullable=True``       — column may contain null values.
+    * ``unique=True``         — values must be unique across rows.
+    * ``foreign_key=("table", "col")`` — relate to another schema's column.
+    * ``parent_requires_child=True``   — drop parent rows that have no
+      matching child (used together with ``foreign_key``).
+
+    For multi-sheet workbooks set ``_SCHEMA_TYPE = SchemaType.MULTI`` and
+    declare one :class:`ColumnGroup` per sheet instead of bare ``Column``s.
+
+    TODO: Customize the schema according to your data structure.
+    """
+
+    # TODO: Set the base filename (without extension) for your data files
+    _FILENAME = "{{ filename }}"
+
+    # TODO: Set the file extension (CSV, XLSX, JSON)
+    _EXTENSION = FileExtension.CSV
+
+    # TODO: Set schema type (SINGLE for one file/sheet, MULTI for multi-sheet)
+    _SCHEMA_TYPE = SchemaType.SINGLE
+
+    # TODO: Replace these example columns with your own.
+    ID = Column("id", dtype=DataType.INTEGER, primary_key=True)
+    NAME = Column("name", dtype=DataType.STRING)
+    # Add more columns here, e.g.:
+    # CREATED_AT = Column("created_at", dtype=DataType.DATETIME, nullable=True)
+
+
+# Collect all schemas exported by this module — imported by main.py.
+all_schemas = [
+    {{ class_name }}Schema,
+]

algomancy_quickstart/templates/styling_config.py.jinja

@@ -0,0 +1,53 @@
+"""
+Styling configuration for {{ project_name }}.
+
+This file defines the visual styling for your Algomancy application.
+You can customize colors, button modes, and other visual elements here.
+"""
+
+from algomancy_gui.configuration.stylingconfig import (
+    StylingConfig,
+    LayoutSelection,
+)
+from algomancy_gui.configuration.colorconfig import (
+    ColorConfig,
+    CardHighlightMode,
+    ButtonColorMode,
+)
+
+
+def get_styling_config() -> StylingConfig:
+    """
+    Create and return the styling configuration for this application.
+
+    Returns:
+        StylingConfig instance with custom colors and settings.
+    """
+
+    # Color configuration
+    color_config = ColorConfig(
+        background_color="{{ background }}",
+        theme_color_primary="{{ primary }}",
+        theme_color_secondary="{{ secondary }}",
+        theme_color_tertiary="{{ primary }}",  # Using primary as tertiary
+        text_color="{{ text }}",
+        text_color_highlight="{{ text_highlight }}",
+        text_color_selected="{{ text_selected }}",
+        button_color_mode=ButtonColorMode.{{ button_mode }},
+    )
+
+    # Create styling configuration
+    styling = StylingConfig(
+        assets_path="assets",
+        layout_selection=LayoutSelection.SIDEBAR,
+        color_configuration=color_config,
+        {% if logo_path %}logo_path="{{ logo_path }}",{% endif %}
+        {% if button_path %}button_path="{{ button_path }}",{% endif %}
+        card_highlight_mode=CardHighlightMode.{{ card_mode }},
+    )
+
+    return styling
+
+
+# Create the default styling instance
+app_styling = get_styling_config()

algomancy_quickstart-0.7.0.dist-info/METADATA

@@ -0,0 +1,29 @@
+Metadata-Version: 2.3
+Name: algomancy-quickstart
+Version: 0.7.0
+Summary: Interactive CLI wizard for setting up Algomancy applications.
+Requires-Dist: algomancy-utils
+Requires-Dist: algomancy-content
+Requires-Dist: algomancy-data
+Requires-Dist: algomancy-gui
+Requires-Dist: click>=8.0.0
+Requires-Dist: jinja2>=3.0.0
+Requires-Dist: rich>=13.0.0
+Requires-Python: >=3.14
+Description-Content-Type: text/markdown
+
+# Algomancy Quickstart
+
+Interactive CLI wizard for bootstrapping Algomancy applications.
+
+## Usage
+```bash
+algomancy-quickstart [options]
+```
+
+This will guide you through setting up:
+1. Folder structure and basic main method
+2. Custom implementation shells for placeholders
+3. ETL pipeline generation from data
+4. Assets import from GitHub
+5. Styling configuration

algomancy_quickstart-0.7.0.dist-info/RECORD

@@ -0,0 +1,42 @@
+algomancy_quickstart/__init__.py,sha256=vZnBKoDyjEDjUfRM2hrqLraeGfDAeoZjXlTS8Wx2Oi0,66
+algomancy_quickstart/asset_manager.py,sha256=XuKUtOikoc3PNxNnr-zQHNHzTEtds-djDvkJIrVydRg,6841
+algomancy_quickstart/data_inference.py,sha256=TdpwR8AWwnpQ6q_yoLkcMEv_LU8dzpjWzCMdzj9ByPw,17402
+algomancy_quickstart/main.py,sha256=HE_xsQCQk6XoxMHZwlOoHZpFOM0x8XQU2wfKAHTbm8Q,1745
+algomancy_quickstart/quickstart.py,sha256=H6wpewNGzmlu0iXMEdyWXA-7uzGmcDEc0TFqr8D_V5g,24769
+algomancy_quickstart/styling_wizard.py,sha256=XLaz2IdSCAyYOJGucLVH0cv0s37Ac2XDWjw707PrSSY,11033
+algomancy_quickstart/templates/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+algomancy_quickstart/templates/algorithm.py.jinja,sha256=MzCdi7Ad0wjlptCRrg2EvXa7CI3PUwLc8erlZR9qIn0,2939
+algomancy_quickstart/templates/assets/CQM-logo-white.png,sha256=3gQOJO-2NZXFDciBpUuRqyIBILaPCrPkwmQ0OvVDB3A,4272
+algomancy_quickstart/templates/assets/cqm-button-white.png,sha256=1w0v0Dxdf4zWu__dnUurTnCoYQxkHwcTitnstNx_sGI,2568
+algomancy_quickstart/templates/assets/cqm-button.png,sha256=qydn5osgNQt6VQZzSRkITAtz4RVe9FD2SOTzNIljhbE,4624
+algomancy_quickstart/templates/assets/cqm-logo.png,sha256=wstnl0oDmLd92FB_hUTOYz7VNlDoeSWccBUKaqzHUV4,16635
+algomancy_quickstart/templates/assets/css/button_colors.css,sha256=kMPAC34vA81pOwnzUq03Q6SRdagM7fofMkJ7ueGNbDA,9958
+algomancy_quickstart/templates/assets/css/cqm_loader.css,sha256=Waw7DqwbCZRsLOsojO8jHGg89JTQV9j3G4wBRHk--dM,1083
+algomancy_quickstart/templates/assets/css/sidebar_layout.css,sha256=60ABlc3WWAJFBaC0fz33yNa153xjffc15aYI-m-LM0o,4633
+algomancy_quickstart/templates/assets/css/theme_colors.css,sha256=SoC4GI_gDRbj0BTHNSpwPP3Z2StITndyY3NRLMiuTfY,3837
+algomancy_quickstart/templates/assets/letter-c.svg,sha256=UU7rgZv5NF_bua40UVuR44vXmcdNkDNmhFmeEHTTNqI,1517
+algomancy_quickstart/templates/assets/letter-m.svg,sha256=f8KBaGB7xYKzbphLzZ6pRQPP9YLYCRMKAa56_WwPrwQ,1088
+algomancy_quickstart/templates/assets/letter-q.svg,sha256=CeblGH9pBFVBeNbAF-yIUCasT82aLLRobWnQjTksqWc,2537
+algomancy_quickstart/templates/assets/letters/letter-c.png,sha256=ilVzEhwie96GCof3ZUGeJgXBiOy_mvZ9EQUj0yOSqVo,885
+algomancy_quickstart/templates/assets/letters/letter-m.png,sha256=Ykgp3dSskUZ73LcpC4-7eB0IKR6UzuO919sb4ZsMLUc,816
+algomancy_quickstart/templates/assets/letters/letter-q.png,sha256=d18O-OM6W1kBa018sLDO4vePLiEyyfCv_FNz-48zawo,1182
+algomancy_quickstart/templates/assets/pepsi_girl.jpeg,sha256=NcyYHrJqOzE71kCCC-je1UW2N27TE9tiGc2U9sWj3v0,120365
+algomancy_quickstart/templates/assets/style.css,sha256=DT3XG1_Y_ixHclKEHeLlPIRowE38ZeAXwImzDG5p-Ic,10437
+algomancy_quickstart/templates/compare_page.py.jinja,sha256=KkB2BNceWTA-5Bv47lGfFKKnHRzMF7y4O2Spa_DUC7A,4257
+algomancy_quickstart/templates/data_page.py.jinja,sha256=v-fMVxbJGrmUPZ6Onfvv0Vk_yz0roWg0IZK82ALY2MQ,3222
+algomancy_quickstart/templates/etl_factory.py.jinja,sha256=9WsjfTgku3JCnclOULFvGQGjDrOsUxlQELSPw6IwRFU,3995
+algomancy_quickstart/templates/etl_factory_generated.py.jinja,sha256=04aehW46U2H29EeAdOLaWHA7Tl7cilruD7t_h9eqNaI,2980
+algomancy_quickstart/templates/generated_schemas.py.jinja,sha256=jnQNy3AC5bNrZ4pm-CxrcODrDR37zUquKnRCf6NVh7k,2210
+algomancy_quickstart/templates/home_page.py.jinja,sha256=MrXX_npwmpckg5x0tQc3XQOM_fMLHbyYL9iNTRjYz0c,2065
+algomancy_quickstart/templates/kpi.py.jinja,sha256=bjZYXUDr3s5aG11dwGOY-KiELqn8Fq0YWIhjIda_hs8,2172
+algomancy_quickstart/templates/main.py.jinja,sha256=gwTGiI4JT9rVCDMdw8-d-cgCLFxQi2U36HLvpS7mlbM,1536
+algomancy_quickstart/templates/main_custom.py.jinja,sha256=A_aM7IOx9MrJryT6UkXism1EsGyZwU8DSOeFneDSSn4,2425
+algomancy_quickstart/templates/main_generated_etl.py.jinja,sha256=eF87zojh9J6qvY9I7Lzph32Hg0hF5kIRmB-fiYPPnkY,3049
+algomancy_quickstart/templates/main_with_styling.py.jinja,sha256=boizDi88pCpRtPKtdcdYcZIuKR3yzxWgYTjD1_pbbYo,3298
+algomancy_quickstart/templates/overview_page.py.jinja,sha256=vRxMPhg_I0evArizCRrI33oI6rx9ffpnkyS2o6DivBg,3604
+algomancy_quickstart/templates/scenario_page.py.jinja,sha256=_s9BvCa0oRSKX0BfjlERisQ_h8oE0sUu_X0T7avf9_8,2592
+algomancy_quickstart/templates/schema.py.jinja,sha256=8Q4SJ3VTzuY1LdKgV_W1QghmthYxDSJqpaoG0jAF32Y,2031
+algomancy_quickstart/templates/styling_config.py.jinja,sha256=BUv9iXSO_asS5aHtb-vNb75U1WUiCVHPi6jpRzQIhpc,1587
+algomancy_quickstart-0.7.0.dist-info/WHEEL,sha256=Q9FtwzuR2QE37l-JIkuyklGnJJiCBHKnsPVQ9vzCMzQ,81
+algomancy_quickstart-0.7.0.dist-info/METADATA,sha256=kkViyrshXu_lBEtN07LkMpi30hVundQro0RMF5Awm6g,772
+algomancy_quickstart-0.7.0.dist-info/RECORD,,

algomancy_quickstart-0.7.0.dist-info/WHEEL

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