PraisonAI 0.0.20__tar.gz → 0.0.21__tar.gz

{praisonai-0.0.20 → praisonai-0.0.21}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: praisonAI
-Version: 0.0.20
+Version: 0.0.21
 Summary: praisonAI application combines AutoGen and CrewAI or similar frameworks into a low-code solution for building and managing multi-agent LLM systems, focusing on simplicity, customization, and efficient human-agent collaboration.
 Author: Mervin Praison
 Requires-Python: >=3.10,<3.13
@@ -24,6 +24,14 @@ Description-Content-Type: text/markdown
 
 Praison AI, leveraging both AutoGen and CrewAI or any other agent framework, represents a low-code, centralised framework designed to simplify the creation and orchestration of multi-agent systems for various LLM applications, emphasizing ease of use, customization, and human-agent interaction.
 
+## TL;DR
+```bash
+pip install praisonai
+export OPENAI_API_KEY="Enter your API key"
+praisonai --init create a movie script about dog in moon
+praisonai
+```
+
 ## Installation
 
 ```bash
@@ -31,13 +39,21 @@ pip install praisonai
 ```
 
 ## Initialise
+
+```bash
+export OPENAI_API_KEY="Enter your API key"
+```
+
+Generate your OPENAI API KEY from here: https://platform.openai.com/api-keys
+
+Note: You can use other providers such as Ollama, Mistral ... etc. Details are provided at the bottom.
     
 ```bash
 praisonai --init create a movie script about dog in moon
 ```
 This will automatically create agents.yaml file in the current directory.
 
-To initialse with a specific agent framework:
+### To initialse with a specific agent framework (Optional):
 
 ```bash
 praisonai --framework autogen --init create movie script about cat in mars
@@ -55,7 +71,7 @@ or
 python -m praisonai
 ```
 
-### Specify the agent framework
+### Specify the agent framework (Optional):
 
 ```bash
 praisonai --framework autogen
@@ -67,6 +83,68 @@ praisonai --framework autogen
 praisonai --auto create a movie script about Dog in Moon
 ```
 
+## Create Custom Tools
+
+### TL;DR to Create a Custom Tool
+
+```bash
+pip install praisonai duckduckgo-search
+export OPENAI_API_KEY="Enter your API key"
+praisonai --init research about the latest AI News and prepare a detailed report
+```
+
+- Add `- InternetSearchTool` in the agents.yaml file in the tools section. 
+- Create a file called tools.py and add this code [tools.py](./tools.py)
+
+```bash
+praisonai
+```
+
+### Pre-requisite to Create a Custom Tool
+`agents.yaml` file should be present in the current directory. 
+
+If it doesn't exist, create it by running the command `praisonai --init research about the latest AI News and prepare a detailed report`.
+
+### Step 1 to Create a Custom Tool
+
+Create a file called tools.py in the same directory as the agents.yaml file.
+
+```python
+# example tools.py
+from duckduckgo_search import DDGS
+from praisonai_tools import BaseTool
+
+class InternetSearchTool(BaseTool):
+    name: str = "InternetSearchTool"
+    description: str = "Search Internet for relevant information based on a query or latest news"
+
+    def _run(self, query: str):
+        ddgs = DDGS()
+        results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
+        return results
+```
+
+### Step 2 to Create a Custom Tool
+
+Add the tool to the agents.yaml file as show below under the tools section `- InternetSearchTool`.
+
+```yaml
+framework: crewai
+topic: research about the latest AI News and prepare a detailed report
+roles:
+  research_analyst:
+    backstory: Experienced in gathering and analyzing data related to AI news trends.
+    goal: Analyze AI News trends
+    role: Research Analyst
+    tasks:
+      gather_data:
+        description: Conduct in-depth research on the latest AI News trends from reputable
+          sources.
+        expected_output: Comprehensive report on current AI News trends.
+    tools:
+    - InternetSearchTool
+```
+
 ## Test
     
 ```bash
@@ -75,7 +153,7 @@ python -m unittest tests.test
 
 ## Agents Playbook 
 
-### Simple Playbook
+### Simple Playbook Example
 
 ```yaml
 framework: crewai
@@ -91,7 +169,7 @@ roles:
         expected_output: 'Complete script ready for production.'
 ```
 
-### Detailed Playbook
+### Detailed Playbook Example
 
 ```yaml
 framework: crewai
@@ -191,9 +269,11 @@ gcloud run deploy praisonai-service \
     --region us-central1 \
     --allow-unauthenticated \
     --set-env-vars OPENAI_MODEL_NAME=${OPENAI_MODEL_NAME},OPENAI_API_KEY=${OPENAI_API_KEY},OPENAI_API_BASE=${OPENAI_API_BASE}
+```
 
 ## Other Models
 
+```bash
 Ollama
 OPENAI_API_BASE='http://localhost:11434/v1'
 OPENAI_MODEL_NAME='mistral'
@@ -213,6 +293,7 @@ Mistral API¶
 OPENAI_API_BASE=https://api.mistral.ai/v1
 OPENAI_MODEL_NAME="mistral-small"
 OPENAI_API_KEY=your-mistral-api-key
+```
 
 ## Contributing
 
@@ -223,4 +304,3 @@ OPENAI_API_KEY=your-mistral-api-key
 - Push to your fork: `git push origin new-feature`
 - Submit a pull request via GitHub's web interface.
 - Await feedback from project maintainers.
-

{praisonai-0.0.20 → praisonai-0.0.21}/README.md

@@ -2,6 +2,14 @@
 
 Praison AI, leveraging both AutoGen and CrewAI or any other agent framework, represents a low-code, centralised framework designed to simplify the creation and orchestration of multi-agent systems for various LLM applications, emphasizing ease of use, customization, and human-agent interaction.
 
+## TL;DR
+```bash
+pip install praisonai
+export OPENAI_API_KEY="Enter your API key"
+praisonai --init create a movie script about dog in moon
+praisonai
+```
+
 ## Installation
 
 ```bash
@@ -9,13 +17,21 @@ pip install praisonai
 ```
 
 ## Initialise
+
+```bash
+export OPENAI_API_KEY="Enter your API key"
+```
+
+Generate your OPENAI API KEY from here: https://platform.openai.com/api-keys
+
+Note: You can use other providers such as Ollama, Mistral ... etc. Details are provided at the bottom.
     
 ```bash
 praisonai --init create a movie script about dog in moon
 ```
 This will automatically create agents.yaml file in the current directory.
 
-To initialse with a specific agent framework:
+### To initialse with a specific agent framework (Optional):
 
 ```bash
 praisonai --framework autogen --init create movie script about cat in mars
@@ -33,7 +49,7 @@ or
 python -m praisonai
 ```
 
-### Specify the agent framework
+### Specify the agent framework (Optional):
 
 ```bash
 praisonai --framework autogen
@@ -45,6 +61,68 @@ praisonai --framework autogen
 praisonai --auto create a movie script about Dog in Moon
 ```
 
+## Create Custom Tools
+
+### TL;DR to Create a Custom Tool
+
+```bash
+pip install praisonai duckduckgo-search
+export OPENAI_API_KEY="Enter your API key"
+praisonai --init research about the latest AI News and prepare a detailed report
+```
+
+- Add `- InternetSearchTool` in the agents.yaml file in the tools section. 
+- Create a file called tools.py and add this code [tools.py](./tools.py)
+
+```bash
+praisonai
+```
+
+### Pre-requisite to Create a Custom Tool
+`agents.yaml` file should be present in the current directory. 
+
+If it doesn't exist, create it by running the command `praisonai --init research about the latest AI News and prepare a detailed report`.
+
+### Step 1 to Create a Custom Tool
+
+Create a file called tools.py in the same directory as the agents.yaml file.
+
+```python
+# example tools.py
+from duckduckgo_search import DDGS
+from praisonai_tools import BaseTool
+
+class InternetSearchTool(BaseTool):
+    name: str = "InternetSearchTool"
+    description: str = "Search Internet for relevant information based on a query or latest news"
+
+    def _run(self, query: str):
+        ddgs = DDGS()
+        results = ddgs.text(keywords=query, region='wt-wt', safesearch='moderate', max_results=5)
+        return results
+```
+
+### Step 2 to Create a Custom Tool
+
+Add the tool to the agents.yaml file as show below under the tools section `- InternetSearchTool`.
+
+```yaml
+framework: crewai
+topic: research about the latest AI News and prepare a detailed report
+roles:
+  research_analyst:
+    backstory: Experienced in gathering and analyzing data related to AI news trends.
+    goal: Analyze AI News trends
+    role: Research Analyst
+    tasks:
+      gather_data:
+        description: Conduct in-depth research on the latest AI News trends from reputable
+          sources.
+        expected_output: Comprehensive report on current AI News trends.
+    tools:
+    - InternetSearchTool
+```
+
 ## Test
     
 ```bash
@@ -53,7 +131,7 @@ python -m unittest tests.test
 
 ## Agents Playbook 
 
-### Simple Playbook
+### Simple Playbook Example
 
 ```yaml
 framework: crewai
@@ -69,7 +147,7 @@ roles:
         expected_output: 'Complete script ready for production.'
 ```
 
-### Detailed Playbook
+### Detailed Playbook Example
 
 ```yaml
 framework: crewai
@@ -169,9 +247,11 @@ gcloud run deploy praisonai-service \
     --region us-central1 \
     --allow-unauthenticated \
     --set-env-vars OPENAI_MODEL_NAME=${OPENAI_MODEL_NAME},OPENAI_API_KEY=${OPENAI_API_KEY},OPENAI_API_BASE=${OPENAI_API_BASE}
+```
 
 ## Other Models
 
+```bash
 Ollama
 OPENAI_API_BASE='http://localhost:11434/v1'
 OPENAI_MODEL_NAME='mistral'
@@ -191,6 +271,7 @@ Mistral API¶
 OPENAI_API_BASE=https://api.mistral.ai/v1
 OPENAI_MODEL_NAME="mistral-small"
 OPENAI_API_KEY=your-mistral-api-key
+```
 
 ## Contributing
 
@@ -200,4 +281,4 @@ OPENAI_API_KEY=your-mistral-api-key
 - Make changes and commit: `git commit -am "Add some feature"`
 - Push to your fork: `git push origin new-feature`
 - Submit a pull request via GitHub's web interface.
-- Await feedback from project maintainers.
+- Await feedback from project maintainers.

{praisonai-0.0.20 → praisonai-0.0.21}/praisonai/agents_generator.py

@@ -43,7 +43,7 @@ class AgentsGenerator:
         spec = importlib.util.spec_from_file_location("tools_module", module_path)
         module = importlib.util.module_from_spec(spec)
         spec.loader.exec_module(module)
-        return {name: obj() for name, obj in inspect.getmembers(module, lambda x: inspect.isclass(x) and issubclass(x, BaseTool) and x is not BaseTool)}
+        return {name: obj() for name, obj in inspect.getmembers(module, lambda x: inspect.isclass(x) and (x.__module__.startswith('langchain_community.tools') or issubclass(x, BaseTool)) and x is not BaseTool)}
 
     def load_tools_from_package(self, package_path):
         tools_dict = {}

{praisonai-0.0.20 → praisonai-0.0.21}/praisonai/deploy.py

@@ -13,7 +13,7 @@ class CloudDeployer:
             file.write("FROM python:3.11-slim\n")
             file.write("WORKDIR /app\n")
             file.write("COPY . .\n")
-            file.write("RUN pip install flask praisonai==0.0.20 gunicorn markdown\n")
+            file.write("RUN pip install flask praisonai==0.0.21 gunicorn markdown\n")
             file.write("EXPOSE 8080\n")
             file.write('CMD ["gunicorn", "-b", "0.0.0.0:8080", "api:app"]\n')
             

{praisonai-0.0.20 → praisonai-0.0.21}/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "praisonAI"
-version = "0.0.20"
+version = "0.0.21"
 description = "praisonAI application combines AutoGen and CrewAI or similar frameworks into a low-code solution for building and managing multi-agent LLM systems, focusing on simplicity, customization, and efficient human-agent collaboration."
 authors = ["Mervin Praison"]
 license = ""