paramify 0.1.4__tar.gz

paramify-0.1.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 LuxAI S.A.
+
+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.

paramify-0.1.4/MANIFEST.in

@@ -0,0 +1,4 @@
+include README.md
+include LICENSE
+recursive-include paramify/static *
+recursive-include examples *

paramify-0.1.4/PKG-INFO

@@ -0,0 +1,281 @@
+Metadata-Version: 2.2
+Name: paramify
+Version: 0.1.4
+Summary: A lightweight Python library for dynamic parameter management and runtime configuration.
+Home-page: https://github.com/luxai-qtrobot/paramify
+Author: Ali PAikan
+Author-email: ali.paikan@gmail.com
+License: MIT
+Project-URL: Documentation, https://github.com/luxai-qtrobot/paramify#readme
+Project-URL: Source, https://github.com/luxai-qtrobot/paramify
+Project-URL: Tracker, https://github.com/luxai-qtrobot/paramify/issues
+Keywords: parameter management configuration dynamic runtime UI
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Requires-Python: >=3.7
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Flask>=2.0.0
+Requires-Dist: pydantic>=1.10.0
+Requires-Dist: ruamel.yaml>=0.17.0
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: project-url
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+
+# Paramify
+
+![Test Status](https://github.com/luxai-qtrobot/paramify/actions/workflows/python-tests.yml/badge.svg)
+
+**Paramify** is a lightweight Python library designed to simplify dynamic parameter management. It allows developers to define, validate, and manage parameters dynamically using a JSON or YAML schema, with optional support for **command-line integration** and a **web-based parameter configuration**.
+
+---
+
+## Key Features
+
+- **Dynamic Parameter Management**: Easily define and manage parameters using a simple JSON schema.
+- **Command-Line Integration**: Automatically generate CLI arguments using `argparser` based on your configuration, allowing runtime overrides without separate definitions.
+- **Web Interface**: Expose parameters through a user-friendly Flask-based UI for runtime configuration.
+- **Validation**: Automatically validate parameters with the help of Pydantic.
+- **Custom Callbacks**: Define optional callbacks to handle updates to specific parameters.
+- **JSON/YAML Integration**: Load and manage parameters directly from JSON or YAML files for flexible configurations.
+- **Scope-Based Control:** Specify a parameter's scope as `"runtime"`, `"cli"` and `"all"`
+- **Extensible**: Developers can extend the base class to add custom behaviors.
+
+
+Here is an example of the Paramify web interface:
+
+![Paramify Web UI](https://github.com/luxai-qtrobot/paramify/raw/main/assets/ui-screenshot.png)
+
+---
+
+## Installation
+
+To install Paramify, use the following command:
+
+```bash
+pip install paramify
+```
+
+---
+
+## Quick Start
+
+### 1. Programmatic Parameter Management
+
+Below is an example of using Paramify for managing parameters dynamically:
+
+```python
+from logger import Logger
+from paramify.paramify import Paramify
+
+# Define optional callback functions
+class MyApp(Paramify):    
+    def on_param1_set(self, value):
+        Logger.info(f"param1 was updated to {value}")
+
+    def on_param2_set(self, value):
+        Logger.info(f"param2 was updated to {value}")
+
+
+if __name__ == '__main__':
+    params = {
+        "parameters": [
+            {"name": "param1", "type": "bool", "label": "Enable Feature", "default": True},
+            {"name": "param2", "type": "int", "label": "Integer Value", "default": 4},
+        ]
+    }
+
+    app = MyApp(params)
+
+    # Access default or loaded values
+    Logger.info(app.parameters.param1)
+    Logger.info(app.parameters.param2)
+
+    # Update values and trigger callbacks
+    app.set_param1(False)
+    app.set_param2(23)
+
+    # View current parameters
+    Logger.info(app.get_parameters())
+```
+
+This example demonstrates how to define parameters, set values programmatically, and trigger custom callbacks.
+
+---
+
+### 2. Web-Based Parameter Management
+
+Below is an example of using **ParamifyWeb** to expose parameters through a web interface:
+
+```python
+import json
+from logger import Logger
+from paramify.paramify_web import ParamifyWeb
+
+# Define optional callback functions
+class MyApp(ParamifyWeb):
+    def on_param1_set(self, value):
+        Logger.info(f"Boolean parameter was updated to {value}")
+
+    def on_param2_set(self, value):
+        Logger.info(f"Integer parameter was updated to {value}")
+
+    def on_param3_set(self, value):
+        Logger.info(f"Float parameter was updated to {value}")
+
+    def on_param4_set(self, value):
+        Logger.info(f"Selectable parameter was updated to {value}")
+
+    def on_param5_set(self, value):
+        Logger.info(f"List parameter was updated to {value}")
+
+    def on_param6_set(self, value):
+        Logger.info(f"Simple string was updated to {value}")
+
+    def on_param7_set(self, value):
+        Logger.info(f"Text area value was updated to {value}")
+
+
+if __name__ == '__main__':    
+    # Initialize the app with parameters from a YAML file
+    app = MyApp('config.yaml')
+
+    # Prevent the script from exiting immediately
+    input("Press Enter to continue...")
+```
+
+This example demonstrates how to load parameters from a YAML file and expose them via a web interface. Callback functions are triggered when parameters are updated.
+
+---
+
+## YAML Configuration Example
+
+Here is an example of a JSON configuration file:
+```yaml
+name: "My Example App"
+description: "This is an example app to demonstrate the usage of Paramify"
+parameters:
+  - name: "param1"
+    type: "bool"
+    label: "Enable Feature"
+    description: "A boolean parameter to enable or disable a feature."
+    default: true
+    scope: "all" # cli, runtime, all    
+
+  - name: "param2"
+    type: "int"
+    label: "Integer Value"
+    description: "An integer parameter for numeric configuration."
+    default: 4
+    ui:
+      element: "slider"
+      min: 1
+      max: 10
+
+  - name: "param3"
+    type: "str"
+    label: "Select Option"
+    description: "A parameter to select from predefined options."
+    default: "option 2"
+    ui:
+      element: "select"
+      items:
+        - "option 1"
+        - "option 2"
+        - "option 3"
+
+```
+
+## JSON Configuration Example
+
+Here is an example of a JSON configuration file:
+
+```json
+{
+    "name": "My Example App",
+    "description": "This is an example app to demonstrate the usage of Paramify",
+    "parameters": [
+        {
+            "name": "param1",
+            "type": "bool",
+            "label": "Enable Feature",
+            "description": "A boolean parameter to enable or disable a feature.",
+            "default": true
+        },
+        {
+            "name": "param2",
+            "type": "int",
+            "label": "Integer Value",
+            "description": "An integer parameter for numeric configuration.",
+            "default": 4,
+            "ui": {"element": "slider", "min": 1, "max": 10}
+        },
+        {
+            "name": "param3",
+            "type": "str",
+            "label": "Select Option",
+            "description": "A parameter to select from predefined options.",
+            "default": "option 2",
+            "ui": {"element": "select", "items": ["option 1", "option 2", "option 3"]}
+        }
+    ]
+}
+```
+
+---
+
+## Command-Line Integration
+Paramify automatically generates CLI arguments based on your parameter schema, eliminating the need for separate argument definitions. Parameters defined with scope: `"cli"` or scope: `"all"` (it is the default) are included in the command-line interface, allowing users to override default values directly from the terminal.
+
+Here is an example of the generated CLI for a simple application using Paramify:
+
+```bash
+usage: simple_params_web.py [-h] [--param1] [--param2 PARAM2] [--param3 PARAM3]
+
+This is an example app to demonstrate the usage of Paramify
+
+options:
+  -h, --help            show this help message and exit
+  --param1              A boolean parameter to enable or disable a feature.
+  --param2 PARAM2       An integer parameter for numeric configuration.
+  --param3 PARAM3       A parameter to select from predefined options.
+```
+
+---
+
+## Features Overview
+
+- **Ease of Use**: Simple, human-readable JSON schema for parameter definitions.
+- **Web UI**: Manage and modify parameters in real-time through a web interface.
+- **Custom Logic**: Implement application-specific callbacks for parameters.
+- **JSON/YAML Support**: Load configurations from external JSON or YAML files for flexibility.
+
+---
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests to improve this library.
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.

paramify-0.1.4/README.md

@@ -0,0 +1,240 @@
+
+# Paramify
+
+![Test Status](https://github.com/luxai-qtrobot/paramify/actions/workflows/python-tests.yml/badge.svg)
+
+**Paramify** is a lightweight Python library designed to simplify dynamic parameter management. It allows developers to define, validate, and manage parameters dynamically using a JSON or YAML schema, with optional support for **command-line integration** and a **web-based parameter configuration**.
+
+---
+
+## Key Features
+
+- **Dynamic Parameter Management**: Easily define and manage parameters using a simple JSON schema.
+- **Command-Line Integration**: Automatically generate CLI arguments using `argparser` based on your configuration, allowing runtime overrides without separate definitions.
+- **Web Interface**: Expose parameters through a user-friendly Flask-based UI for runtime configuration.
+- **Validation**: Automatically validate parameters with the help of Pydantic.
+- **Custom Callbacks**: Define optional callbacks to handle updates to specific parameters.
+- **JSON/YAML Integration**: Load and manage parameters directly from JSON or YAML files for flexible configurations.
+- **Scope-Based Control:** Specify a parameter's scope as `"runtime"`, `"cli"` and `"all"`
+- **Extensible**: Developers can extend the base class to add custom behaviors.
+
+
+Here is an example of the Paramify web interface:
+
+![Paramify Web UI](https://github.com/luxai-qtrobot/paramify/raw/main/assets/ui-screenshot.png)
+
+---
+
+## Installation
+
+To install Paramify, use the following command:
+
+```bash
+pip install paramify
+```
+
+---
+
+## Quick Start
+
+### 1. Programmatic Parameter Management
+
+Below is an example of using Paramify for managing parameters dynamically:
+
+```python
+from logger import Logger
+from paramify.paramify import Paramify
+
+# Define optional callback functions
+class MyApp(Paramify):    
+    def on_param1_set(self, value):
+        Logger.info(f"param1 was updated to {value}")
+
+    def on_param2_set(self, value):
+        Logger.info(f"param2 was updated to {value}")
+
+
+if __name__ == '__main__':
+    params = {
+        "parameters": [
+            {"name": "param1", "type": "bool", "label": "Enable Feature", "default": True},
+            {"name": "param2", "type": "int", "label": "Integer Value", "default": 4},
+        ]
+    }
+
+    app = MyApp(params)
+
+    # Access default or loaded values
+    Logger.info(app.parameters.param1)
+    Logger.info(app.parameters.param2)
+
+    # Update values and trigger callbacks
+    app.set_param1(False)
+    app.set_param2(23)
+
+    # View current parameters
+    Logger.info(app.get_parameters())
+```
+
+This example demonstrates how to define parameters, set values programmatically, and trigger custom callbacks.
+
+---
+
+### 2. Web-Based Parameter Management
+
+Below is an example of using **ParamifyWeb** to expose parameters through a web interface:
+
+```python
+import json
+from logger import Logger
+from paramify.paramify_web import ParamifyWeb
+
+# Define optional callback functions
+class MyApp(ParamifyWeb):
+    def on_param1_set(self, value):
+        Logger.info(f"Boolean parameter was updated to {value}")
+
+    def on_param2_set(self, value):
+        Logger.info(f"Integer parameter was updated to {value}")
+
+    def on_param3_set(self, value):
+        Logger.info(f"Float parameter was updated to {value}")
+
+    def on_param4_set(self, value):
+        Logger.info(f"Selectable parameter was updated to {value}")
+
+    def on_param5_set(self, value):
+        Logger.info(f"List parameter was updated to {value}")
+
+    def on_param6_set(self, value):
+        Logger.info(f"Simple string was updated to {value}")
+
+    def on_param7_set(self, value):
+        Logger.info(f"Text area value was updated to {value}")
+
+
+if __name__ == '__main__':    
+    # Initialize the app with parameters from a YAML file
+    app = MyApp('config.yaml')
+
+    # Prevent the script from exiting immediately
+    input("Press Enter to continue...")
+```
+
+This example demonstrates how to load parameters from a YAML file and expose them via a web interface. Callback functions are triggered when parameters are updated.
+
+---
+
+## YAML Configuration Example
+
+Here is an example of a JSON configuration file:
+```yaml
+name: "My Example App"
+description: "This is an example app to demonstrate the usage of Paramify"
+parameters:
+  - name: "param1"
+    type: "bool"
+    label: "Enable Feature"
+    description: "A boolean parameter to enable or disable a feature."
+    default: true
+    scope: "all" # cli, runtime, all    
+
+  - name: "param2"
+    type: "int"
+    label: "Integer Value"
+    description: "An integer parameter for numeric configuration."
+    default: 4
+    ui:
+      element: "slider"
+      min: 1
+      max: 10
+
+  - name: "param3"
+    type: "str"
+    label: "Select Option"
+    description: "A parameter to select from predefined options."
+    default: "option 2"
+    ui:
+      element: "select"
+      items:
+        - "option 1"
+        - "option 2"
+        - "option 3"
+
+```
+
+## JSON Configuration Example
+
+Here is an example of a JSON configuration file:
+
+```json
+{
+    "name": "My Example App",
+    "description": "This is an example app to demonstrate the usage of Paramify",
+    "parameters": [
+        {
+            "name": "param1",
+            "type": "bool",
+            "label": "Enable Feature",
+            "description": "A boolean parameter to enable or disable a feature.",
+            "default": true
+        },
+        {
+            "name": "param2",
+            "type": "int",
+            "label": "Integer Value",
+            "description": "An integer parameter for numeric configuration.",
+            "default": 4,
+            "ui": {"element": "slider", "min": 1, "max": 10}
+        },
+        {
+            "name": "param3",
+            "type": "str",
+            "label": "Select Option",
+            "description": "A parameter to select from predefined options.",
+            "default": "option 2",
+            "ui": {"element": "select", "items": ["option 1", "option 2", "option 3"]}
+        }
+    ]
+}
+```
+
+---
+
+## Command-Line Integration
+Paramify automatically generates CLI arguments based on your parameter schema, eliminating the need for separate argument definitions. Parameters defined with scope: `"cli"` or scope: `"all"` (it is the default) are included in the command-line interface, allowing users to override default values directly from the terminal.
+
+Here is an example of the generated CLI for a simple application using Paramify:
+
+```bash
+usage: simple_params_web.py [-h] [--param1] [--param2 PARAM2] [--param3 PARAM3]
+
+This is an example app to demonstrate the usage of Paramify
+
+options:
+  -h, --help            show this help message and exit
+  --param1              A boolean parameter to enable or disable a feature.
+  --param2 PARAM2       An integer parameter for numeric configuration.
+  --param3 PARAM3       A parameter to select from predefined options.
+```
+
+---
+
+## Features Overview
+
+- **Ease of Use**: Simple, human-readable JSON schema for parameter definitions.
+- **Web UI**: Manage and modify parameters in real-time through a web interface.
+- **Custom Logic**: Implement application-specific callbacks for parameters.
+- **JSON/YAML Support**: Load configurations from external JSON or YAML files for flexibility.
+
+---
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests to improve this library.
+
+---
+
+## License
+
+This project is licensed under the MIT License. See the `LICENSE` file for details.

paramify-0.1.4/examples/config.json

@@ -0,0 +1,60 @@
+{
+    "name": "My Example App",
+    "description": "This is an example app to demonstrate the usage of ParamifyWeb",
+    "parameters": [
+        {
+            "name": "param1",
+            "type": "bool",
+            "label": "Enable Feature",
+            "description": "A boolean parameter to enable or disable a feature.",
+            "default": true,
+            "scope": "runtime"
+        },
+        {
+            "name": "param2",
+            "type": "int",
+            "label": "Integer Value",
+            "description": "An integer parameter for numeric configuration.",
+            "default": 4,
+            "ui": {"element": "slider", "min": 1, "max": 10}
+        },
+        {
+            "name": "param3",
+            "type": "float",
+            "label": "Floating Point Value",
+            "description": "A float parameter for precision configuration.",
+            "default": 7.5
+        },
+        {
+            "name": "param4",
+            "type": "str",
+            "label": "Select Option",
+            "description": "A parameter to select from predefined options.",
+            "default": "option 2",
+            "ui": {"element": "select", "items": ["option 1", "option 2", "option 3"]}
+        },
+        {
+            "name": "param5",
+            "type": "list",
+            "label": "List of Values",
+            "description": "A parameter to manage a list of strings.",
+            "default": ["value 1", "value 2"],
+            "ui": {"create": true}
+        },
+        {
+            "name": "param6",
+            "type": "str",
+            "label": "Simple String",
+            "description": "A simple string parameter.",
+            "default": "Hello Paramify"
+        },
+        {
+            "name": "param7",
+            "type": "str",
+            "label": "Text Area",
+            "description": "A long text input parameter.",
+            "default": "",
+            "ui": {"element": "textarea"}
+        }
+    ]
+}

paramify-0.1.4/examples/config.yaml

@@ -0,0 +1,62 @@
+name: "My Example App"
+description: "This is an example app to demonstrate the usage of ParamifyWeb"
+parameters:
+  - name: "param1"
+    type: "bool"
+    label: "Enable Feature"
+    description: "A boolean parameter to enable or disable a feature."
+    default: true
+    scope: "all" # cli, runtime, all    
+
+  - name: "param2"
+    type: "int"
+    label: "Integer Value"
+    description: "An integer parameter for numeric configuration."
+    default: 4
+    ui:
+      element: "slider"
+      min: 1
+      max: 10
+
+  - name: "param3"
+    type: "float"
+    label: "Floating Point Value"
+    description: "A float parameter for precision configuration."
+    default: 7.5
+
+  - name: "param4"
+    type: "str"
+    label: "Select Option"
+    description: "A parameter to select from predefined options."
+    default: "option 2"
+    ui:
+      element: "select"
+      items:
+        - "option 1"
+        - "option 2"
+        - "option 3"
+
+  - name: "param5"
+    type: "list"
+    label: "List of Values"
+    description: "A parameter to manage a list of strings."
+    default:
+      - "value 1"
+      - "value 2"
+    ui:
+      create: true
+
+  - name: "param6"
+    type: "str"
+    label: "Simple String"
+    description: "A simple string parameter."
+    default: "Hello Paramify"
+
+  - name: "param7"
+    type: "str"
+    label: "Text Area"
+    description: "A long text input parameter."
+    default: ""
+    ui:
+      element: "textarea"
+