Merge pull request #43 from MervinPraison/develop

v0.0.22

Author: MervinPraison

.env.example

@@ -1,3 +1,3 @@
-OPENAI_MODEL_NAME="gpt-4-turbo-preview"
+OPENAI_MODEL_NAME="gpt-4o"
 OPENAI_API_KEY="Enter your API key"
 OPENAI_API_BASE="https://api.openai.com/v1"

.github/workflows/python-package.yml

@@ -29,12 +29,12 @@ jobs:
         python -m pip install --upgrade pip
         python -m pip install flake8 pytest
         if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
-    - name: Lint with flake8
-      run: |
-        # stop the build if there are Python syntax errors or undefined names
-        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    # - name: Lint with flake8
+    #   run: |
+    #     # stop the build if there are Python syntax errors or undefined names
+    #     flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+    #     # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+    #     flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
     # - name: Test with pytest
     #   run: |
     #     pytest

.gitignore

@@ -17,6 +17,11 @@ db
 praisonai_prompt.txt
 watch.sh
 docs.sh
+other
+
+.chainlit
+
+site
 # Ignore Sphinx build directory
 docs/_build/
 docs/source/

.readthedocs.yml

@@ -1,4 +1,5 @@
-# Read the Docs configuration file for Sphinx projects
+# .readthedocs.yaml
+# Read the Docs configuration file
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
@@ -9,27 +10,14 @@ build:
   os: ubuntu-22.04
   tools:
     python: "3.12"
-    # You can also specify other tool versions:
-    # nodejs: "20"
-    # rust: "1.70"
-    # golang: "1.20"
+  jobs:
+    post_install:
+    - bash docs/generate_docs.sh
 
-# Build documentation in the "docs/" directory with Sphinx
-sphinx:
-  configuration: docs/conf.py
-  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
-  # builder: "dirhtml"
-  # Fail on all warnings to avoid broken references
-  # fail_on_warning: true
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: true
 
-# Optionally build your docs in additional formats such as PDF and ePub
-# formats:
-#   - pdf
-#   - epub
-
-# Optional but recommended, declare the Python requirements required
-# to build your documentation
-# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#   install:
-#     - requirements: docs/requirements.txt
+python:
+  install:
+    - requirements: docs/requirements.txt

Dockerfile

@@ -1,6 +1,6 @@
 FROM python:3.11-slim
 WORKDIR /app
 COPY . .
-RUN pip install flask praisonai==0.0.21 gunicorn markdown
+RUN pip install flask praisonai==0.0.22 gunicorn markdown
 EXPOSE 8080
 CMD ["gunicorn", "-b", "0.0.0.0:8080", "api:app"]

README.md

@@ -220,6 +220,12 @@ if __name__ == "__main__":
     auto()
 ```
 
+## Include CrewAI Tools
+
+```
+pip install "praisonai[crewai-tools]"
+```
+
 ## Deploy 
 
 ```bash
@@ -228,7 +234,7 @@ gcloud services enable run.googleapis.com
 gcloud services enable containerregistry.googleapis.com
 gcloud services enable cloudbuild.googleapis.com
 
-export OPENAI_MODEL_NAME="gpt-4-turbo-preview"
+export OPENAI_MODEL_NAME="gpt-4o"
 export OPENAI_API_KEY="Enter your API key"
 export OPENAI_API_BASE="https://api.openai.com/v1"
 
@@ -281,4 +287,5 @@ 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.
+

agents.yaml

@@ -1,4 +1,4 @@
-framework: crewai
+framework: autogen
 topic: research about the causes of lung disease
 roles:
   research_analyst:
@@ -11,7 +11,7 @@ roles:
           diseases.
         expected_output: Report detailing key findings on lung disease causes.
     tools:
-    - 'PubmedQueryRun'
+    - 'InternetSearchTool'
   medical_writer:
     backstory: Skilled in translating complex medical information into accessible
       content.

docs/CNAME

@@ -0,0 +1 @@
+docs.praison.ai

docs/agents_playbook.md

@@ -0,0 +1,60 @@
+# 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: []
+```

docs/api.md

@@ -0,0 +1,6 @@
+# API Reference
+::: praisonai
+::: praisonai.auto
+::: praisonai.agents_generator
+::: praisonai.cli
+::: praisonai.deploy