botflow-gui 0.0.1__tar.gz

botflow_gui-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Fernando Luiz Fontes
+
+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.

botflow_gui-0.0.1/PKG-INFO

@@ -0,0 +1,100 @@
+Metadata-Version: 2.4
+Name: botflow-gui
+Version: 0.0.1
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pyside6>=6.9.1
+Provides-Extra: dev
+Requires-Dist: ruff==0.6; extra == "dev"
+Requires-Dist: pytest==9.0.2; extra == "dev"
+Requires-Dist: pyinstaller==6.17.0; extra == "dev"
+Dynamic: license-file
+
+# Botflow
+
+Botflow is a lightweight Python framework for building automation workflows and bots with a focus on simplicity, modularity, and ease of integration.
+
+## Features
+
+- **Workflow Management**: Define complex bot workflows with simple, declarative syntax
+- **Multi-language Support**: Built-in i18n support with locale management
+- **Resource Management**: Centralized handling of themes, assets, and locales
+- **Bundle Support**: PyInstaller integration for creating standalone executables
+- **Qt Integration**: PySide6 support for GUI-based automation
+- **Configuration**: Flexible runtime configuration with environment variables
+
+## Quick Start
+
+1. Install Botflow via pip:
+
+   ```bash
+   pip install botflow
+   ```
+
+2. Create a simple bot workflow:
+
+   ```python
+   from botflow import run_application, run_flow_manager, FlowManager, TextStepSpec, FlowSpec
+
+    RESOURCES_DIR = 'resources'
+
+
+    async def greet_user(ctx):
+        name = ctx.data.get('greet_step')
+        ctx.logger.info(f'Hello, {name}!')
+
+
+    flow = FlowSpec(
+        name='simple_flow',
+        steps=[
+            TextStepSpec(
+                key='greet_step',
+                title='Greet User',
+                placeholder='Enter your name',
+            ),
+        ],
+        on_finish=[greet_user]
+    )
+
+
+    if __name__ == '__main__':
+        run_application()
+        flow_manager = FlowManager(flow)
+        run_flow_manager(flow_manager, window_title='Simple Flow Manager')
+    ```
+
+3. Run your bot:
+
+    ```bash
+    python your_bot_script.py
+    ```
+
+## How to create a bundle
+
+To create a standalone executable bundle of your Botflow application, you can use PyInstaller. Follow these steps:
+
+1. Install PyInstaller:
+
+   ```bash
+   pip install pyinstaller
+   ```
+
+2. Create a spec file for your application. You can generate a default spec file using:
+
+   ```bash
+   pyinstaller your_bot_script.py
+   ```
+
+3. If you are using your own resources (like themes, locales, etc.), make sure to include them in the spec file. You can modify the `datas` section of the spec file to include your resources directory:
+
+   ```bash
+   pyinstaller your_bot_script.py --add-data "path/to/your/resources:resources"
+   ```
+
+4. If you want to specify a custom resources directory for your bundle, you can set the `BUNDLE_RESOURCES_DIR` variable in your main script:
+
+   ```python
+   BUNDLE_RESOURCES_DIR = 'path/to/your/bundle/resources'
+   ```
+

botflow_gui-0.0.1/README.md

@@ -0,0 +1,87 @@
+# Botflow
+
+Botflow is a lightweight Python framework for building automation workflows and bots with a focus on simplicity, modularity, and ease of integration.
+
+## Features
+
+- **Workflow Management**: Define complex bot workflows with simple, declarative syntax
+- **Multi-language Support**: Built-in i18n support with locale management
+- **Resource Management**: Centralized handling of themes, assets, and locales
+- **Bundle Support**: PyInstaller integration for creating standalone executables
+- **Qt Integration**: PySide6 support for GUI-based automation
+- **Configuration**: Flexible runtime configuration with environment variables
+
+## Quick Start
+
+1. Install Botflow via pip:
+
+   ```bash
+   pip install botflow
+   ```
+
+2. Create a simple bot workflow:
+
+   ```python
+   from botflow import run_application, run_flow_manager, FlowManager, TextStepSpec, FlowSpec
+
+    RESOURCES_DIR = 'resources'
+
+
+    async def greet_user(ctx):
+        name = ctx.data.get('greet_step')
+        ctx.logger.info(f'Hello, {name}!')
+
+
+    flow = FlowSpec(
+        name='simple_flow',
+        steps=[
+            TextStepSpec(
+                key='greet_step',
+                title='Greet User',
+                placeholder='Enter your name',
+            ),
+        ],
+        on_finish=[greet_user]
+    )
+
+
+    if __name__ == '__main__':
+        run_application()
+        flow_manager = FlowManager(flow)
+        run_flow_manager(flow_manager, window_title='Simple Flow Manager')
+    ```
+
+3. Run your bot:
+
+    ```bash
+    python your_bot_script.py
+    ```
+
+## How to create a bundle
+
+To create a standalone executable bundle of your Botflow application, you can use PyInstaller. Follow these steps:
+
+1. Install PyInstaller:
+
+   ```bash
+   pip install pyinstaller
+   ```
+
+2. Create a spec file for your application. You can generate a default spec file using:
+
+   ```bash
+   pyinstaller your_bot_script.py
+   ```
+
+3. If you are using your own resources (like themes, locales, etc.), make sure to include them in the spec file. You can modify the `datas` section of the spec file to include your resources directory:
+
+   ```bash
+   pyinstaller your_bot_script.py --add-data "path/to/your/resources:resources"
+   ```
+
+4. If you want to specify a custom resources directory for your bundle, you can set the `BUNDLE_RESOURCES_DIR` variable in your main script:
+
+   ```python
+   BUNDLE_RESOURCES_DIR = 'path/to/your/bundle/resources'
+   ```
+

botflow_gui-0.0.1/botflow/__init__.py

@@ -0,0 +1,53 @@
+from botflow.manager import FlowManager
+from botflow.types import FlowSpec
+from botflow.widgets import (
+    FileStepSpec,
+    FileWidget,
+    FormInput,
+    FormStepSpec,
+    FormWidget,
+    TextStepSpec,
+    TextWidget,
+)
+
+__all__ = [
+    'FlowManager',
+    'FileStepSpec',
+    'FileWidget',
+    'FormInput',
+    'FormStepSpec',
+    'FormWidget',
+    'TextStepSpec',
+    'TextWidget',
+    'FlowSpec',
+]
+
+import sys
+from pathlib import Path
+
+from PySide6.QtWidgets import QApplication
+
+
+def get_hook_dirs():
+    return [str(Path(__file__).resolve().with_name('__pyinstaller'))]
+
+
+def run_application():
+    app = QApplication.instance()
+    if not app:
+        app = QApplication(sys.argv)
+    return app
+
+
+def run_flow_manager(
+    flow_manager: FlowManager,
+    *,
+    width: int = 720,
+    height: int = 300,
+    window_title: str = 'Flow Manager',
+):
+    app = run_application()
+    flow_manager.resize(width, height)
+    flow_manager.setWindowTitle(window_title)
+    flow_manager.show()
+    sys.exit(app.exec())

botflow_gui-0.0.1/botflow/__pyinstaller/hook-botflow.py

@@ -0,0 +1,10 @@
+from pathlib import Path
+
+from PyInstaller.utils.hooks import get_module_file_attribute
+
+module_path = get_module_file_attribute('botflow')
+if module_path:
+    botflow_dir = Path(module_path).parent
+    datas = [(str(botflow_dir / 'resources'), 'lib_resources')]
+else:
+    datas = []

botflow_gui-0.0.1/botflow/exceptions.py

@@ -0,0 +1,4 @@
+class PipelineExceptedError(Exception):
+    def __init__(self, message: str, popup_message: str | None = None):
+        super().__init__(message)
+        self.popup_message = popup_message or message

botflow_gui-0.0.1/botflow/i18n.py

@@ -0,0 +1,57 @@
+import json
+from pathlib import Path
+from typing import Any
+
+from botflow.resolver import find_all_locales_dirs
+
+
+class I18n:
+    def __init__(self, catalog: dict[str, Any], lang: str, fallback_lang: str = 'en_US'):
+        self.catalog = catalog
+        self.lang = lang
+        self.fallback_lang = fallback_lang
+
+    def t(self, key: str, **params: Any) -> str:
+        loc = self.lang or self.fallback_lang
+
+        bucket = self.catalog.get(loc, {})
+        v = bucket.get(key)
+
+        if v is None and self.fallback_lang and self.fallback_lang != loc:
+            v = self.catalog.get(self.fallback_lang, {}).get(key)
+
+        if v is None:
+            raise KeyError(f'Missing translation key: {key} (lang={self.lang})')
+
+        if not isinstance(v, str):
+            return str(v)
+
+        return v.format(**params) if params else v
+
+    def set_lang(self, lang: str) -> None:
+        self.lang = lang
+
+    @staticmethod
+    def from_locales_dirs(lang: str):
+        locales_dirs = find_all_locales_dirs()
+        catalog: dict[str, dict[str, Any]] = {}
+
+        for locales_dir in locales_dirs if isinstance(locales_dirs, list) else [locales_dirs]:
+            for json_file in Path(locales_dir).glob('**/*.json'):
+                locale_name = json_file.parent.name
+
+                with open(json_file, 'r', encoding='utf-8') as f:
+                    data = json.load(f)
+
+                catalog.setdefault(locale_name, {})
+
+                if isinstance(data, dict):
+                    for v in data.values():
+                        if isinstance(v, dict):
+                            catalog[locale_name].update(v)
+
+                    for k, v in data.items():
+                        if isinstance(v, str):
+                            catalog[locale_name][k] = v
+
+        return I18n(catalog, lang)

botflow_gui-0.0.1/botflow/logger.py

@@ -0,0 +1,45 @@
+import logging
+from datetime import datetime as dt
+from logging.handlers import TimedRotatingFileHandler
+from pathlib import Path
+
+
+def configure_logger(
+    name: str = 'big_views',
+    log_dir: str | Path = './logs',
+    level: int = logging.INFO,
+    console: bool = True,
+    rotating_file: bool = True,
+) -> logging.Logger:
+    logger = logging.getLogger(name)
+    logger.setLevel(level)
+    logger.propagate = False
+
+    log_dir = Path(log_dir)
+    log_dir.mkdir(parents=True, exist_ok=True)
+
+    fmt = logging.Formatter('%(asctime)s - %(levelname)s - %(filename)s:%(lineno)d - %(message)s')
+
+    if rotating_file:
+        log_name = dt.now().strftime('%d-%m-%Y_%Hh-%Mm-%Ss')
+        log_path = log_dir / f'{log_name}.log'
+
+        file_handler = TimedRotatingFileHandler(
+            filename=str(log_path),
+            when='midnight',
+            interval=1,
+            backupCount=7,
+            encoding='utf-8',
+        )
+        file_handler.suffix = '%Y%m%d'
+        file_handler.setLevel(level)
+        file_handler.setFormatter(fmt)
+        logger.addHandler(file_handler)
+
+    if console:
+        console_handler = logging.StreamHandler()
+        console_handler.setLevel(level)
+        console_handler.setFormatter(fmt)
+        logger.addHandler(console_handler)
+
+    return logger