mindtrace-core 0.1.0__tar.gz

mindtrace_core-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+   

mindtrace_core-0.1.0/PKG-INFO

@@ -0,0 +1,13 @@
+Metadata-Version: 2.4
+Name: mindtrace-core
+Version: 0.1.0
+Summary: Core functionality for Mindtrace
+Author: Mindtrace Team
+License-Expression: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+License-File: LICENSE
+Requires-Dist: pillow>=11.2.1
+Requires-Dist: pydantic>=2.11.1
+Requires-Dist: tqdm>=4.67.1
+Dynamic: license-file

mindtrace_core-0.1.0/README.md

@@ -0,0 +1,220 @@
+# Mindtrace Core
+
+The foundational module of the Mindtrace ML framework, providing essential utilities, base classes, and core abstractions used across all other Mindtrace modules.
+
+## Purpose
+
+`mindtrace-core` serves as the foundation layer (Level 1) in the Mindtrace architecture, offering:
+
+- **Base Classes**: Abstract base classes and metaclasses for consistent architecture
+- **Configuration Management**: Centralized configuration handling
+- **Event System**: Observable patterns and event bus for inter-component communication
+- **Utilities**: Common utility functions for dynamic imports, type checking, and more
+- **Logging**: Structured logging capabilities
+
+## Installation
+
+```bash
+# Install as standalone package
+uv add mindtrace-core
+
+# Or install as part of full Mindtrace
+uv add mindtrace
+```
+
+## Architecture
+
+The core module is organized into several submodules:
+
+### Base Classes (`base/`)
+- `MindtraceABC`: Abstract base class for all Mindtrace components
+- `MindtraceMeta`: Metaclass providing common functionality
+- `Mindtrace`: Main base class with core functionality
+
+### Configuration (`config/`)
+- `Config`: Centralized configuration management system
+
+### Observables (`observables/`)
+- `EventBus`: Publish-subscribe event system
+- `ObservableContext`: Context management with observation capabilities
+- `ContextListener`: Event listening and handling
+
+### Utilities (`utils/`)
+- `checks`: Type checking and validation utilities
+- `dynamic`: Dynamic class instantiation and import helpers
+
+### Logging (`logging/`)
+- Structured logging configuration and utilities
+
+## API Reference
+
+### Core Classes
+
+#### `Mindtrace`
+Base class for all Mindtrace components.
+
+```python
+class MyProcessor(Mindtrace):
+    def __init__(self):
+        super().__init__()
+```
+
+#### `Config`
+Configuration management with validation and defaults.
+
+```python
+config = Config({
+    "param1": "value1",
+    "param2": 42
+})
+```
+
+### Observables
+
+The Observables module enables lightweight observability and reactivity for class objects, automatically turning selected properties into observable variables. This framework allows external components (listeners) to be notified whenever specific values change, without hard-coding the coupling between the source and observers.
+
+There are three main classes included in the `observables` module:
+
+---
+
+### 1. `EventBus`
+
+The `EventBus` is a lightweight internal publish-subscribe system for event dispatching. 
+
+**API:**
+
+Event buses expose three main methods, which may be used to `subscribe`/`unsubscribe` individual listeners and `emit` event messages.
+
+```python
+subscribe(handler: Callable, event_name: str) -> str
+unsubscribe(handler_or_id: Union[str, Callable], event_name: str)
+emit(event_name: str, **kwargs)
+```
+
+**Example Usage:**
+To use an event bus, subscribe a handler to the bus with an associated event name. The handler will be called any time the event name is emitted. 
+
+```python
+from mindtrace.core import EventBus
+
+bus = EventBus()    
+
+def handler(**kwargs):
+    print(kwargs)
+
+bus.subscribe(handler, "event")
+bus.emit("event", x="1", y="2")  # {'x': '1', 'y': '2'}
+
+bus.unsubscribe(handler, "event")
+bus.emit("event", x="1", y="2")  # No output
+```
+
+---
+
+### 2. `ObservableContext`
+
+The `ObservableContext` class decorator automatically turns specified properties into observable fields and wires up listener support.
+
+The `ObservableContext` class supports two specific event types, with associated event names:
+
+1. `context_updated(source: str, var: str, old: any, new: any)`: May be used when _any_ observed variable changes. The name of the variable will be given as the `var` argument, with associated old and new values.
+2. `{var}_updated(source: str, old: any, new: any)`: May be used to listen to specific variables. 
+
+**API:**
+
+The `ObservableContext` decorator adds `subscribe` and `unsubscribe` methods onto a wrapped class, which may be used directly analogously to with the `EventBus`.
+
+```python
+subscribe(handler, event_name)
+unsubscribe(handler_or_id, event_name)
+```
+
+**Example Usage:**
+
+When subscribing a class-derived listener, define a `context_updated` method which will be notified anytime any observable variable is updated, or specific `{var}_updated` methods, which will be notified when the associated variable is updated.
+
+```python
+class MyListener:
+    def context_updated(self, source, var, old, new):  # May be omitted, `{var}_updated` methods will be called automatically
+        if var == "x":
+            return self.x_updated(source, old, new)
+        elif var == "y":
+            return self.y_updated(source, old, new)
+    def x_updated(...): ...
+    def y_updated(...): ...
+```
+
+Listeners may subscribe to any class that has been decorated with the `ObservableContext` decorator, listening to any of the listed `vars` in the decorator.
+
+```python
+from mindtrace.core import ObservableContext
+
+@ObservableContext(vars=["x", "y"])
+class MyContext:
+    def __init__(self):
+        self.x = 0
+        self.y = 0
+
+class MyListener:
+    def x_changed(self, source, old, new):
+        print(f"[{source}] x changed from {old} to {new}")
+
+my_context = MyContext()
+my_context.subscribe(MyListener())
+
+my_context.x = 1  # [MyContext] x changed from 0 to 1
+```
+
+---
+
+### 3. `ContextListener(Mindtrace)`
+
+The `ContextListener` class is a helper class for defining observers that respond to context changes. This class is meant to provide two benefits: (1) deriving from the `Mindtrace` base class, it provides for uniform logging of events and (2) the default ContextListener class can be used to automatically log changes to variables, optionally with a custom logger.
+
+**Example usage:**
+```python
+from mindtrace.core import ContextListener, ObservableContext
+
+@ObservableContext(vars={"x": int, "y": int})
+class MyContext:
+    def __init__(self):
+        self.x = 0
+        self.y = 0
+
+my_context = MyContext()
+my_context.subscribe(ContextListener(autolog=["x", "y"], logger=...))  # May provide custom logger if desired
+
+my_context.x = 1
+my_context.y = 2
+
+# Logs:
+# [MyContext] x changed: 0 → 1
+# [MyContext] y changed: 0 → 2  
+```
+
+### Utility Functions
+
+#### `check_libs(*libs)`
+Verify required libraries are installed.
+
+```python
+from mindtrace.core import check_libs
+check_libs("numpy", "pandas")  # Raises ImportError if missing
+```
+
+#### `ifnone(value, default)`
+Return default if value is None.
+
+```python
+from mindtrace.core import ifnone
+result = ifnone(potentially_none_value, "default")
+```
+
+#### `instantiate_target(target, **kwargs)`
+Dynamically instantiate a class from string reference.
+
+```python
+from mindtrace.core import instantiate_target
+instance = instantiate_target("my.module.MyClass", param="value")
+```
+

mindtrace_core-0.1.0/mindtrace/core/__init__.py

@@ -0,0 +1,34 @@
+from mindtrace.core.base import Mindtrace, MindtraceABC, MindtraceMeta
+from mindtrace.core.config import Config
+from mindtrace.core.logging.logger import setup_logger
+from mindtrace.core.observables.context_listener import ContextListener
+from mindtrace.core.observables.event_bus import EventBus
+from mindtrace.core.observables.observable_context import ObservableContext
+from mindtrace.core.types.task_schema import TaskSchema
+from mindtrace.core.utils.checks import check_libs, first_not_none, ifnone, ifnone_url
+from mindtrace.core.utils.dynamic import get_class, instantiate_target
+from mindtrace.core.utils.lambdas import named_lambda
+from mindtrace.core.utils.timers import Timeout, Timer, TimerCollection
+
+setup_logger()  # Initialize the default logger
+
+__all__ = [
+    "check_libs",
+    "ContextListener",
+    "Config",
+    "EventBus",
+    "first_not_none",
+    "get_class",
+    "ifnone",
+    "ifnone_url",
+    "instantiate_target",
+    "Mindtrace",
+    "MindtraceABC",
+    "MindtraceMeta",
+    "named_lambda",
+    "ObservableContext",
+    "TaskSchema",
+    "Timer",
+    "TimerCollection",
+    "Timeout",
+]

mindtrace_core-0.1.0/mindtrace/core/base/__init__.py

@@ -0,0 +1,7 @@
+from mindtrace.core.base.mindtrace_base import Mindtrace, MindtraceABC, MindtraceMeta
+
+__all__ = [
+    "Mindtrace",
+    "MindtraceABC",
+    "MindtraceMeta",
+]