Metadata-Version: 2.2
Name: piedpiper_engine
Version: 0.8.1
Summary: An event driven engine to create and manage AI agents for innovative applications
Author-email: Migara <devdude@wondersplot.co.nz>
License: MIT License
        
        Copyright (c) 2024 Wondersplot
        
        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.
        
Project-URL: Homepage, https://github.com/noobosapien/piedpiper_engine
Project-URL: Issues, https://github.com/noobosapien/piedpiper_engine/issues
Platform: unix
Platform: linux
Platform: osx
Platform: cygwin
Platform: win32
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: asyncio==3.4.3
Requires-Dist: iniconfig==2.0.0
Requires-Dist: packaging==24.2
Requires-Dist: pluggy==1.5.0
Requires-Dist: pytest==8.3.4

# Pied Piper Engine

An event driven AI-Agent engine to create robust intelligent applications.





[![MIT License](https://img.shields.io/badge/License-MIT-green.svg)](https://choosealicense.com/licenses/mit/)
![Python](https://img.shields.io/badge/python-3.9+-blue)
[![codecov](https://codecov.io/github/noobosapien/piedpiper_engine/graph/badge.svg?token=BLLPNB3L10)](https://codecov.io/github/noobosapien/piedpiper_engine)

## Installation

Install in a python3 environment

```bash
  pip install piedpiper_engine
```
    
## Running Tests

After cloning the repository, to run tests, run the following command

```bash
  pytest
```


## Usage/Examples
Creating an instance of the engine and running it as non-blocking
```python
from piedpiper_engine import Engine
from custom_modules import module
from custom_system import system
from custom_workflow import workflow

engine = Engine()

engine.add_module(module)
engine.add_system(system)

wf = engine.add_workflow(workflow)

engine.run_non_block()

# Use the workflow 
wf.add_message("Example message from client")
blocked_result = wf.get()

wf.add_message("Another message from client")
non_blocked_result = wf.get_non_block() # None returned if there is no result

engine.remove_workflow(wf)

engine.shutdown()
```


## Tech Stack

**App:** Python, Asyncio, Langchain

## Roadmap

- Build the core engine

## Feedback

If you have any feedback, please reach out to me at devdude@wondersplot.co.nz
