PraisonAI 0.0.1__py3-none-any.whl → 0.0.22__py3-none-any.whl

praisonai-0.0.22.dist-info/METADATA

@@ -0,0 +1,314 @@
+Metadata-Version: 2.1
+Name: PraisonAI
+Version: 0.0.22
+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
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Dist: Flask (>=3.0.0)
+Requires-Dist: crewai (>=0.30.4)
+Requires-Dist: crewai-tools (>=0.2.6,<0.3.0)
+Requires-Dist: gradio (>=4.20.0)
+Requires-Dist: markdown (>=3.5)
+Requires-Dist: praisonai-tools (>=0.0.4)
+Requires-Dist: pyautogen (>=0.2.19)
+Requires-Dist: rich (>=13.7)
+Project-URL: Homepage, https://docs.praison.ai
+Project-URL: Repository, https://github.com/mervinpraison/PraisonAI
+Description-Content-Type: text/markdown
+
+# Praison AI
+
+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
+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 (Optional):
+
+```bash
+praisonai --framework autogen --init create movie script about cat in mars
+```
+
+## Run
+
+```bash
+praisonai
+```
+
+or 
+    
+```bash
+python -m praisonai
+```
+
+### Specify the agent framework (Optional):
+
+```bash
+praisonai --framework autogen
+```
+
+### Full Automatic Mode
+
+```bash
+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
+python -m unittest tests.test 
+```
+
+## Agents Playbook 
+
+### Simple Playbook Example
+
+```yaml
+framework: crewai
+topic: Artificial Intelligence
+roles:
+  screenwriter:
+    backstory: 'Skilled in crafting scripts with engaging dialogue about {topic}.'
+    goal: Create scripts from concepts.
+    role: Screenwriter
+    tasks:
+      scriptwriting_task:
+        description: 'Develop scripts with compelling characters and dialogue about {topic}.'
+        expected_output: 'Complete script ready for production.'
+```
+
+### Detailed Playbook Example
+
+```yaml
+framework: crewai
+topic: Artificial Intelligence
+roles:
+  movie_concept_creator:
+    backstory: 'Creative thinker with a deep understanding of cinematic storytelling,
+      capable of using AI-generated storylines to create unique and compelling movie
+      ideas.'
+    goal: Generate engaging movie concepts using AI storylines
+    role: Movie Concept Creator
+    tasks:
+      movie_concept_development:
+        description: 'Develop movie concepts from AI-generated storylines, ensuring
+          they are engaging and have strong narrative arcs.'
+        expected_output: 'Well-structured movie concept document with character
+          bios, settings, and plot outlines.'
+  screenwriter:
+    backstory: 'Expert in writing engaging dialogue and script structure, able to
+      turn movie concepts into production-ready scripts.'
+    goal: Write compelling scripts based on movie concepts
+    role: Screenwriter
+    tasks:
+      scriptwriting_task:
+        description: 'Turn movie concepts into polished scripts with well-developed
+          characters, strong dialogue, and effective scene transitions.'
+        expected_output: 'Production-ready script with a beginning, middle, and
+          end, along with character development and engaging dialogues.'
+  editor:
+    backstory: 'Adept at identifying inconsistencies, improving language usage,
+      and maintaining the overall flow of the script.'
+    goal: Refine the scripts and ensure continuity of the movie storyline
+    role: Editor
+    tasks:
+      editing_task:
+        description: 'Review, edit, and refine the scripts to ensure they are cohesive
+          and follow a well-structured narrative.'
+        expected_output: 'A polished final draft of the script with no inconsistencies,
+          strong character development, and effective dialogue.'
+dependencies: []
+```
+
+## Include praisonai package in your project
+
+```python
+from praisonai import PraisonAI
+
+def basic(): # Basic Mode
+    praison_ai = PraisonAI(agent_file="agents.yaml")
+    praison_ai.main()
+    
+def advanced(): # Advanced Mode with options
+    praison_ai = PraisonAI(
+        agent_file="agents.yaml",
+        framework="autogen",
+    )
+    praison_ai.main()
+    
+def auto(): # Full Automatic Mode
+    praison_ai = PraisonAI(
+        auto="Create a movie script about car in mars",
+        framework="autogen"
+    )
+    print(praison_ai.framework)
+    praison_ai.main()
+
+if __name__ == "__main__":
+    basic()
+    advanced()
+    auto()
+```
+
+## Include CrewAI Tools
+
+```
+pip install "praisonai[crewai-tools]"
+```
+
+## Deploy 
+    
+```bash
+gcloud init
+gcloud services enable run.googleapis.com
+gcloud services enable containerregistry.googleapis.com
+gcloud services enable cloudbuild.googleapis.com
+
+export OPENAI_MODEL_NAME="gpt-4o"
+export OPENAI_API_KEY="Enter your API key"
+export OPENAI_API_BASE="https://api.openai.com/v1"
+
+yes | gcloud auth configure-docker us-central1-docker.pkg.dev 
+gcloud artifacts repositories create praisonai-repository --repository-format=docker --location=us-central1
+
+PROJECT_ID=$(gcloud config get-value project)
+TAG="latest"
+docker build --platform linux/amd64 -t gcr.io/${PROJECT_ID}/praisonai-app:${TAG} .
+docker tag gcr.io/${PROJECT_ID}/praisonai-app:${TAG} us-central1-docker.pkg.dev/${PROJECT_ID}/praisonai-repository/praisonai-app:${TAG}
+docker push us-central1-docker.pkg.dev/${PROJECT_ID}/praisonai-repository/praisonai-app:${TAG}
+
+gcloud run deploy praisonai-service \
+    --image us-central1-docker.pkg.dev/${PROJECT_ID}/praisonai-repository/praisonai-app:${TAG} \
+    --platform managed \
+    --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'
+OPENAI_API_KEY='NA'
+
+FastChat¶
+OPENAI_API_BASE="http://localhost:8001/v1"
+OPENAI_MODEL_NAME='oh-2.5m7b-q51'
+OPENAI_API_KEY=NA
+
+LM Studio¶
+OPENAI_API_BASE="http://localhost:8000/v1"
+OPENAI_MODEL_NAME=NA
+OPENAI_API_KEY=NA
+
+Mistral API¶
+OPENAI_API_BASE=https://api.mistral.ai/v1
+OPENAI_MODEL_NAME="mistral-small"
+OPENAI_API_KEY=your-mistral-api-key
+```
+
+## Contributing
+
+- Fork on GitHub: Use the "Fork" button on the repository page.
+- Clone your fork: `git clone https://github.com/yourusername/praisonAI.git`
+- Create a branch: `git checkout -b new-feature`
+- 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.
+
+

praisonai-0.0.22.dist-info/RECORD

@@ -0,0 +1,15 @@
+praisonai/__init__.py,sha256=5SwxMGd4vNUmYedF_HLLQBo4u8zMEWuEfKhHqJrEE1I,59
+praisonai/__main__.py,sha256=MVgsjMThjBexHt4nhd760JCqvP4x0IQcwo8kULOK4FQ,144
+praisonai/agents_generator.py,sha256=OXrSzl6thcjgKc7bLzir0nksMPrpL3fMsF7hYYl4XM8,12807
+praisonai/auto.py,sha256=evK0RxnR89e-HBTZD0fyJSD_m9k6rNj1Cmdn7dZKZ7A,7378
+praisonai/cli.py,sha256=fYt-zG8i4dzXxyWqrJ1O8-MQwAZKqH4im6SJ2OWBHkg,8109
+praisonai/deploy.py,sha256=tiQfXVUgndE68-0ItXmPBub_p-d5qSWXJguhyRDA5Rc,6031
+praisonai/inbuilt_tools/__init__.py,sha256=mUKnbL6Gram9c9f2m8wJwEzURBLmPEOcHzwySBH89YA,74
+praisonai/inbuilt_tools/autogen_tools.py,sha256=m3Ws2444hzgkiEjqw9Y4PFb_LsU9ZDD23C03uNsyeu0,14556
+praisonai/test.py,sha256=DkS_z3w7TmXt9lc57ToYQzdKN2IkWqXEMDBYUmZiGNk,4040
+praisonai/version.py,sha256=ugyuFliEqtAwQmH4sTlc16YXKYbFWDmfyk87fErB8-8,21
+praisonai-0.0.22.dist-info/LICENSE,sha256=kqvFysVlnFxYOu0HxCe2HlmZmJtdmNGOxWRRkT9TsWc,1035
+praisonai-0.0.22.dist-info/METADATA,sha256=6KBv38ZhrjJmFyNt8t7PlEUqyk_Gckpiv4KZ1pxh-hQ,9398
+praisonai-0.0.22.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+praisonai-0.0.22.dist-info/entry_points.txt,sha256=Qg41eW3A1-dvdV5tF7LqChfYof8Rihk2rN1fiEE3vnk,53
+praisonai-0.0.22.dist-info/RECORD,,

{praisonAI-0.0.1.dist-info → praisonai-0.0.22.dist-info}/WHEEL

@@ -1,5 +1,4 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: poetry-core 1.9.0
 Root-Is-Purelib: true
 Tag: py3-none-any
-

praisonai-0.0.22.dist-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+praisonai=praisonai.__main__:main
+

praisonAI/__init__.py

@@ -1 +0,0 @@
-from .version import __version__

praisonAI/__main__.py

@@ -1,4 +0,0 @@
-from .cli import main
-
-if __name__ == "__main__":
-    main()

praisonAI/cli.py

@@ -1,114 +0,0 @@
-import sys
-from .version import __version__
-import yaml, os
-from rich import print
-from dotenv import load_dotenv
-from crewai import Agent, Task, Crew
-load_dotenv()
-import autogen
-config_list = [
-    {
-        'model': os.environ.get("OPENAI_MODEL_NAME", "gpt-3.5-turbo"),
-        'base_url': os.environ.get("OPENAI_API_BASE", "https://api.openai.com/v1"),
-    }
-]
-
-def generate_crew_and_kickoff(agent_file, framework=None):
-    with open(agent_file, 'r') as f:
-        config = yaml.safe_load(f)
-
-    topic = config['topic']  
-    framework = framework or config.get('framework')
-
-    agents = {}
-    tasks = []
-    if framework == "autogen":
-        # Load the LLM configuration dynamically
-        print(config_list)
-        llm_config = {"config_list": config_list}
-        
-        for role, details in config['roles'].items():
-            agent_name = details['role'].format(topic=topic).replace("{topic}", topic)
-            agent_goal = details['goal'].format(topic=topic)
-            # Creating an AssistantAgent for each role dynamically
-            agents[role] = autogen.AssistantAgent(
-                name=agent_name,
-                llm_config=llm_config,
-                system_message=details['backstory'].format(topic=topic)+". Reply \"TERMINATE\" in the end when everything is done.",
-            )
-
-            # Preparing tasks for initiate_chats
-            for task_name, task_details in details.get('tasks', {}).items():
-                description_filled = task_details['description'].format(topic=topic)
-                expected_output_filled = task_details['expected_output'].format(topic=topic)
-                
-                chat_task = {
-                    "recipient": agents[role],
-                    "message": description_filled,
-                    "summary_method": "last_msg",  # Customize as needed
-                    # Additional fields like carryover can be added based on dependencies
-                }
-                tasks.append(chat_task)
-
-        # Assuming the user proxy agent is set up as per your requirements
-        user = autogen.UserProxyAgent(
-            name="User",
-            human_input_mode="NEVER",
-            is_termination_msg=lambda x: (x.get("content") or "").rstrip().endswith("TERMINATE"),
-            code_execution_config={
-                "work_dir": "coding",
-                "use_docker": False,
-            },
-            # additional setup for the user proxy agent
-        )
-        response = user.initiate_chats(tasks)
-        result = "### Output ###\n"+response[-1].summary if hasattr(response[-1], 'summary') else ""
-    else:
-        for role, details in config['roles'].items():
-            role_filled = details['role'].format(topic=topic)
-            goal_filled = details['goal'].format(topic=topic)
-            backstory_filled = details['backstory'].format(topic=topic)
-            
-            # Assume tools are loaded and handled here as per your requirements
-            agent = Agent(role=role_filled, goal=goal_filled, backstory=backstory_filled)
-            agents[role] = agent
-
-            for task_name, task_details in details.get('tasks', {}).items():
-                description_filled = task_details['description'].format(topic=topic)
-                expected_output_filled = task_details['expected_output'].format(topic=topic)
-
-                task = Task(description=description_filled, expected_output=expected_output_filled, agent=agent)
-                tasks.append(task)
-
-        crew = Crew(
-            agents=list(agents.values()),
-            tasks=tasks,
-            verbose=2
-        )
-
-        result = crew.kickoff()
-    return result
-
-def main(args=None):
-    if args is None:
-        args = sys.argv[1:]  # Skip the script name
-
-    invocation_cmd = "praisonai"
-    version_string = f"PraisonAI version {__version__}"
-    framework = "crewai"  # Default framework
-
-    if "--framework" in args:
-        framework_index = args.index("--framework")
-        framework = args[framework_index + 1]
-        args = args[:framework_index] + args[framework_index + 2:]
-
-    if args:
-        agent_file = args[-1]  # Assuming the last argument is the agent file
-    else:
-        agent_file = "agents.yaml"
-
-    result = generate_crew_and_kickoff(agent_file, framework)
-    print(result)
-    
-if __name__ == "__main__":
-    main()

praisonAI-0.0.1.dist-info/METADATA

@@ -1,22 +0,0 @@
-Metadata-Version: 2.1
-Name: praisonAI
-Version: 0.0.1
-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
-Description-Content-Type: text/markdown
-
-# Praison AI
-
-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.
-
-## Installation
-
-```bash
-pip install praisonai
-```
-
-## Run
-
-```bash
-praisonai
-```

praisonAI-0.0.1.dist-info/RECORD

@@ -1,9 +0,0 @@
-praisonAI/__init__.py,sha256=8zLGg-DfQhnDl2Ky0n-zXpN-8e-g7iR0AcaI4l4Vvpk,32
-praisonAI/__main__.py,sha256=0g3iknXOS9gZUcpL_trgAcuCJnZZKjdsT_xt61WOVb4,60
-praisonAI/cli.py,sha256=OQYvURs2HCxoUruhAhkolqSAnx7kXxaeg2XzUPZMwIw,4345
-praisonAI/test.py,sha256=4bAqitWeywjZtxoOAdcBTLaYDRflZH3LSYtOpWrZBI4,3707
-praisonAI/version.py,sha256=ugyuFliEqtAwQmH4sTlc16YXKYbFWDmfyk87fErB8-8,21
-praisonAI-0.0.1.dist-info/METADATA,sha256=nHYm4Z2hEsqYeEDZs5N8_UfCTIip9Bj4adIiGIGhto4,747
-praisonAI-0.0.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-praisonAI-0.0.1.dist-info/top_level.txt,sha256=7tEg2pqQqKr4CaCDaFHktvbpEswYcW-pHXGrAwY-6qk,10
-praisonAI-0.0.1.dist-info/RECORD,,

praisonAI-0.0.1.dist-info/top_level.txt

@@ -1 +0,0 @@
-praisonAI