flock-core 0.4.0b27__py3-none-any.whl → 0.4.0b28__py3-none-any.whl

flock/core/flock_agent.py

@@ -208,7 +208,7 @@ class FlockAgent(BaseModel, Serializable, DSPyIntegrationMixin, ABC):
             )
             try:
                 for module in self.get_enabled_modules():
-                    await module.initialize(self, inputs, self.context)
+                    await module.on_initialize(self, inputs, self.context)
             except Exception as module_error:
                 logger.error(
                     "Error during initialize",
@@ -232,7 +232,9 @@ class FlockAgent(BaseModel, Serializable, DSPyIntegrationMixin, ABC):
             )
             try:
                 for module in self.get_enabled_modules():
-                    await module.terminate(self, inputs, result, self.context)
+                    await module.on_terminate(
+                        self, inputs, result, self.context
+                    )
 
                 if self.write_to_file:
                     self._save_output(self.name, result)
@@ -281,7 +283,7 @@ class FlockAgent(BaseModel, Serializable, DSPyIntegrationMixin, ABC):
 
             # Pre-evaluate hooks
             for module in self.get_enabled_modules():
-                current_inputs = await module.pre_evaluate(
+                current_inputs = await module.on_pre_evaluate(
                     self, current_inputs, self.context
                 )
 
@@ -312,7 +314,7 @@ class FlockAgent(BaseModel, Serializable, DSPyIntegrationMixin, ABC):
             # Post-evaluate hooks
             current_result = result
             for module in self.get_enabled_modules():
-                current_result = await module.post_evaluate(
+                current_result = await module.on_post_evaluate(
                     self, current_inputs, current_result, self.context
                 )
 

flock/core/flock_module.py

@@ -52,7 +52,7 @@ class FlockModule(BaseModel, ABC):
         default_factory=FlockModuleConfig, description="Module configuration"
     )
 
-    async def initialize(
+    async def on_initialize(
         self,
         agent: Any,
         inputs: dict[str, Any],
@@ -61,7 +61,7 @@ class FlockModule(BaseModel, ABC):
         """Called when the agent starts running."""
         pass
 
-    async def pre_evaluate(
+    async def on_pre_evaluate(
         self,
         agent: Any,
         inputs: dict[str, Any],
@@ -70,22 +70,22 @@ class FlockModule(BaseModel, ABC):
         """Called before agent evaluation, can modify inputs."""
         return inputs
 
-    async def post_evaluate(
+    async def on_post_evaluate(
         self,
         agent: Any,
         inputs: dict[str, Any],
-        result: dict[str, Any],
         context: FlockContext | None = None,
+        result: dict[str, Any] | None = None,
     ) -> dict[str, Any]:
         """Called after agent evaluation, can modify results."""
         return result
 
-    async def terminate(
+    async def on_terminate(
         self,
         agent: Any,
         inputs: dict[str, Any],
-        result: dict[str, Any],
         context: FlockContext | None = None,
+        result: dict[str, Any] | None = None,
     ) -> None:
         """Called when the agent finishes running."""
         pass
@@ -93,9 +93,9 @@ class FlockModule(BaseModel, ABC):
     async def on_error(
         self,
         agent: Any,
-        error: Exception,
         inputs: dict[str, Any],
         context: FlockContext | None = None,
+        error: Exception | None = None,
     ) -> None:
         """Called when an error occurs during agent execution."""
         pass

flock/modules/assertion/assertion_module.py

@@ -110,7 +110,7 @@ class AssertionCheckerModule(FlockModule):
                 # Proceed without judge LM for other rule types
         return self._judge_lm
 
-    async def post_evaluate(
+    async def on_post_evaluate(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],

flock/modules/callback/callback_module.py

@@ -57,7 +57,7 @@ class CallbackModule(FlockModule):
         if self.config.initialize_callback:
             await self.config.initialize_callback(agent, inputs)
 
-    async def pre_evaluate(
+    async def on_pre_evaluate(
         self,
         agent: Any,
         inputs: dict[str, Any],

flock/modules/memory/memory_module.py

@@ -83,7 +83,7 @@ class MemoryModule(FlockModule):
             else [{"type": "semantic"}]
         )
 
-    async def initialize(
+    async def on_initialize(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],
@@ -101,7 +101,7 @@ class MemoryModule(FlockModule):
         )
         logger.debug(f"Initialized memory module for agent {agent.name}")
 
-    async def pre_evaluate(
+    async def on_pre_evaluate(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],
@@ -226,7 +226,7 @@ class MemoryModule(FlockModule):
         except Exception as e:
             logger.warning(f"Memory storage failed: {e}", agent=agent.name)
 
-    async def post_evaluate(
+    async def on_post_evaluate(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],
@@ -245,7 +245,7 @@ class MemoryModule(FlockModule):
 
         return result
 
-    async def terminate(
+    async def on_terminate(
         self,
         agent: Any,
         inputs: dict[str, Any],

flock/modules/output/output_module.py

@@ -131,7 +131,7 @@ class OutputModule(FlockModule):
         )
         return text
 
-    async def post_evaluate(
+    async def on_post_evaluate(
         self,
         agent: "FlockAgent",
         inputs: dict[str, Any],

flock/modules/performance/metrics_module.py

@@ -227,7 +227,7 @@ class MetricsModule(FlockModule):
 
         return stats
 
-    async def terminate(
+    async def on_terminate(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],
@@ -340,7 +340,7 @@ class MetricsModule(FlockModule):
             return value * 1000 > self.config.latency_threshold_ms
         return False
 
-    async def initialize(
+    async def on_initialize(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],
@@ -382,7 +382,7 @@ class MetricsModule(FlockModule):
             total_cost = 0.0
             return token_count, total_cost
 
-    async def pre_evaluate(
+    async def on_pre_evaluate(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],
@@ -423,7 +423,7 @@ class MetricsModule(FlockModule):
 
         return inputs
 
-    async def post_evaluate(
+    async def on_post_evaluate(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],

flock/modules/zep/zep_module.py

@@ -141,7 +141,7 @@ class ZepModule(FlockModule):
             return []
         return response.results
 
-    async def post_evaluate(
+    async def on_post_evaluate(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],
@@ -158,7 +158,7 @@ class ZepModule(FlockModule):
         self.add_to_memory(str(result), zep_client)
         return result
 
-    async def pre_evaluate(
+    async def on_pre_evaluate(
         self,
         agent: FlockAgent,
         inputs: dict[str, Any],

{flock_core-0.4.0b27.dist-info → flock_core-0.4.0b28.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flock-core
-Version: 0.4.0b27
+Version: 0.4.0b28
 Summary: Declarative LLM Orchestration at Scale
 Author-email: Andre Ratzenberger <andre.ratzenberger@whiteduck.de>
 License-File: LICENSE
@@ -126,7 +126,7 @@ Flock's power comes from a few key ideas (Learn more in the [Full Documentation]
 6. **Tool Integration:** Equip agents with standard or custom Python functions (`@flock_tool`) registered via the `FlockRegistry`.
 7. **Registry:** A central place (`@flock_component`, `@flock_type`, `@flock_tool`) to register your custom classes, types, and functions, enabling robust serialization and dynamic loading.
 
-## 💾 Installation
+## 💾 Installation - Use Flock in your project
 
 Get started with the core Flock library:
 
@@ -148,7 +148,27 @@ uv pip install flock-core[tools]
 uv pip install flock-core[all]
 ```
 
-Environment Setup:
+## 🔑 Installation - Develop Flock
+
+```bash
+git clone https://github.com/whiteducksoftware/flock.git
+cd flock
+
+# One-liner dev setup after cloning
+pip install poethepoet && poe install
+```
+
+Additional provided `poe` tasks and commands:
+
+```bash
+poe install # Install the project
+poe build # Build the project
+poe docs # Serve the docs
+poe format # Format the code
+poe lint # Lint the code
+```
+
+## 🔑 Environment Setup
 
 Flock uses environment variables (typically in a .env file) for configuration, especially API keys. Create a .env file in your project root:
 
@@ -173,7 +193,7 @@ DEFAULT_MODEL="openai/gpt-4o" # Default LLM if agent doesn't specify
 # VARS_PER_PAGE="20"
 ```
 
-Remember to add .env to your .gitignore!
+Be sure that the .env file is added to your .gitignore!
 
 ## ⚡ Quick Start Syntax
 
@@ -223,18 +243,32 @@ Version 0.4.0 brings significant enhancements focused on usability, deployment,
 
 Easily deploy your Flock agents as scalable REST API endpoints. Interact with your agent workflows via standard HTTP requests.
 
+--------------------------------
+
 ### 🖥️ Web UI - Test Flock Agents in the Browser
 
 Test and interact with your Flock agents directly in your browser through an integrated web interface.
 
+--------------------------------
+
 ### ⌨️ CLI Tool - Manage Flock Agents via the Command Line
 
 Manage Flock configurations, run agents, and inspect results directly from your command line.
 
+--------------------------------
+
 ### 💾 Enhanced Serialization - Share, Deploy, and Run Flock Agents by human readable yaml files
 
 Define and share entire Flock configurations, including agents and components, using human-readable YAML files. Load flocks directly from these files for easy deployment and versioning.
 
+--------------------------------
+
+### 💾 New execution flows
+
+Run Flock in batch mode to process multiple inputs at once or in evaluation mode to test agents with different inputs.
+
+--------------------------------
+
 ### ⏱️ Robust Temporal Integration
 
 Flock 0.4.0 introduces first-class support for Temporal.io, enabling you to build truly production-grade, reliable, and scalable agent workflows. Move beyond simple local execution and leverage Temporal's power for:
@@ -249,6 +283,51 @@ Flock makes this easy with:
 *   **Declarative Configuration:** Define Temporal timeouts, retry policies, and task queues directly within your `Flock` and `FlockAgent` configurations (YAML or Python).
 *   **Correct Patterns:** Uses Temporal's recommended granular activity execution for better control and visibility.
 *   **Clear Worker Separation:** Provides guidance and flags for running dedicated Temporal workers, separating development convenience from production best practices.
+  
+Visit the [Temporal Documentation](https://learn.temporal.io/python/workflows/) for more information on how to use Temporal.
+
+Or check out the [Flock Showcase](https://github.com/whiteducksoftware/flock-showcase) for a complete example of a Flock that uses Temporal or our [docs](https://whiteducksoftware.github.io/flock/guides/temporal-configuration/) for more information.
+
+Here's an example of how to configure a Flock to use Temporal:
+
+```python
+from flock.core import Flock, FlockFactory
+
+from flock.workflow.temporal_config import (
+    TemporalActivityConfig,
+    TemporalRetryPolicyConfig,
+    TemporalWorkflowConfig,
+)
+
+# Flock-scoped temporal config
+flock = Flock(
+    enable_temporal=True,
+    temporal_config=TemporalWorkflowConfig(
+        task_queue="flock-test-queue",
+        workflow_execution_timeout=timedelta(minutes=10),
+        default_activity_retry_policy=TemporalRetryPolicyConfig(
+            maximum_attempts=2
+        ),
+    ),
+)
+
+# Agent-scoped temporal config
+content_agent = FlockFactory.create_default_agent(
+    name="content_agent",
+    input="funny_title, funny_slide_headers",
+    output="funny_slide_content",
+    temporal_activity_config=TemporalActivityConfig(
+        start_to_close_timeout=timedelta(minutes=1),
+        retry_policy=TemporalRetryPolicyConfig(
+            maximum_attempts=4,
+            initial_interval=timedelta(seconds=2),
+            non_retryable_error_types=["ValueError"],
+        ),
+    ),
+)
+```
+
+--------------------------------
 
 ### ✨ Utility: @flockclass Hydrator
 
@@ -281,6 +360,8 @@ async def create_character():
 # asyncio.run(create_character())
 ```
 
+--------------------------------
+
 ## 📚 Examples & Tutorials
 
 For a comprehensive set of examples, ranging from basic usage to complex projects and advanced features, please visit our dedicated showcase repository:

{flock_core-0.4.0b27.dist-info → flock_core-0.4.0b28.dist-info}/RECORD

@@ -20,10 +20,10 @@ flock/cli/yaml_editor.py,sha256=K3N0bh61G1TSDAZDnurqW9e_-hO6CtSQKXQqlDhCjVo,1252
 flock/cli/assets/release_notes.md,sha256=bqnk50jxM3w5uY44Dc7MkdT8XmRREFxrVBAG9XCOSSU,4896
 flock/core/__init__.py,sha256=p7lmQULRu9ejIAELfanZiyMhW0CougIPvyFHW2nqBFQ,847
 flock/core/flock.py,sha256=_T_KAFePtEGDzfiFGV1HCdz7VHzj_U0cCquhAQ4xMAM,28199
-flock/core/flock_agent.py,sha256=oOMPw9fmZCAdqJXZsLTbjc4tdIq6gn5_nX3GvPgm61Q,38969
+flock/core/flock_agent.py,sha256=nga2x75EBUworW8TMJLzC0BdPZtX2G8lqJyPy-ac484,39027
 flock/core/flock_evaluator.py,sha256=dOXZeDOGZcAmJ9ahqq_2bdGUU1VOXY4skmwTVpAjiVw,1685
 flock/core/flock_factory.py,sha256=_4zsjkEmJnCR7IvJ3SUHnDbX6c7Tt3E4P5ohxwKvE6w,3173
-flock/core/flock_module.py,sha256=96aFVYAgwpKN53xGbivQDUpikOYGFCxK5mqhclOcxY0,3003
+flock/core/flock_module.py,sha256=2MdAh-n0o4uw7jogvW9iHjVPUawUNN1oGor5ego3RLI,3057
 flock/core/flock_registry.py,sha256=Qcu9juUFNyDAOEsqVxauwVlWdfgKZrSzc8yT8JMiK-c,24246
 flock/core/flock_router.py,sha256=1OAXDsdaIIFApEfo6SRfFEDoTuGt3Si7n2MXiySEfis,2644
 flock/core/api/__init__.py,sha256=OKlhzDWZJfA6ddBwxQUmATY0TSzESsH032u00iVGvdA,228
@@ -80,14 +80,14 @@ flock/evaluators/declarative/declarative_evaluator.py,sha256=q3qKHuKrj17mhaoOZuK
 flock/evaluators/memory/memory_evaluator.py,sha256=ySwz7kcc8suXMJ7gKNSWThW8iOMlE8lUcUzEAHvv8rw,3559
 flock/evaluators/test/test_case_evaluator.py,sha256=3Emcoty0LOLLBIuPGxSpKphuZC9Fu1DTr1vbGg-hd0Q,1233
 flock/evaluators/zep/zep_evaluator.py,sha256=6_5vTdU0yJAH8I8w3-MPXiAZx6iUPhAVCsHjrHzkPLM,2058
-flock/modules/assertion/assertion_module.py,sha256=vzv38E8mvVBQXON_YJ8GFF4kB-sWNychQrMVFmugEjU,12860
-flock/modules/callback/callback_module.py,sha256=q2z-KX7QHlbfDncEP9c_W_DxhYyD6fe9MQfISO9OgrU,2939
-flock/modules/memory/memory_module.py,sha256=MBsUCpnMWY184PlZUKw91b8Yf0jCg9ixsxiqx2tK8LM,15020
+flock/modules/assertion/assertion_module.py,sha256=gnHwWe3TCFEtbQrQ_Dvd1m62GvD71h-lsPlQbOJFKQ0,12863
+flock/modules/callback/callback_module.py,sha256=k5995AaIqZ-aAbFOyFbq57ObpBEFM-BghE2KwnXdmII,2942
+flock/modules/memory/memory_module.py,sha256=fXkR0JZTZbtUHk3e93-JLHe7_OCjPoa8qZbkHiX4qHI,15032
 flock/modules/memory/memory_parser.py,sha256=FLH7GL8XThvHiCMfX3eQH7Sz-f62fzhAUmO6_gaDI7U,4372
 flock/modules/memory/memory_storage.py,sha256=CNcLDMmvv0x7Z3YMKr6VveS_VCa7rKPw8l2d-XgqokA,27246
-flock/modules/output/output_module.py,sha256=V2g7UF538dwCe4J2QsemADMOnorGfK5Z995Q2ZIV7K4,7385
-flock/modules/performance/metrics_module.py,sha256=SptJzBmtVyVloi8-QtJ1jF0pBak1kelsMiZQfoeHr-4,16953
-flock/modules/zep/zep_module.py,sha256=uWhSXma4EIMt70L1_588FLnoLNmU8l7Vhhy1viRK1dk,6115
+flock/modules/output/output_module.py,sha256=2QDW0voU9TZWlL2225k1W3xhWWTfjnfBheC4xIMyBDQ,7388
+flock/modules/performance/metrics_module.py,sha256=G_2CFmPKM36wokrYKhWuGFM_CTOW2IdKfBDK7KYnUBk,16965
+flock/modules/zep/zep_module.py,sha256=biR8oDBAMpyKWO4qTCD6yyRgPPqHwNr23CZ8JSFF3bY,6121
 flock/platform/docker_tools.py,sha256=fpA7-6rJBjPOUBLdQP4ny2QPgJ_042nmqRn5GtKnoYw,1445
 flock/platform/jaeger_install.py,sha256=MyOMJQx4TQSMYvdUJxfiGSo3YCtsfkbNXcAcQ9bjETA,2898
 flock/routers/__init__.py,sha256=w9uL34Auuo26-q_EGlE8Z9iHsw6S8qutTAH_ZI7pn7M,39
@@ -444,8 +444,8 @@ flock/workflow/agent_execution_activity.py,sha256=Gy6FtuVAjf0NiUXmC3syS2eJpNQF4R
 flock/workflow/flock_workflow.py,sha256=iSUF_soFvWar0ffpkzE4irkDZRx0p4HnwmEBi_Ne2sY,9666
 flock/workflow/temporal_config.py,sha256=3_8O7SDEjMsSMXsWJBfnb6XTp0TFaz39uyzSlMTSF_I,3988
 flock/workflow/temporal_setup.py,sha256=YIHnSBntzOchHfMSh8hoLeNXrz3B1UbR14YrR6soM7A,1606
-flock_core-0.4.0b27.dist-info/METADATA,sha256=N3xUdEq5nlLB7BVjw8gnEaGMsRKJDX5K7w5ogfS5RCw,14825
-flock_core-0.4.0b27.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-flock_core-0.4.0b27.dist-info/entry_points.txt,sha256=rWaS5KSpkTmWySURGFZk6PhbJ87TmvcFQDi2uzjlagQ,37
-flock_core-0.4.0b27.dist-info/licenses/LICENSE,sha256=iYEqWy0wjULzM9GAERaybP4LBiPeu7Z1NEliLUdJKSc,1072
-flock_core-0.4.0b27.dist-info/RECORD,,
+flock_core-0.4.0b28.dist-info/METADATA,sha256=6gX5rmbMq9bFCCegflDpQ_RH6JZyZiyRDy4l6_rV0Xs,17125
+flock_core-0.4.0b28.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+flock_core-0.4.0b28.dist-info/entry_points.txt,sha256=rWaS5KSpkTmWySURGFZk6PhbJ87TmvcFQDi2uzjlagQ,37
+flock_core-0.4.0b28.dist-info/licenses/LICENSE,sha256=iYEqWy0wjULzM9GAERaybP4LBiPeu7Z1NEliLUdJKSc,1072
+flock_core-0.4.0b28.dist-info/RECORD,,