Compare commits

..
Author SHA1 Message Date
Cursor AgentandMervin Praison 098b20c814 Add AGENTS.md with Cursor Cloud development environment instructions
Co-authored-by: Mervin Praison <[email protected]>
2026-02-27 04:54:55 +00:00
584 changed files with 16441 additions and 59153 deletions

No files matched your search

@@ -5,9 +5,6 @@ inputs:
anthropic_api_key:
description: "Anthropic API key"
required: false
claude_code_oauth_token:
description: "Claude Code OAuth Token for Claude Pro"
required: false
github_token:
description: "GitHub token for Claude to operate with"
required: false
@@ -215,13 +212,6 @@ runs:
- Documentation updates
- Testing and deployment
CRITICAL INSTRUCTION: If your task involves modifying codebase files to add a feature or fix a bug:
1. ALWAYS create a new git branch appropriately named (e.g. \`feature/issue-<number>\`).
2. MANDATORY: Before writing any code, you MUST carefully read "src/praisonai-agents/AGENTS.md" to understand this repository's extremely specific Architecture, Protocol-First design rules, and Agent-Centric Philosophy.
3. Make your necessary code changes honoring the rules in AGENTS.md.
4. Commit your changes and push the branch to the remote repository.
5. Use the GitHub CLI (\`gh pr create --title "..." --body "Fixes #<number>"\`) to open a Pull Request containing your work.
Respond naturally and helpfully to the user's request using the available tools.
EOF
@@ -263,5 +253,4 @@ runs:
echo "✅ Claude Code execution completed"
env:
ANTHROPIC_API_KEY: ${{ inputs.anthropic_api_key }}
CLAUDE_CODE_OAUTH_TOKEN: ${{ inputs.claude_code_oauth_token }}
GITHUB_TOKEN: ${{ inputs.github_token }}
@@ -6,8 +6,8 @@ inputs:
description: "Timeout in minutes for execution"
required: false
default: "5"
claude_code_oauth_token:
description: "Claude Code OAuth token for Pro subscription access"
anthropic_api_key:
description: "Anthropic API key"
required: true
github_token:
description: "GitHub token with repo and issues permissions"
@@ -21,8 +21,7 @@ runs:
with:
fetch-depth: 0
- name: Create prompt
id: generate_prompt
- name: Create prompt file
shell: bash
run: |
mkdir -p /tmp/claude-prompts
@@ -76,16 +75,13 @@ runs:
- Your ONLY action should be to apply labels using mcp__github__update_issue
- It's okay to not add any labels if none are clearly applicable
EOF
echo "PROMPT<<DELIMITER" >> $GITHUB_OUTPUT
cat /tmp/claude-prompts/claude-issue-triage-prompt.txt >> $GITHUB_OUTPUT
echo "DELIMITER" >> $GITHUB_OUTPUT
- name: Run Claude Code
uses: ./.github/actions/claude-code-action
with:
direct_prompt: ${{ steps.generate_prompt.outputs.PROMPT }}
prompt_file: /tmp/claude-prompts/claude-issue-triage-prompt.txt
allowed_tools: "Bash(gh label list),mcp__github__get_issue,mcp__github__get_issue_comments,mcp__github__update_issue,mcp__github__search_issues,mcp__github__list_issues"
install_github_mcp: "true"
timeout_minutes: ${{ inputs.timeout_minutes }}
claude_code_oauth_token: ${{ inputs.claude_code_oauth_token }}
anthropic_api_key: ${{ inputs.anthropic_api_key }}
github_token: ${{ inputs.github_token }}
+1 -8
View File
@@ -22,12 +22,6 @@ inputs:
To enable observability with Google Cloud, include:
{"telemetry": {"enabled": true, "target": "gcp"}, "sandbox": false}
required: false
model:
description: |
The Gemini model to use. Options: gemini-2.5-pro, gemini-2.5-flash, gemini-2.5-flash-lite.
Use flash-lite for highest free-tier quota (1,000 RPD).
required: false
default: 'gemini-3.1-flash-lite-preview'
version:
description: |
The version of @google/gemini-cli to execute.
@@ -76,11 +70,10 @@ runs:
- name: Run Gemini CLI
run: |
gemini --yolo --model "$GEMINI_MODEL" --prompt "$PROMPT"
gemini --yolo --prompt "$PROMPT"
shell: bash
env:
GEMINI_API_KEY: ${{ inputs.GEMINI_API_KEY }}
GEMINI_MODEL: ${{ inputs.model }}
PROMPT: ${{ inputs.prompt }}
branding:
Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.8 MiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 109 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 285 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 2.2 MiB

+11 -31
View File
@@ -1,46 +1,26 @@
name: Auto Issue Comment
name: Auto Issue Comment with PR Creation
on:
workflow_dispatch:
# issues:
# types: [opened]
issues:
types: [opened]
jobs:
# Trigger Claude by adding the 'claude' label (only if not already labeled)
# Note: @claude in comments only works from human users (not bots)
# The claude.yml workflow listens for issues:labeled event with 'claude' label
trigger-claude:
# Skip if issue was already created with 'claude' label to avoid double-trigger
if: |
!contains(toJSON(github.event.issue.labels), 'claude')
add-comment:
runs-on: ubuntu-latest
permissions:
issues: write
contents: write
pull-requests: write
actions: read
steps:
- name: Add claude label to trigger analysis
- name: Add automated comment
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
// Check if 'claude' label already exists on this issue
const labels = context.payload.issue.labels.map(l => l.name);
if (labels.includes('claude')) {
console.log('Issue already has claude label, skipping');
return;
}
// Add label to trigger claude.yml via issues:labeled event
await github.rest.issues.addLabels({
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
labels: ['claude']
});
// Also post instructions as a comment for context
await github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '🤖 Auto-triaging with Claude. Analyzing issue and implementing a fix...\n\nClaude will:\n1. Classify this issue\n2. Search codebase for root cause\n3. Implement a minimal fix following AGENTS.md\n4. Create a PR with the changes'
});
body: '@claude review this issue and do a detailed analysis and fix this if the existing code doesn\'t have the solution implemented. Making sure it has backward compatibility, no existing features removed. After making those changes, again review the applied changes. Use @web to search if you dont know any information or to find the latest documentation or to find the latest version. Run the code if you think you need to run it to test it. Minimal code change to start with if required any changes. MAINLY IT SHOULD NOT IMPACT ON THE CURRENT SPEED OF EXECUTION of existing features, not increasing the overhead. **Please create a PR using gh tool with your changes**.'
})
+4 -123
View File
@@ -1,142 +1,23 @@
name: Auto PR Comment
# Review chain: CodeRabbit/Qodo/Gemini review first → THEN trigger Copilot
# For human PRs: CodeRabbit/Qodo auto-review → this workflow triggers Copilot
# For bot PRs: CodeRabbit/Qodo skip bots, so we trigger them explicitly first
#
# IMPORTANT: @copilot ignores bot comments. All @copilot mentions must use
# PAT_TOKEN so the comment posts as MervinPraison (a real user).
on:
issue_comment:
types: [created]
pull_request_review:
types: [submitted]
pull_request:
types: [opened]
jobs:
# ================================================================
# HUMAN PRs: Trigger @copilot AFTER CodeRabbit posts its summary
# ================================================================
copilot-after-coderabbit:
if: |
github.event_name == 'issue_comment' &&
github.event.issue.pull_request &&
github.event.comment.user.login == 'coderabbitai[bot]' &&
contains(github.event.comment.body, 'summary by coderabbit')
add-comment:
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Post Copilot review request (as user via PAT)
- name: Add automated comment
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const comments = await github.rest.issues.listComments({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo
});
// Check for duplicates — posted by MervinPraison (PAT) or github-actions[bot] (legacy)
const alreadyPosted = comments.data.some(c =>
c.body.includes('@copilot') &&
(c.user.login === 'MervinPraison' || c.user.login === 'github-actions[bot]')
);
if (alreadyPosted) {
console.log('Copilot already triggered, skipping');
return;
}
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@copilot Do a thorough review of this PR. Read ALL existing reviewer comments above from Qodo, Coderabbit, and Gemini first — incorporate their findings.\n\nReview areas:\n1. **Bloat check**: Are changes minimal and focused? Any unnecessary code or scope creep?\n2. **Security**: Any hardcoded secrets, unsafe eval/exec, missing input validation?\n3. **Performance**: Any module-level heavy imports? Hot-path regressions?\n4. **Tests**: Are tests included? Do they cover the changes adequately?\n5. **Backward compat**: Any public API changes without deprecation?\n6. **Code quality**: DRY violations, naming conventions, error handling?\n7. **Address reviewer feedback**: If Qodo, Coderabbit, or Gemini flagged valid issues, include them in your review\n8. Suggest specific improvements with code examples where possible'
})
# Fallback: Trigger @copilot after Qodo review (if Coderabbit doesn't fire)
copilot-after-qodo:
if: |
github.event_name == 'pull_request_review' &&
github.event.review.user.login == 'qodo-code-review[bot]'
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Post Copilot review request (as user via PAT)
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const comments = await github.rest.issues.listComments({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo
});
const alreadyPosted = comments.data.some(c =>
c.body.includes('@copilot') &&
(c.user.login === 'MervinPraison' || c.user.login === 'github-actions[bot]')
);
if (alreadyPosted) {
console.log('Copilot already triggered, skipping');
return;
}
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@copilot Do a thorough review of this PR. Read ALL existing reviewer comments above first.\n\nReview areas:\n1. **Bloat check**: Are changes minimal and focused?\n2. **Security**: Any hardcoded secrets, unsafe eval/exec, missing input validation?\n3. **Performance**: Any module-level heavy imports? Hot-path regressions?\n4. **Tests**: Are tests included? Do they cover the changes adequately?\n5. **Backward compat**: Any public API changes without deprecation?\n6. **Code quality**: DRY violations, naming conventions, error handling?\n7. Suggest specific improvements with code examples where possible'
})
# ================================================================
# BOT PRs: CodeRabbit/Qodo skip bot-authored PRs by default.
# Trigger them explicitly. Do NOT trigger Copilot here — it will
# be triggered by copilot-after-coderabbit/qodo when they finish.
# ================================================================
bot-pr-trigger-reviews:
if: |
github.event_name == 'pull_request' &&
github.event.action == 'opened' &&
(
github.event.pull_request.user.login == 'github-actions[bot]' ||
github.event.pull_request.user.login == 'praisonai-triage-agent[bot]' ||
github.event.pull_request.user.type == 'Bot'
)
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Trigger CodeRabbit, Qodo, and Gemini reviews
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const pr = context.payload.pull_request.number;
const owner = context.repo.owner;
const repo = context.repo.repo;
// 1. Trigger CodeRabbit review
await github.rest.issues.createComment({
issue_number: pr, owner, repo,
body: '@coderabbitai review'
});
console.log(`Triggered CodeRabbit for bot PR #${pr}`);
// 2. Trigger Qodo review
await github.rest.issues.createComment({
issue_number: pr, owner, repo,
body: '/review'
});
console.log(`Triggered Qodo for bot PR #${pr}`);
// 3. Trigger Gemini review
await github.rest.issues.createComment({
issue_number: pr, owner, repo,
body: '@gemini review this PR'
});
console.log(`Triggered Gemini for bot PR #${pr}`);
// NOTE: @copilot is NOT triggered here.
// It will be triggered by copilot-after-coderabbit or copilot-after-qodo
// once those bots finish, ensuring Copilot always reviews LAST.
console.log('Copilot will be triggered after CodeRabbit/Qodo complete.');
body: '@claude review this pull request and do a detailed analysis and fix this if the existing code doesn\'t have the solution implemented. Making sure it has backward compatibility, no existing features removed. After making those changes, again review the applied changes. Use @web to search if you dont know any information or to find the latest documentation or to find the latest version. Run the code if you think you need to run it to test it. Minimal code change to start with if required any changes. MAINLY IT SHOULD NOT IMPACT ON THE CURRENT SPEED OF EXECUTION of existing features, not increasing the overhead.'
})
@@ -1,58 +0,0 @@
name: Chain Claude After Reviewers
# Event-driven: triggers when Copilot finishes reviewing a PR
on:
pull_request_review:
types: [submitted]
issue_comment:
types: [created]
jobs:
# Trigger Claude after Copilot finishes on a PR — Claude is the FINAL reviewer
# Claude reads ALL previous reviews (Qodo, Coderabbit, Copilot) and fixes any valid issues
claude-final-review:
if: |
(github.event_name == 'pull_request_review' && contains(github.event.review.user.login, 'copilot')) ||
(github.event_name == 'issue_comment' && contains(github.event.comment.user.login, 'copilot'))
runs-on: ubuntu-latest
permissions:
pull-requests: write
steps:
- name: Post Claude final review + fix request
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }}
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@claude You are the FINAL architecture reviewer. Read ALL comments above from Gemini, Qodo, CodeRabbit, and Copilot carefully before responding.\n\n**Phase 1: Review per AGENTS.md**\n1. Protocol-driven: check heavy implementations vs core SDK\n2. Backward compatible: ensure zero feature regressions\n3. Performance: no hot-path regressions\n\n**Phase 2: FIX Valid Issues**\n4. For any VALID bugs or architectural flaws found by Gemini, CodeRabbit, Qodo, Copilot, or any other reviewer: implement the fix\n5. Push all code fixes directly to THIS branch (do NOT create a new PR)\n6. Comment a summary of exact files modified and what you skipped\n\n**Phase 3: Final Verdict**\n7. If all issues are resolved, approve the PR / close the Issue\n8. If blocking issues remain, request changes / leave clear action items'
})
# Trigger Claude after Gemini finishes on an Issue or PR
claude-after-gemini:
if: |
github.event_name == 'issue_comment' &&
(
github.event.comment.user.login == 'gemini-code-assist[bot]' ||
contains(github.event.comment.body, 'Review completed by Gemini CLI') ||
contains(github.event.comment.body, 'The fix is ready for review. Please test')
)
runs-on: ubuntu-latest
permissions:
issues: write
pull-requests: write
steps:
- name: Post Claude analysis request (final reviewer)
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN || secrets.GITHUB_TOKEN }}
script: |
github.rest.issues.createComment({
issue_number: context.issue.number,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@claude You are the Lead Engineer. Read ALL analysis and reviews above carefully (Gemini, CodeRabbit, Qodo, Copilot, etc).\n\n**Phase 1: Review per AGENTS.md**\n1. Protocol-driven: check heavy implementations vs core SDK\n2. Backward compatible: ensure zero feature regressions\n3. Performance: no hot-path regressions\n\n**Phase 2: FIX Valid Issues**\n4. For any VALID bugs or architectural flaws found by Gemini, CodeRabbit, Qodo, Copilot, or any other reviewer: implement the fix\n5. Push all code fixes directly to THIS branch (do NOT create a new PR)\n6. Comment a summary of exact files modified and what you skipped\n\n**Phase 3: Final Verdict**\n7. If all issues are resolved, approve the PR / close the Issue\n8. If blocking issues remain, request changes / leave clear action items'
})
+4 -13
View File
@@ -2,9 +2,8 @@ name: Claude Issue Triage
description: "Automatically triage GitHub issues using Claude Code"
on:
workflow_dispatch:
# issues:
# types: [opened]
issues:
types: [opened]
jobs:
triage-issue:
@@ -13,20 +12,12 @@ jobs:
permissions:
contents: read
issues: write
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4
- name: Generate GitHub App Token
id: app-token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ secrets.CLAUDE_APP_ID }}
private-key: ${{ secrets.CLAUDE_APP_PRIVATE_KEY }}
- name: Run Claude Issue Triage
uses: ./.github/actions/claude-issue-triage-action
with:
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
github_token: ${{ steps.app-token.outputs.token }}
anthropic_api_key: ${{ secrets.ANTHROPIC_API_KEY }}
github_token: ${{ secrets.GITHUB_TOKEN }}
+109 -56
View File
@@ -6,85 +6,35 @@ on:
pull_request_review_comment:
types: [created]
issues:
types: [assigned, labeled, opened]
types: [opened, assigned, labeled]
pull_request_review:
types: [submitted]
jobs:
claude-response:
# Allow: human users, github-actions[bot] (auto-comments/labels)
# Block: dependabot, cursor, renovate, other bots
# Prevent certain bots from triggering this action (but allow github-actions[bot] for auto-comments)
if: |
(github.event.action != 'labeled' || github.event.label.name == 'claude') &&
(github.event_name != 'issue_comment' || contains(github.event.comment.body, '@claude')) &&
(
!contains(github.actor, '[bot]') ||
github.actor == 'github-actions[bot]' ||
github.actor == 'praisonai-triage-agent[bot]'
) &&
github.actor != 'dependabot[bot]' &&
github.actor != 'cursor[bot]' &&
github.actor != 'renovate[bot]'
github.actor != 'renovate[bot]' &&
!(contains(github.actor, '[bot]') && github.actor != 'github-actions[bot]')
runs-on: ubuntu-latest
permissions:
contents: write
pull-requests: write
issues: write
actions: read
id-token: write
steps:
- name: Checkout repository
uses: actions/checkout@v4
with:
fetch-depth: 0
- name: Generate GitHub App Token
id: app-token
uses: actions/create-github-app-token@v1
with:
app-id: ${{ secrets.CLAUDE_APP_ID }}
private-key: ${{ secrets.CLAUDE_APP_PRIVATE_KEY }}
- uses: anthropics/claude-code-action@beta
with:
claude_code_oauth_token: ${{ secrets.CLAUDE_CODE_OAUTH_TOKEN }}
github_token: ${{ steps.app-token.outputs.token }}
claude_code_oauth_token: ${{ secrets.CLAUDE_ACCESS_TOKEN }}
github_token: ${{ secrets.GITHUB_TOKEN }}
trigger_phrase: "@claude"
label_trigger: "claude"
allowed_non_write_users: "*"
direct_prompt: |
You are working on the PraisonAI SDK. Follow AGENTS.md strictly.
STEP 0 — SETUP GIT IDENTITY:
git config user.name "MervinPraison"
git config user.email "[email protected]"
STEP 1 — READ GUIDELINES:
Read AGENTS.md to understand the architecture rules.
STEP 2 — ARCHITECTURE VALIDATION (MANDATORY before writing code):
Before implementing anything, answer these questions:
- Does this add heavy implementations to the core SDK (praisonaiagents)? If YES → move it to the wrapper (praisonai) or make it a plugin.
- Does it duplicate existing functionality? Check if Agent already supports this via existing params (reflection, planning, tools, hooks, memory).
- Does it inherit from Agent properly? New agent types MUST inherit Agent, not wrap it with composition.
- Does it add new dependencies? Only optional deps allowed, must be lazy-imported.
- Will agent.py grow larger? If the change adds >50 lines to agent.py, find a way to extract instead.
- Is there a name collision with existing exports in __init__.py?
If ANY of these checks fail, add a comment to the issue explaining why and close it. Do NOT create a PR.
STEP 3 — IMPLEMENT:
- Create a fix branch and implement a minimal, focused fix
- Follow protocol-driven design: protocols in core SDK, heavy implementations in wrapper
- Keep changes small and backward-compatible
STEP 4 — TEST:
- Run: cd src/praisonai-agents && PYTHONPATH=. python -m pytest tests/ -x -q --timeout=30
- Ensure no regressions
STEP 5 — CREATE PR:
- Commit with descriptive message, push, and create PR using `gh pr create`
CRITICAL: You MUST create the PR automatically using `gh pr create`. Do NOT just provide a link.
allowed_tools: |
Bash(git:*)
Bash(python:*)
@@ -105,3 +55,106 @@ jobs:
mcp__github__get_issue_comments
mcp__github__update_issue
timeout_minutes: 30
post-review-comment:
needs: claude-response
if: success() && needs.claude-response.result == 'success'
runs-on: ubuntu-latest
permissions:
contents: read
pull-requests: write
issues: write
steps:
- name: Check for existing review comment
id: check-comment
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
const reviewText = '@claude review if the changes made in the above branch are as per the requirements and make changes to the above branch if issues still exist.';
let comments = [];
let issueNumber;
try {
// Determine issue/PR number based on event type
if (context.eventName === 'pull_request_review_comment' || context.eventName === 'pull_request_review') {
issueNumber = context.payload.pull_request?.number || context.issue.number;
} else if (context.eventName === 'issue_comment' && context.payload.issue.pull_request) {
// This is a comment on a PR (not an issue)
issueNumber = context.payload.issue.number;
} else {
// This is a regular issue
issueNumber = context.issue.number;
}
comments = await github.rest.issues.listComments({
owner: context.repo.owner,
repo: context.repo.repo,
issue_number: issueNumber
});
// Look for Claude's completed review comments
const claudeReviewComments = comments.data.filter(comment =>
(comment.user.login === 'claude[bot]' || comment.body.includes('✅') || comment.body.includes('## Summary')) &&
!comment.body.includes('⏳') &&
!comment.body.includes('🔄') &&
!comment.body.includes('Loading...')
);
// Check if our review request comment already exists
const existingReviewRequest = comments.data.find(comment =>
comment.body.includes(reviewText)
);
// Post if Claude has completed a review AND we haven't posted the review request yet
const shouldPost = claudeReviewComments.length > 0 && !existingReviewRequest;
core.setOutput('should-post', shouldPost);
console.log(`Claude review completed: ${claudeReviewComments.length > 0}`);
console.log(`Review request exists: ${!!existingReviewRequest}`);
console.log(`Should post comment: ${shouldPost}`);
} catch (error) {
console.log('Error checking comments:', error);
core.setOutput('should-post', false); // If we can't check, don't post
}
- name: Wait 30 seconds before posting comment
if: steps.check-comment.outputs.should-post == 'true'
run: sleep 30
- name: Post review comment
if: steps.check-comment.outputs.should-post == 'true'
uses: actions/github-script@v7
with:
github-token: ${{ secrets.GH_TOKEN }}
script: |
let issueNumber;
let isPR = false;
// Determine issue/PR number and type based on event type
if (context.eventName === 'pull_request_review_comment' || context.eventName === 'pull_request_review') {
issueNumber = context.payload.pull_request?.number || context.issue.number;
isPR = true;
} else if (context.eventName === 'issue_comment' && context.payload.issue.pull_request) {
// This is a comment on a PR (not an issue)
issueNumber = context.payload.issue.number;
isPR = true;
} else {
// This is a regular issue - don't post review comment
issueNumber = context.issue.number;
isPR = false;
}
// Only post review comment on PRs, not regular issues
if (isPR) {
console.log(`Posting review comment on PR #${issueNumber}`);
await github.rest.issues.createComment({
issue_number: issueNumber,
owner: context.repo.owner,
repo: context.repo.repo,
body: '@claude review if the changes made in the above branch are as per the requirements and make changes to the above branch if issues still exist. MAINLY IT SHOULD NOT IMPACT ON THE CURRENT SPEED OF EXECUTION of existing features, not increasing the overhead.'
});
} else {
console.log(`Skipping review comment for regular issue #${issueNumber}`);
}
+62
View File
@@ -0,0 +1,62 @@
name: Run tests and upload coverage
on:
push:
branches: [ main, develop ]
pull_request:
branches: [ main, develop ]
jobs:
test:
name: Run tests and collect coverage
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- name: Checkout
uses: actions/checkout@v4
with:
fetch-depth: 2
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Install UV
run: |
curl -LsSf https://astral.sh/uv/install.sh | sh
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Install dependencies
run: |
cd src/praisonai
uv pip install --system ."[ui,gradio,api,agentops,google,openai,anthropic,cohere,chat,code,realtime,call,crewai,autogen]"
uv pip install --system duckduckgo_search
uv pip install --system pytest pytest-cov pytest-asyncio
# Install knowledge dependencies from praisonai-agents
uv pip install --system "praisonaiagents[knowledge]"
- name: Set environment variables
run: |
echo "OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY || 'sk-test-key-for-github-actions-testing-only-not-real' }}" >> $GITHUB_ENV
echo "OPENAI_API_BASE=${{ secrets.OPENAI_API_BASE || 'https://api.openai.com/v1' }}" >> $GITHUB_ENV
echo "OPENAI_MODEL_NAME=${{ secrets.OPENAI_MODEL_NAME || 'gpt-5-nano' }}" >> $GITHUB_ENV
echo "LOGLEVEL=DEBUG" >> $GITHUB_ENV
echo "PYTHONPATH=${{ github.workspace }}/src/praisonai-agents:$PYTHONPATH" >> $GITHUB_ENV
- name: Run tests
run: |
cd src/praisonai
# Run tests - allow some failures for now while we fix remaining issues
pytest --cov=praisonai --cov-branch --cov-report=xml tests/unit/ --tb=no -q || echo "Some tests failed, but coverage was collected"
- name: Upload results to Codecov
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: src/praisonai/coverage.xml
flags: unit-tests
name: unit-tests-coverage
fail_ci_if_error: false
verbose: true
@@ -1,10 +1,8 @@
name: Gemini Automated Issue Triage
# on:
# issue_comment:
# types: [created]
on:
workflow_dispatch:
issue_comment:
types: [created]
jobs:
triage-issue:
+16 -14
View File
@@ -2,8 +2,8 @@ name: Gemini Issue Review
on:
workflow_dispatch:
# issue_comment:
# types: [created]
issue_comment:
types: [created]
permissions:
contents: write
@@ -20,8 +20,7 @@ jobs:
!contains(github.event.comment.body, '@gemini triage') &&
(github.event.comment.author_association == 'OWNER' ||
github.event.comment.author_association == 'MEMBER' ||
github.event.comment.author_association == 'COLLABORATOR' ||
github.event.comment.author_association == 'CONTRIBUTOR'))
github.event.comment.author_association == 'COLLABORATOR'))
runs-on: ubuntu-latest
env:
GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
@@ -40,8 +39,8 @@ jobs:
- name: Set up Git
run: |
git config --local user.email "[email protected].github.com"
git config --local user.name "MervinPraison"
git config --local user.email "gemini-bot@github.com"
git config --local user.name "Gemini Bot"
- name: Get issue data
id: issue_data
@@ -76,16 +75,16 @@ jobs:
echo "ADDITIONAL_INSTRUCTIONS=$ADDITIONAL_INSTRUCTIONS" >> $GITHUB_OUTPUT
- name: Run Gemini CLI
uses: google-github-actions/run-gemini-cli@v0
uses: ./.github/actions/gemini
env:
GH_TOKEN: ${{ steps.generate_token.outputs.token }}
GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
ISSUE_NUMBER: ${{ steps.issue_data.outputs.ISSUE_NUMBER }}
ADDITIONAL_INSTRUCTIONS: ${{ steps.issue_data.outputs.ADDITIONAL_INSTRUCTIONS }}
REPOSITORY: ${{ github.repository }}
with:
gemini_api_key: ${{ secrets.GEMINI_API_KEY }}
gemini_model: 'gemini-2.5-flash'
GEMINI_API_KEY: ${{ secrets.GEMINI_API_KEY }}
OTLP_GCP_WIF_PROVIDER: ${{ secrets.OTLP_GCP_WIF_PROVIDER }}
OTLP_GOOGLE_CLOUD_PROJECT: ${{ secrets.OTLP_GOOGLE_CLOUD_PROJECT }}
prompt: |
You are a helpful GitHub issue assistant. Your task is to analyze and help with GitHub issues.
@@ -104,8 +103,6 @@ jobs:
- Search codebase for related files using `glob`, `search_file_content`, `list_directory`
**STEP 2: If Code Changes Are Needed**
MANDATORY FIRST STEP: Before writing any code, you MUST use `read_file` to carefully read "src/praisonai-agents/AGENTS.md". You must honor this repository's extremely specific Architecture, Protocol-First design rules, and Agent-Centric Philosophy!
Create a new branch with 'gemini/' prefix:
- Use: `git checkout -b gemini/issue-${ISSUE_NUMBER}-description`
- Example: `git checkout -b gemini/issue-123-fix-sequential-tools`
@@ -164,7 +161,7 @@ jobs:
Please proceed with helping resolve this issue following this exact workflow.
settings: |
settings_json: |
{
"coreTools": [
"run_shell_command(echo)",
@@ -196,5 +193,10 @@ jobs:
"web_fetch",
"google_web_search",
"save_memory"
]
],
"telemetry": {
"enabled": false,
"otlpGcpWifProvider": "${{ secrets.OTLP_GCP_WIF_PROVIDER }}",
"googleCloudProject": "${{ secrets.OTLP_GOOGLE_CLOUD_PROJECT }}"
}
}
+2 -4
View File
@@ -1,8 +1,8 @@
name: Gemini PR Review
on:
# issue_comment:
# types: [created]
issue_comment:
types: [created]
workflow_dispatch:
inputs:
pr_number:
@@ -159,8 +159,6 @@ jobs:
- Analyze the code changes thoroughly
**STEP 2: If Code Improvements Are Needed**
MANDATORY FIRST STEP: Before writing any code, you MUST use `read_file` to carefully read "src/praisonai-agents/AGENTS.md". You must honor this repository's extremely specific Architecture, Protocol-First design rules, and Agent-Centric Philosophy!
**IMPORTANT:** DO NOT create a new branch! Work on the EXISTING PR branch.
- Use: `git fetch origin` to get latest changes
- Get PR branch name: `gh pr view ${PR_NUMBER} --json headRefName`
+38 -11
View File
@@ -1,21 +1,25 @@
name: Python Package (Multi-Version)
# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
name: Python package
on:
schedule:
- cron: '0 4 * * 1' # Weekly Monday 4am UTC
workflow_dispatch:
push:
branches: [ "develop" ]
pull_request:
branches: [ "develop" ]
jobs:
build:
runs-on: ubuntu-latest
strategy:
fail-fast: false
matrix:
python-version: ["3.10", "3.11", "3.12"]
python-version: ["3.10", "3.11"]
steps:
- uses: actions/checkout@v4
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
@@ -26,16 +30,39 @@ jobs:
echo "OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY || 'sk-test-key-for-github-actions-testing-only-not-real' }}" >> $GITHUB_ENV
echo "OPENAI_API_BASE=${{ secrets.OPENAI_API_BASE || 'https://api.openai.com/v1' }}" >> $GITHUB_ENV
echo "OPENAI_MODEL_NAME=${{ secrets.OPENAI_MODEL_NAME || 'gpt-5-nano' }}" >> $GITHUB_ENV
echo "PYTHONPATH=${{ github.workspace }}/src/praisonai-agents:$PYTHONPATH" >> $GITHUB_ENV
echo "LOGLEVEL=DEBUG" >> $GITHUB_ENV
- name: Install dependencies
run: |
cd src/praisonai
python -m pip install --upgrade pip
python -m pip install flake8 pytest
python -m pip install ."[ui,gradio,api,agentops,google,openai,anthropic,cohere,chat,code,realtime,call,crewai,autogen]"
python -m pip install duckduckgo_search pytest pytest-asyncio pytest-cov
python -m pip install duckduckgo_search
python -m pip install pytest-asyncio pytest-cov
# Install knowledge dependencies from praisonai-agents
python -m pip install "praisonaiagents[knowledge]"
- name: Run tests
if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
- name: Debug API Key Status
run: |
cd src/praisonai && python -m pytest tests/unit/ -v --tb=short --disable-warnings --timeout=60 || echo "Some tests failed"
echo "🔍 Checking API key availability..."
if [ -n "${{ secrets.OPENAI_API_KEY }}" ]; then
echo "✅ GitHub secret OPENAI_API_KEY is available"
echo "🔑 API key starts with: $(echo "$OPENAI_API_KEY" | cut -c1-7)..."
else
echo "⚠️ GitHub secret OPENAI_API_KEY is NOT set - using fallback"
echo "🔑 Using fallback key: sk-test-key..."
fi
echo "🌐 API Base: $OPENAI_API_BASE"
echo "🤖 Model: $OPENAI_MODEL_NAME"
# - 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: |
cd src/praisonai && python tests/test_runner.py --pattern fast
+4 -4
View File
@@ -51,8 +51,8 @@ jobs:
# Sync with upstream commit
- name: Sync with upstream
run: |
git config --global user.name "MervinPraison"
git config --global user.email "[email protected].github.com"
git config --global user.name "GitHub Actions"
git config --global user.email "actions@github.com"
# Add upstream remote
git remote add upstream https://github.com/MervinPraison/PraisonAI.git
@@ -473,8 +473,8 @@ jobs:
# Create tag at the same commit
- name: Create tag at commit
run: |
git config --global user.name "MervinPraison"
git config --global user.email "[email protected].github.com"
git config --global user.name "GitHub Actions"
git config --global user.email "actions@github.com"
# Remove tag if it exists locally
git tag -d ${{ github.event.inputs.tag }} || true
+244 -29
View File
@@ -1,44 +1,41 @@
name: Core Tests
on:
on:
push:
branches: [ main, develop ]
paths:
- 'src/**'
- 'pyproject.toml'
- '.github/workflows/test-core.yml'
pull_request:
branches: [ main, develop ]
paths:
- 'src/**'
- 'pyproject.toml'
- '.github/workflows/test-core.yml'
workflow_dispatch:
jobs:
test-core:
runs-on: ubuntu-latest
timeout-minutes: 20
timeout-minutes: 15
strategy:
matrix:
python-version: [3.11]
steps:
- uses: actions/checkout@v4
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python 3.11
- name: Set up Python ${{ matrix.python-version }}
uses: actions/setup-python@v5
with:
python-version: '3.11'
python-version: ${{ matrix.python-version }}
- name: Install UV
run: |
curl -LsSf https://astral.sh/uv/install.sh | sh
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Install dependencies
run: |
cd src/praisonai
uv pip install --system ."[ui,gradio,api,agentops,google,openai,anthropic,cohere,chat,code,realtime,call,crewai,autogen]"
uv pip install --system duckduckgo_search
uv pip install --system pytest pytest-asyncio pytest-cov pytest-timeout
# Install knowledge dependencies from praisonai-agents
uv pip install --system "praisonaiagents[knowledge]"
- name: Set environment variables
@@ -46,28 +43,246 @@ jobs:
echo "OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY || 'sk-test-key-for-github-actions-testing-only-not-real' }}" >> $GITHUB_ENV
echo "OPENAI_API_BASE=${{ secrets.OPENAI_API_BASE || 'https://api.openai.com/v1' }}" >> $GITHUB_ENV
echo "OPENAI_MODEL_NAME=${{ secrets.OPENAI_MODEL_NAME || 'gpt-5-nano' }}" >> $GITHUB_ENV
echo "LOGLEVEL=DEBUG" >> $GITHUB_ENV
echo "PYTHONPATH=${{ github.workspace }}/src/praisonai-agents:$PYTHONPATH" >> $GITHUB_ENV
# Also export to current shell session for immediate availability
export OPENAI_API_KEY="${{ secrets.OPENAI_API_KEY || 'sk-test-key-for-github-actions-testing-only-not-real' }}"
export OPENAI_API_BASE="${{ secrets.OPENAI_API_BASE || 'https://api.openai.com/v1' }}"
export OPENAI_MODEL_NAME="${{ secrets.OPENAI_MODEL_NAME || 'gpt-5-nano' }}"
export LOGLEVEL=DEBUG
# Verify immediate availability
echo "🔧 Immediate verification in same step:"
echo " OPENAI_API_KEY length in current session: ${#OPENAI_API_KEY}"
echo " OPENAI_API_KEY starts with sk-: $(echo "$OPENAI_API_KEY" | grep -q '^sk-' && echo 'YES' || echo 'NO')"
- name: Debug API Key Status
run: |
echo "🔍 Checking API key availability..."
if [ -n "${{ secrets.OPENAI_API_KEY }}" ]; then
echo "✅ GitHub secret OPENAI_API_KEY is available"
echo "🔑 API key starts with: $(echo "$OPENAI_API_KEY" | cut -c1-7)..."
else
echo "⚠️ GitHub secret OPENAI_API_KEY is NOT set - using fallback"
echo "🔑 Using fallback key: sk-test-key..."
fi
echo "🌐 API Base: $OPENAI_API_BASE"
echo "🤖 Model: $OPENAI_MODEL_NAME"
echo "🐛 Log Level: $LOGLEVEL"
echo "📊 Environment Check:"
echo " - OPENAI_API_KEY length: ${#OPENAI_API_KEY}"
echo " - OPENAI_API_BASE: $OPENAI_API_BASE"
echo " - OPENAI_MODEL_NAME: $OPENAI_MODEL_NAME"
echo " - LOGLEVEL: $LOGLEVEL"
echo "🔍 Is API key actually set?"
echo " - API key starts with sk-: $(echo "$OPENAI_API_KEY" | grep -q '^sk-' && echo 'YES' || echo 'NO')"
echo " - API key is not test key: $([ "$OPENAI_API_KEY" != 'sk-test-key-for-github-actions-testing-only-not-real' ] && echo 'YES' || echo 'NO')"
- name: Debug Environment Variables Raw
run: |
echo "🔧 Raw environment variable check:"
echo "OPENAI_API_KEY set: $(if [ -n "$OPENAI_API_KEY" ]; then echo 'YES'; else echo 'NO'; fi)"
echo "OPENAI_API_KEY length: ${#OPENAI_API_KEY}"
echo "OPENAI_API_KEY first 10 chars: ${OPENAI_API_KEY:0:10}"
echo "OPENAI_API_KEY last 5 chars: ${OPENAI_API_KEY: -5}"
printenv | grep OPENAI || echo "No OPENAI env vars found"
- name: Debug Python Environment Variables
run: |
python -c "
import os
print('🐍 Python Environment Variable Check:')
api_key = os.environ.get('OPENAI_API_KEY', 'NOT_SET')
if api_key != 'NOT_SET':
print(f' ✅ OPENAI_API_KEY: {api_key[:7]}... (length: {len(api_key)})')
else:
print(' ❌ OPENAI_API_KEY: NOT_SET')
print(f' 🌐 OPENAI_API_BASE: {os.environ.get(\"OPENAI_API_BASE\", \"NOT_SET\")}')
print(f' 🤖 OPENAI_MODEL_NAME: {os.environ.get(\"OPENAI_MODEL_NAME\", \"NOT_SET\")}')
print(f' 📋 All OPENAI env vars:')
for key, value in os.environ.items():
if key.startswith('OPENAI'):
print(f' {key}: {value[:10] if len(value) > 10 else value}...')
"
- name: Validate API Key
run: |
echo "🔑 Testing API key validity with minimal OpenAI call..."
python -c "
import os
try:
from openai import OpenAI
client = OpenAI(api_key=os.environ.get('OPENAI_API_KEY'))
response = client.models.list()
print('✅ API Key is VALID - OpenAI responded successfully')
print(f'📊 Available models: {len(list(response.data))} models found')
except Exception as e:
print(f'❌ API Key is INVALID - Error: {e}')
print('🔍 This explains why all API-dependent tests are failing')
print('💡 The GitHub secret OPENAI_API_KEY needs to be updated with a valid key')
"
continue-on-error: true
- name: Debug PraisonAI API Key Usage
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY || 'sk-test-key-for-github-actions-testing-only-not-real' }}
OPENAI_API_BASE: ${{ secrets.OPENAI_API_BASE || 'https://api.openai.com/v1' }}
OPENAI_MODEL_NAME: ${{ secrets.OPENAI_MODEL_NAME || 'gpt-5-nano' }}
LOGLEVEL: DEBUG
run: |
echo "🔍 Testing PraisonAI API key usage directly..."
cd src/praisonai
python -c "
import os
import sys
sys.path.insert(0, '.')
# Attempt to import SecretStr, otherwise use a dummy class
try:
from pydantic.types import SecretStr
except ImportError:
class SecretStr: # Dummy class if pydantic is not available in this minimal context
def __init__(self, value): self._value = value
def get_secret_value(self): return self._value
def get_key_display_value(key_value):
if isinstance(key_value, SecretStr):
return key_value.get_secret_value()[:10] if key_value.get_secret_value() else 'EMPTY_SECRET'
elif isinstance(key_value, str):
return key_value[:10] if key_value != 'nokey' and key_value != 'NOT_SET' else key_value
return 'INVALID_TYPE'
print('🔧 Direct PraisonAI API Key Check:')
env_api_key = os.environ.get(\"OPENAI_API_KEY\", \"NOT_SET\")
print(f'Environment OPENAI_API_KEY: {get_key_display_value(env_api_key)}...')
from praisonai import PraisonAI
praisonai = PraisonAI()
print(f'PraisonAI config_list: {praisonai.config_list}')
api_key_from_config = praisonai.config_list[0].get('api_key', 'NOT_SET')
print(f'API key from PraisonAI config: {get_key_display_value(api_key_from_config)}...')
from praisonai.inc.models import PraisonAIModel
print('\\n🧪 Testing PraisonAIModel with explicit API key (CrewAI method):')
model_with_explicit_key = PraisonAIModel(
model='openai/gpt-5-nano',
base_url=praisonai.config_list[0].get('base_url'),
api_key=api_key_from_config # This will be a string from praisonai.config_list
)
print(f' Model: {model_with_explicit_key.model}')
print(f' Model name: {model_with_explicit_key.model_name}')
print(f' API key var: {model_with_explicit_key.api_key_var}')
# model_with_explicit_key.api_key is now a string, or 'nokey'
print(f' API key (explicitly passed to PraisonAIModel): {get_key_display_value(model_with_explicit_key.api_key)}...')
print(f' Base URL: {model_with_explicit_key.base_url}')
try:
llm_instance = model_with_explicit_key.get_model()
print(f' ✅ LLM instance created successfully: {type(llm_instance).__name__}')
# langchain_openai.ChatOpenAI stores the key in openai_api_key as SecretStr
llm_api_key_attr = getattr(llm_instance, 'openai_api_key', 'NOT_FOUND')
if llm_api_key_attr != 'NOT_FOUND':
print(f' LLM instance API key: {get_key_display_value(llm_api_key_attr)}...')
else:
print(f' LLM instance API key attribute not found.')
except Exception as e:
print(f' ❌ Failed to create LLM instance: {e}')
import traceback
traceback.print_exc()
"
continue-on-error: true
- name: Run Unit Tests
run: |
cd src/praisonai && python -m pytest tests/unit/ -v --tb=short --disable-warnings \
--cov=praisonai --cov-report=xml --cov-branch \
--timeout=60 || echo "Some unit tests failed"
cd src/praisonai && python -m pytest tests/unit/ -v --tb=short --disable-warnings --cov=praisonai --cov-report=term-missing --cov-report=xml --cov-branch || echo "Some tests failed - see output above"
continue-on-error: true
- name: Run Integration Tests
- name: Run Integration Tests
run: |
cd src/praisonai && python -m pytest tests/integration/ -v --tb=short --disable-warnings \
--timeout=60 \
--ignore=tests/integration/test_tracker_complex_tasks.py \
--ignore=tests/integration/test_serve_integration.py \
|| echo "Some integration tests failed"
cd src/praisonai && python -m pytest tests/integration/ -v --tb=short --disable-warnings
- name: Upload coverage to Codecov
if: always()
- name: Debug Directory Structure
run: |
echo "🔍 Debugging directory structure for CrewAI tests..."
cd src/praisonai
echo "Current working directory: $(pwd)"
echo "📁 Contents of current directory:"
ls -la
echo ""
echo "📁 Contents of tests directory:"
ls -la tests/ || echo "❌ tests/ directory not found"
echo ""
echo "📁 Contents of tests/integration:"
ls -la tests/integration/ || echo "❌ tests/integration/ directory not found"
echo ""
echo "📁 Looking for crewai directory:"
find . -name "crewai" -type d 2>/dev/null || echo "❌ No crewai directories found"
echo ""
echo "📁 Full directory tree of tests:"
tree tests/ || find tests/ -type d 2>/dev/null || echo "❌ Cannot explore tests directory"
- name: Test AutoGen Framework
run: |
echo "🤖 Testing AutoGen Framework Integration..."
cd src/praisonai && python tests/test_runner.py --pattern autogen --verbose
- name: Test CrewAI Framework
run: |
echo "⛵ Testing CrewAI Framework Integration..."
cd src/praisonai
echo "🔍 Trying test runner first..."
python tests/test_runner.py --pattern crewai --verbose || {
echo "❌ Test runner failed, trying direct pytest..."
echo "📁 Current directory: $(pwd)"
echo "📁 Looking for CrewAI tests..."
find . -name "*crewai*" -type f 2>/dev/null
echo "🧪 Trying direct pytest on integration/crewai..."
python -m pytest tests/integration/crewai/ -v --tb=short --disable-warnings || {
echo "❌ Direct path failed, trying relative path..."
python -m pytest integration/crewai/ -v --tb=short --disable-warnings || {
echo "❌ All CrewAI test attempts failed"
exit 1
}
}
}
- name: Run Legacy Tests with API Key
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY || 'sk-test-key-for-github-actions-testing-only-not-real' }}
OPENAI_API_BASE: ${{ secrets.OPENAI_API_BASE || 'https://api.openai.com/v1' }}
OPENAI_MODEL_NAME: ${{ secrets.OPENAI_MODEL_NAME || 'gpt-5-nano' }}
LOGLEVEL: DEBUG
run: |
echo "🧪 Running legacy tests with real API key..."
echo "🔧 Final environment check before pytest:"
echo " OPENAI_API_KEY set: $([ -n "$OPENAI_API_KEY" ] && echo 'YES' || echo 'NO')"
echo " OPENAI_API_KEY length: ${#OPENAI_API_KEY}"
echo " OPENAI_API_KEY starts with sk-: $(echo "$OPENAI_API_KEY" | grep -q '^sk-' && echo 'YES' || echo 'NO')"
export OPENAI_API_KEY="$OPENAI_API_KEY"
export OPENAI_API_BASE="$OPENAI_API_BASE"
export OPENAI_MODEL_NAME="$OPENAI_MODEL_NAME"
cd src/praisonai && python -m pytest tests/test.py -v --tb=short --disable-warnings -m "not real" --timeout=60
- name: Upload coverage reports to Codecov
if: matrix.python-version == '3.11'
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN || '' }}
files: src/praisonai/coverage.xml
token: ${{ secrets.CODECOV_TOKEN }}
file: src/praisonai/coverage.xml
flags: core-tests
fail_ci_if_error: false
name: core-tests-coverage
fail_ci_if_error: false
verbose: true
- name: Upload Coverage Reports (Artifacts)
if: matrix.python-version == '3.11'
uses: actions/upload-artifact@v4
with:
name: coverage-reports
path: |
src/praisonai/.coverage
src/praisonai/htmlcov/
src/praisonai/coverage.xml
retention-days: 7
+6 -1
View File
@@ -1,9 +1,14 @@
name: Extended Tests
on:
push:
branches: [ main ]
pull_request:
branches: [ main ]
schedule:
# Run nightly at 2 AM UTC
- cron: '0 2 * * *'
workflow_dispatch:
workflow_dispatch: # Allow manual triggering
jobs:
test-examples:
+6 -22
View File
@@ -3,16 +3,8 @@ name: Optimized Test Suite
on:
push:
branches: [ main, develop ]
paths:
- 'src/**'
- 'pyproject.toml'
- '.github/workflows/test-optimized.yml'
pull_request:
branches: [ main, develop ]
paths:
- 'src/**'
- 'pyproject.toml'
- '.github/workflows/test-optimized.yml'
schedule:
# Nightly extended tests at 3 AM UTC
- cron: '0 3 * * *'
@@ -157,8 +149,8 @@ jobs:
if: matrix.python-version == '3.11'
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN || '' }}
files: src/praisonai/coverage.xml
token: ${{ secrets.CODECOV_TOKEN }}
file: src/praisonai/coverage.xml
flags: main-tests
fail_ci_if_error: false
@@ -301,10 +293,8 @@ jobs:
steps:
- name: Check if Google key is available
id: check-key
env:
GOOGLE_API_KEY: ${{ secrets.GOOGLE_API_KEY }}
run: |
if [ -n "$GOOGLE_API_KEY" ]; then
if [ -n "${{ secrets.GOOGLE_API_KEY }}" ]; then
echo "has_key=true" >> $GITHUB_OUTPUT
else
echo "has_key=false" >> $GITHUB_OUTPUT
@@ -358,10 +348,8 @@ jobs:
steps:
- name: Check if Groq key is available
id: check-key
env:
GROQ_API_KEY: ${{ secrets.GROQ_API_KEY }}
run: |
if [ -n "$GROQ_API_KEY" ]; then
if [ -n "${{ secrets.GROQ_API_KEY }}" ]; then
echo "has_key=true" >> $GITHUB_OUTPUT
else
echo "has_key=false" >> $GITHUB_OUTPUT
@@ -415,10 +403,8 @@ jobs:
steps:
- name: Check if xAI key is available
id: check-key
env:
XAI_API_KEY: ${{ secrets.XAI_API_KEY }}
run: |
if [ -n "$XAI_API_KEY" ]; then
if [ -n "${{ secrets.XAI_API_KEY }}" ]; then
echo "has_key=true" >> $GITHUB_OUTPUT
else
echo "has_key=false" >> $GITHUB_OUTPUT
@@ -472,10 +458,8 @@ jobs:
steps:
- name: Check if Cohere key is available
id: check-key
env:
COHERE_API_KEY: ${{ secrets.COHERE_API_KEY }}
run: |
if [ -n "$COHERE_API_KEY" ]; then
if [ -n "${{ secrets.COHERE_API_KEY }}" ]; then
echo "has_key=true" >> $GITHUB_OUTPUT
else
echo "has_key=false" >> $GITHUB_OUTPUT
+13 -14
View File
@@ -3,16 +3,8 @@ name: Windows Tests
on:
push:
branches: [main, develop]
paths:
- 'src/**'
- 'pyproject.toml'
- '.github/workflows/test-windows.yml'
pull_request:
branches: [main, develop]
paths:
- 'src/**'
- 'pyproject.toml'
- '.github/workflows/test-windows.yml'
workflow_dispatch:
jobs:
@@ -22,7 +14,6 @@ jobs:
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
OPENAI_MODEL_NAME: gpt-4o-mini
PYTHONUTF8: 1
steps:
- uses: actions/checkout@v4
@@ -36,13 +27,13 @@ jobs:
run: |
python -m pip install --upgrade pip
cd src/praisonai-agents
pip install -e .
pip install .
shell: bash
- name: Install praisonai wrapper
run: |
cd src/praisonai
pip install -e .
pip install .[dev]
shell: bash
# ==================== CORE IMPORTS ====================
@@ -50,7 +41,7 @@ jobs:
run: |
python -c "from praisonaiagents import Agent, Agents, Workflow; print('Core imports OK')"
python -c "from praisonaiagents import tool, Tools; print('Tool imports OK')"
python -c "from praisonaiagents import Task; print('Task imports OK')"
python -c "from praisonaiagents import Task, WorkflowStep; print('Task/Step imports OK')"
# ==================== AGENT FEATURES ====================
- name: Test Agent instantiation
@@ -75,13 +66,21 @@ jobs:
"
# ==================== WORKFLOW FEATURES ====================
- name: Test Workflow
- name: Test Workflow and WorkflowStep
run: |
python -c "
from praisonaiagents import Workflow
from praisonaiagents import Workflow, WorkflowStep
from praisonaiagents.workflows import WorkflowOutputConfig
w = Workflow(name='test')
s1 = WorkflowStep(name='step1')
s2 = WorkflowStep(name='step2', context=['step1'])
print('Workflow:', w.name)
print('Steps:', s1.name, s2.name)
cfg = WorkflowOutputConfig(verbose=True, stream=False)
w2 = Workflow(name='configured', output=cfg)
print('Configured workflow verbose:', w2.verbose)
"
# ==================== MEMORY FEATURES ====================
+516
View File
@@ -0,0 +1,516 @@
name: Quick Validation Tests
on: [push, pull_request]
jobs:
quick-test:
runs-on: ubuntu-latest
timeout-minutes: 15
steps:
- name: Checkout code
uses: actions/checkout@v4
- name: Set up Python
uses: actions/setup-python@v5
with:
python-version: 3.11
- name: Install UV
run: |
curl -LsSf https://astral.sh/uv/install.sh | sh
echo "$HOME/.local/bin" >> $GITHUB_PATH
- name: Install dependencies
run: |
cd src/praisonai
uv pip install --system ."[ui,gradio,api,agentops,google,openai,anthropic,cohere,chat,code,realtime,call,crewai,autogen]"
uv pip install --system duckduckgo_search
uv pip install --system pytest pytest-asyncio pytest-cov pytest-timeout
# Install knowledge dependencies from praisonai-agents
uv pip install --system "praisonaiagents[knowledge]"
- name: Set environment variables
run: |
echo "OPENAI_API_KEY=${{ secrets.OPENAI_API_KEY || 'sk-test-key-for-github-actions-testing-only-not-real' }}" >> $GITHUB_ENV
echo "OPENAI_API_BASE=${{ secrets.OPENAI_API_BASE || 'https://api.openai.com/v1' }}" >> $GITHUB_ENV
echo "OPENAI_MODEL_NAME=${{ secrets.OPENAI_MODEL_NAME || 'gpt-5-nano' }}" >> $GITHUB_ENV
echo "LOGLEVEL=DEBUG" >> $GITHUB_ENV
echo "PYTHONPATH=${{ github.workspace }}/src/praisonai-agents:$PYTHONPATH" >> $GITHUB_ENV
- name: Backup Root Config Files
run: |
echo "🔄 Backing up root configuration files to prevent default file resolution interference..."
echo "ℹ️ PraisonAI automatically uses 'agents.yaml' in working directory when no file specified"
echo "ℹ️ This can interfere with test files that specify their own YAML files"
if [ -f "agents.yaml" ]; then
mv agents.yaml agents.yaml.backup
echo "✅ Moved root agents.yaml to agents.yaml.backup"
echo " - This prevents default file fallback during tests"
fi
if [ -f "tools.py" ]; then
mv tools.py tools.py.backup
echo "✅ Moved tools.py to tools.py.backup"
fi
- name: Debug API Key Status
run: |
echo "🔍 Checking API key availability..."
if [ -n "${{ secrets.OPENAI_API_KEY }}" ]; then
echo "✅ GitHub secret OPENAI_API_KEY is available"
echo "🔑 API key starts with: $(echo "$OPENAI_API_KEY" | cut -c1-7)..."
else
echo "⚠️ GitHub secret OPENAI_API_KEY is NOT set - using fallback"
echo "🔑 Using fallback key: sk-test-key..."
fi
echo "🌐 API Base: $OPENAI_API_BASE"
echo "🤖 Model: $OPENAI_MODEL_NAME"
echo "🐛 Log Level: $LOGLEVEL"
echo "📊 Environment Check:"
echo " - OPENAI_API_KEY length: ${#OPENAI_API_KEY}"
echo " - OPENAI_API_BASE: $OPENAI_API_BASE"
echo " - OPENAI_MODEL_NAME: $OPENAI_MODEL_NAME"
echo " - LOGLEVEL: $LOGLEVEL"
- name: Debug Python Environment Variables
run: |
python -c "
import os
print('🐍 Python Environment Variable Check:')
api_key = os.environ.get('OPENAI_API_KEY', 'NOT_SET')
if api_key != 'NOT_SET':
print(f' ✅ OPENAI_API_KEY: {api_key[:7]}... (length: {len(api_key)})')
else:
print(' ❌ OPENAI_API_KEY: NOT_SET')
print(f' 🌐 OPENAI_API_BASE: {os.environ.get(\"OPENAI_API_BASE\", \"NOT_SET\")}')
print(f' 🤖 OPENAI_MODEL_NAME: {os.environ.get(\"OPENAI_MODEL_NAME\", \"NOT_SET\")}')
print(f' 📋 All OPENAI env vars:')
for key, value in os.environ.items():
if key.startswith('OPENAI'):
print(f' {key}: {value[:10] if len(value) > 10 else value}...')
"
- name: Find Researcher Role Source
run: |
echo "🔍 Hunting for the mysterious 'Researcher' role..."
cd src/praisonai
python -c "
import os
import yaml
import glob
print('📋 Searching for Researcher role in all YAML files:')
yaml_files = glob.glob('src/praisonai/tests/*.yaml')
for yaml_file in yaml_files:
try:
with open(yaml_file, 'r') as f:
config = yaml.safe_load(f)
# Check if any role contains 'researcher'
roles = config.get('roles', {})
for role_key, role_data in roles.items():
role_name = role_data.get('role', '')
if 'researcher' in role_key.lower() or 'researcher' in role_name.lower():
print(f' 🎯 FOUND in {yaml_file}:')
print(f' Framework: {config.get(\"framework\", \"NOT_SET\")}')
print(f' Role key: {role_key}')
print(f' Role name: {role_name}')
print(f' All roles: {list(roles.keys())}')
print()
except Exception as e:
print(f' ❌ Error reading {yaml_file}: {e}')
print('🔍 Checking for default configurations...')
# Check if there are any default configs or hardcoded roles
try:
import praisonai
print(f' PraisonAI package location: {praisonai.__file__}')
# Check if there are any example YAML files in the package
package_dir = os.path.dirname(praisonai.__file__)
for root, dirs, files in os.walk(package_dir):
for file in files:
if file.endswith(('.yaml', '.yml')):
file_path = os.path.join(root, file)
print(f' 📁 Found YAML in package: {file_path}')
except Exception as e:
print(f' ❌ Error checking package: {e}')
"
continue-on-error: true
- name: Trace AutoGen Execution Path
run: |
echo "🔍 Tracing AutoGen execution to find where it diverges..."
cd src/praisonai
python -c "
import os
import sys
sys.path.insert(0, '.')
try:
from praisonai import PraisonAI
from praisonai.agents_generator import AgentsGenerator
# Test the exact execution path
print('🎯 Testing AutoGen execution path:')
praisonai = PraisonAI(agent_file='tests/autogen-agents.yaml')
print(f' 1. PraisonAI framework: \"{praisonai.framework}\"')
agents_gen = AgentsGenerator(
agent_file='tests/autogen-agents.yaml',
framework=praisonai.framework,
config_list=praisonai.config_list
)
print(f' 2. AgentsGenerator framework: \"{agents_gen.framework}\"')
# Load the YAML to check what it contains
import yaml
with open('src/praisonai/tests/autogen-agents.yaml', 'r') as f:
config = yaml.safe_load(f)
framework = agents_gen.framework or config.get('framework')
print(f' 3. Final framework decision: \"{framework}\"')
print(f' 4. Available frameworks:')
# Check framework availability
try:
import autogen
print(f' ✅ AutoGen available')
except ImportError:
print(f' ❌ AutoGen NOT available')
try:
from praisonaiagents import Agent
print(f' ✅ PraisonAI agents available')
except ImportError:
print(f' ❌ PraisonAI agents NOT available')
try:
from crewai import Agent
print(f' ✅ CrewAI available')
except ImportError:
print(f' ❌ CrewAI NOT available')
print(f' 5. Roles in YAML: {list(config.get(\"roles\", {}).keys())}')
# Now test the actual framework execution
if framework == 'autogen':
print(f' 6. ✅ Should execute _run_autogen')
elif framework == 'praisonai':
print(f' 6. ❌ Would execute _run_praisonai (WRONG!)')
else:
print(f' 6. ❌ Would execute _run_crewai (DEFAULT FALLBACK)')
except Exception as e:
print(f'❌ Error tracing execution: {e}')
import traceback
traceback.print_exc()
"
continue-on-error: true
- name: Debug YAML Loading and Roles
run: |
echo "🔍 Tracing YAML file loading and role creation..."
cd src/praisonai
python -c "
import os
import sys
import yaml
sys.path.insert(0, '.')
print('📁 Available YAML files in src/praisonai/tests/:')
import glob
yaml_files = glob.glob('tests/*.yaml')
for f in yaml_files:
print(f' {f}')
print()
print('📋 Content of autogen-agents.yaml:')
with open('tests/autogen-agents.yaml', 'r') as f:
config = yaml.safe_load(f)
print(f' Framework: {config.get(\"framework\")}')
print(f' Topic: {config.get(\"topic\")}')
print(f' Roles: {list(config.get(\"roles\", {}).keys())}')
for role_key, role_data in config.get('roles', {}).items():
print(f' {role_key} -> {role_data.get(\"role\", \"NO_ROLE\")}')
print()
print('🔍 Checking if execution uses a different YAML:')
# Check other YAML files for 'Researcher' role
for yaml_file in yaml_files:
try:
with open(yaml_file, 'r') as f:
test_config = yaml.safe_load(f)
roles = test_config.get('roles', {})
for role_key, role_data in roles.items():
if 'researcher' in role_key.lower() or 'researcher' in role_data.get('role', '').lower():
print(f' 🎯 FOUND Researcher in {yaml_file}!')
print(f' Framework: {test_config.get(\"framework\")}')
print(f' Role key: {role_key} -> {role_data.get(\"role\")}')
except:
pass
"
continue-on-error: true
- name: Debug Framework Detection
run: |
echo "🔍 Testing framework detection and config flow..."
python -c "
import os
import sys
import yaml
sys.path.insert(0, '.')
print('🔧 Testing framework detection:')
# Load the YAML file
with open('tests/autogen-agents.yaml', 'r') as f:
config = yaml.safe_load(f)
print(f' 📋 YAML framework: {config.get(\"framework\", \"NOT_SET\")}')
print(f' 📋 YAML topic: {config.get(\"topic\", \"NOT_SET\")}')
try:
from praisonai import PraisonAI
from praisonai.agents_generator import AgentsGenerator
# Test PraisonAI initialization
praisonai = PraisonAI(agent_file='tests/autogen-agents.yaml')
print(f' 🎯 PraisonAI framework: {praisonai.framework}')
# Test AgentsGenerator initialization
agents_gen = AgentsGenerator(
agent_file='tests/autogen-agents.yaml',
framework=praisonai.framework,
config_list=praisonai.config_list
)
print(f' ⚙️ AgentsGenerator framework: {agents_gen.framework}')
print(f' ⚙️ Final framework decision: {agents_gen.framework or config.get(\"framework\")}')
# Check config_list
print(f' 🔑 Config list model: {praisonai.config_list[0].get(\"model\")}')
print(f' 🔑 Config list API key: {praisonai.config_list[0].get(\"api_key\", \"NOT_SET\")[:10]}...')
except Exception as e:
print(f'❌ Error in framework detection: {e}')
"
continue-on-error: true
- name: Debug PraisonAIModel API Key Flow
run: |
echo "🔍 Testing PraisonAIModel API key handling..."
cd src/praisonai
python -c "
import os
import sys
sys.path.insert(0, '.')
print('🔑 Environment API Key Check:')
env_key = os.environ.get('OPENAI_API_KEY', 'NOT_FOUND')
print(f' OPENAI_API_KEY: {env_key[:10] if env_key != \"NOT_FOUND\" else \"NOT_FOUND\"}...')
try:
from praisonai.inc.models import PraisonAIModel
# Test PraisonAIModel with openai/gpt-5-nano (from YAML)
model = PraisonAIModel(model='openai/gpt-5-nano')
print('🤖 PraisonAIModel Configuration:')
print(f' model: {model.model}')
print(f' model_name: {model.model_name}')
print(f' api_key_var: {model.api_key_var}')
print(f' api_key: {model.api_key[:10] if model.api_key != \"nokey\" else \"DEFAULT_NOKEY\"}...')
print(f' base_url: {model.base_url}')
if model.api_key == 'nokey':
print('❌ FOUND THE ISSUE: PraisonAIModel is using default \"nokey\" instead of environment variable!')
else:
print('✅ PraisonAIModel has valid API key from environment')
except Exception as e:
print(f'❌ Error testing PraisonAIModel: {e}')
"
continue-on-error: true
- name: Validate API Key
run: |
echo "🔑 Testing API key validity with minimal OpenAI call..."
python -c "
import os
try:
from openai import OpenAI
client = OpenAI(api_key=os.environ.get('OPENAI_API_KEY'))
# Make a minimal API call to test key validity
response = client.models.list()
print('✅ API Key is VALID - OpenAI responded successfully')
print(f'📊 Available models: {len(list(response.data))} models found')
except Exception as e:
print(f'❌ API Key is INVALID - Error: {e}')
print('🔍 This explains why all API-dependent tests are failing')
print('💡 The GitHub secret OPENAI_API_KEY needs to be updated with a valid key')
"
continue-on-error: true
- name: Test Direct PraisonAI Execution
run: |
echo "🧪 Testing direct PraisonAI execution (what works locally)..."
python -m praisonai src/praisonai/tests/autogen-agents.yaml
continue-on-error: true
- name: Comprehensive Execution Debug
run: |
echo "🔍 Comprehensive debugging of PraisonAI execution path..."
cd src/praisonai
python -c "
import os
import sys
import yaml
sys.path.insert(0, '.')
print('=' * 60)
print('🔍 COMPREHENSIVE EXECUTION DEBUG')
print('=' * 60)
# Check current working directory
print(f'📁 Current working directory: {os.getcwd()}')
# List files in current directory
print('📋 Files in current directory:')
for f in os.listdir('.'):
print(f' {f}')
print()
print('📋 Files in src/praisonai/tests/ directory:')
for f in os.listdir('tests'):
if f.endswith('.yaml'):
print(f' src/praisonai/tests/{f}')
# Check if root agents.yaml exists
print()
if os.path.exists('agents.yaml'):
print('❌ ROOT agents.yaml EXISTS (this is the problem!)')
with open('agents.yaml', 'r') as f:
root_config = yaml.safe_load(f)
print(f' Root framework: {root_config.get(\"framework\")}')
print(f' Root roles: {list(root_config.get(\"roles\", {}).keys())}')
else:
print('✅ ROOT agents.yaml does NOT exist (good!)')
# Test the actual execution path
print()
print('🎯 Testing EXACT execution path:')
try:
from praisonai import PraisonAI
from praisonai.agents_generator import AgentsGenerator
# Test with full path
test_file = 'src/praisonai/tests/autogen-agents.yaml'
print(f' Using test file: {test_file}')
print(f' File exists: {os.path.exists(test_file)}')
# Load the test file directly
with open(test_file, 'r') as f:
test_config = yaml.safe_load(f)
print(f' Test file framework: {test_config.get(\"framework\")}')
print(f' Test file roles: {list(test_config.get(\"roles\", {}).keys())}')
# Create PraisonAI instance
praisonai = PraisonAI(agent_file=test_file)
print(f' PraisonAI.agent_file: {praisonai.agent_file}')
print(f' PraisonAI.framework: {praisonai.framework}')
# Create AgentsGenerator
agents_gen = AgentsGenerator(
agent_file=test_file,
framework=praisonai.framework,
config_list=praisonai.config_list
)
print(f' AgentsGenerator.agent_file: {agents_gen.agent_file}')
print(f' AgentsGenerator.framework: {agents_gen.framework}')
# Test what would happen in generate_crew_and_kickoff
print()
print('🔧 Testing generate_crew_and_kickoff logic:')
# Simulate the loading logic
if agents_gen.agent_yaml:
loaded_config = yaml.safe_load(agents_gen.agent_yaml)
print(' Would load from agent_yaml')
else:
if agents_gen.agent_file == '/app/api:app' or agents_gen.agent_file == 'api:app':
agents_gen.agent_file = 'agents.yaml'
print(f' Would change agent_file to: {agents_gen.agent_file}')
try:
with open(agents_gen.agent_file, 'r') as f:
loaded_config = yaml.safe_load(f)
print(f' Successfully loaded: {agents_gen.agent_file}')
except FileNotFoundError:
print(f' FileNotFoundError: {agents_gen.agent_file}')
loaded_config = None
if loaded_config:
final_framework = agents_gen.framework or loaded_config.get('framework')
print(f' Final framework decision: {final_framework}')
print(f' Loaded roles: {list(loaded_config.get(\"roles\", {}).keys())}')
if 'researcher' in loaded_config.get('roles', {}):
print(' ❌ FOUND Researcher role in loaded config!')
else:
print(' ✅ No Researcher role in loaded config')
except Exception as e:
print(f'❌ Error during execution debug: {e}')
import traceback
traceback.print_exc()
"
continue-on-error: true
- name: Run Fast Tests
run: |
# Run the fastest, most essential tests with coverage
cd src/praisonai && python -m pytest tests/unit/test_core_agents.py -v --tb=short --disable-warnings --cov=praisonai --cov-report=xml --cov-branch
- name: Run Real API Tests
run: |
echo "🔑 Running real API tests with actual OpenAI API key..."
cd src/praisonai && python -m pytest tests/test_agents_playbook.py -v --tb=short --disable-warnings -m real
continue-on-error: true
- name: Run E2E Real Tests
run: |
echo "🧪 Running E2E real tests..."
cd src/praisonai && python -m pytest tests/e2e/ -v --tb=short --disable-warnings -m real
continue-on-error: true
- name: Run Legacy Example Tests
run: |
cd src/praisonai && python -m pytest tests/test.py -v --tb=short --disable-warnings -m "not real" --timeout=60
continue-on-error: true
- name: Upload coverage reports to Codecov
uses: codecov/codecov-action@v5
with:
token: ${{ secrets.CODECOV_TOKEN }}
file: src/praisonai/coverage.xml
flags: quick-validation
name: quick-validation-coverage
fail_ci_if_error: false
verbose: true
- name: Restore Root Config Files
run: |
echo "🔄 Restoring root configuration files..."
if [ -f "agents.yaml.backup" ]; then
mv agents.yaml.backup agents.yaml
echo "✅ Restored agents.yaml"
fi
if [ -f "tools.py.backup" ]; then
mv tools.py.backup tools.py
echo "✅ Restored tools.py"
fi
if: always() # Always run this step, even if previous steps failed
+3 -3
View File
@@ -52,6 +52,6 @@ jobs:
with:
commit_message: "docs: auto-update api.md [skip ci]"
file_pattern: 'api.md'
commit_user_name: "MervinPraison"
commit_user_email: "454862+MervinPraison@users.noreply.github.com"
commit_author: "MervinPraison <454862+MervinPraison@users.noreply.github.com>"
commit_user_name: "github-actions[bot]"
commit_user_email: "41898282+github-actions[bot]@users.noreply.github.com"
commit_author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+7 -10
View File
@@ -27,13 +27,11 @@ jobs:
fetch-depth: 0
- name: Checkout PraisonAIDocs
id: checkout_docs
continue-on-error: true
uses: actions/checkout@v4
with:
repository: MervinPraison/PraisonAIDocs
path: PraisonAIDocs
token: ${{ secrets.SECRETS_ADMIN_PAT }}
token: ${{ secrets.DOCS_PAT }}
- name: Set up Python
uses: actions/setup-python@v5
@@ -45,7 +43,6 @@ jobs:
pip install pyyaml
- name: Generate docs parity trackers
if: steps.checkout_docs.outcome == 'success'
run: |
cd $GITHUB_WORKSPACE
python3 src/praisonai/scripts/generate_docs_parity.py --docs-root PraisonAIDocs/docs --copy-docs
@@ -68,16 +65,16 @@ jobs:
with:
commit_message: "docs: auto-update documentation parity trackers [skip ci]"
file_pattern: 'src/praisonai-agents/DOCS_PARITY.md src/praisonai-ts/DOCS_PARITY.md src/praisonai-rust/DOCS_PARITY.md'
commit_user_name: "MervinPraison"
commit_user_email: "454862+MervinPraison@users.noreply.github.com"
commit_author: "MervinPraison <454862+MervinPraison@users.noreply.github.com>"
commit_user_name: "github-actions[bot]"
commit_user_email: "41898282+github-actions[bot]@users.noreply.github.com"
commit_author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
- name: Commit and push changes to PraisonAIDocs
if: steps.check_changes.outputs.changes == 'true' && steps.checkout_docs.outcome == 'success'
if: steps.check_changes.outputs.changes == 'true'
run: |
cd PraisonAIDocs
git config user.name "MervinPraison"
git config user.email "454862+MervinPraison@users.noreply.github.com"
git config user.name "github-actions[bot]"
git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
git add docs/features/DOCS_PARITY.md docs/js/DOCS_PARITY.md docs/rust/DOCS_PARITY.md
git diff --staged --quiet || git commit -m "docs: auto-update documentation parity trackers [skip ci]"
git push
+3 -6
View File
@@ -29,9 +29,6 @@ jobs:
with:
python-version: '3.11'
- name: Install dependencies
run: pip install pyyaml
- name: Generate parity trackers
run: |
cd $GITHUB_WORKSPACE
@@ -55,7 +52,7 @@ jobs:
with:
commit_message: "docs: auto-update feature parity trackers [skip ci]"
file_pattern: 'src/praisonai-ts/FEATURE_PARITY_TRACKER.json src/praisonai-ts/PARITY.md src/praisonai-rust/FEATURE_PARITY_TRACKER.json src/praisonai-rust/PARITY.md'
commit_user_name: "MervinPraison"
commit_user_email: "454862+MervinPraison@users.noreply.github.com"
commit_author: "MervinPraison <454862+MervinPraison@users.noreply.github.com>"
commit_user_name: "github-actions[bot]"
commit_user_email: "41898282+github-actions[bot]@users.noreply.github.com"
commit_author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+1 -7
View File
@@ -21,7 +21,6 @@ docs.sh
other
output
!src/praisonai/praisonai/cli/output/
!src/praisonai-agents/praisonaiagents/output/
.files
threads.db
@@ -92,9 +91,4 @@ issue_details.json
target/
Cargo.lock
**/*.rs.bk
*.pdb
.windsurf
.agent
src/praisonai/build*.egg-info/
src/praisonai/PraisonAI.egg-info/
*.pdb
+60
View File
@@ -0,0 +1,60 @@
# AGENTS.md
## Cursor Cloud specific instructions
### Project overview
PraisonAI is a multi-AI agents framework. The monorepo has three main packages under `src/`:
| Package | Path | Language | Purpose |
|---------|------|----------|---------|
| **praisonai-agents** | `src/praisonai-agents/` | Python | Core SDK (agents, tools, memory, workflows) |
| **praisonai** | `src/praisonai/` | Python | CLI wrapper, integrations, UI/API |
| **praisonai-ts** | `src/praisonai-ts/` | TypeScript | TypeScript port of the framework |
### Python environment
- Python 3.12, using `uv` as package manager (installed at `~/.local/bin/uv`).
- Both Python packages are installed in editable mode via `uv pip install --system -e`.
- Ensure `$HOME/.local/bin` is on PATH for `uv`.
- `dist-packages` ownership has been changed to `ubuntu` user to avoid permission errors with `uv pip install --system`.
### Running tests
**praisonai-agents (core SDK):**
```bash
cd src/praisonai-agents
OPENAI_API_KEY="sk-test-key" python3 -m pytest tests/unit/ --timeout=60 -q
```
Note: Some test files fail to collect due to a missing `praisonaiagents.output.models` module (referenced by `task/task.py`). To skip those, add `--ignore=tests/unit/agents --ignore=tests/unit/workflows --ignore=tests/unit/test_task_execution_config.py`.
**praisonai (wrapper/CLI):**
```bash
cd src/praisonai
OPENAI_API_KEY="sk-test-key" PYTHONPATH="/workspace/src/praisonai-agents:$PYTHONPATH" python3 -m pytest tests/unit/ --timeout=60 -q
```
Same `output.models` import errors affect some test files here too.
**TypeScript SDK:**
```bash
cd src/praisonai-ts
OPENAI_API_KEY="sk-test-key" npx jest --no-cache --passWithNoTests
```
The TS build (`tsc`) has pre-existing errors from missing `db/`, `cli/output/`, and `@ai-sdk/provider-utils` modules. Tests still largely pass (446/463).
### Running the application
- **CLI:** `python3 -m praisonai --help` (version 4.5.15)
- **Agent hello world:**
```python
from praisonaiagents import Agent
agent = Agent(name="assistant", instructions="Be helpful.")
response = agent.start("Hello!")
```
- Requires a valid `OPENAI_API_KEY` environment variable for any LLM calls.
### Known caveats
- No linting tools (ESLint, ruff, flake8) are configured in this repository.
- The Rust SDK (`src/praisonai-rust/`) requires Cargo 1.85+ (edition2024 support); the default system Cargo 1.83 is too old.
- `pnpm install` for the TS SDK should use `--ignore-scripts` to skip the broken `prepare` (build) step during install.
+3098 -623
View File
File diff suppressed because it is too large. Load diff
+59 -42
View File
@@ -28,23 +28,39 @@ from praisonaiagents import Agent, AutoAgents, AutoRagAgent, ContextAgent, DeepR
Methods:
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">agent_id</a>() -> str</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">achat</a>(prompt: str, temperature = 1.0, tools = None, output_json = None, output_pydantic = None, reasoning_steps = False, task_name = None, task_description = None, task_id = None, attachments = None)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">aexecute</a>(task, context = None)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">agent_id</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">analyze_prompt</a>(prompt: str) -> set</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">auto_memory</a>() -> Optional[bool]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">auto_memory</a>(value: Optional[bool]) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">background</a>() -> Optional[bool]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">background</a>(value: Optional[bool]) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">arun</a>(prompt: str, **kwargs)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">as_tool</a>(description: Optional[str] = None, tool_name: Optional[str] = None) -> 'Handoff'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">astart</a>(prompt: str, **kwargs)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">auto_memory</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">auto_memory</a>(value)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">background</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">background</a>(value)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">chat</a>(prompt, temperature = 1.0, tools = None, output_json = None, output_pydantic = None, reasoning_steps = False, stream = None, task_name = None, task_description = None, task_id = None, config = None, force_retrieval = False, skip_retrieval = False, attachments = None, tool_choice = None)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">chat_with_context</a>(message: str, context: 'ContextPack', **kwargs) -> str</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">checkpoints</a>() -> Optional[bool]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">checkpoints</a>(value: Optional[bool]) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">console</a>() -> Optional[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">context_manager</a>() -> Optional[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">check_pending_approvals</a>() -> Dict[str, Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">checkpoints</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">checkpoints</a>(value)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">clean_json_output</a>(output: str) -> str</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">clear_history</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">console</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">context_manager</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">context_manager</a>(value)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">cost_summary</a>() -> dict</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">delete_history</a>(index: int) -> bool</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">delete_history_matching</a>(pattern: str) -> int</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">diff</a>(from_hash: Optional[str] = None)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">display_name</a>() -> str</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">ephemeral</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">execute</a>(task, context = None)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">execute_tool</a>(function_name, arguments)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">execute_tool_async</a>(function_name: str, arguments: Dict[str, Any]) -> Any</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">from_template</a>(uri: str, config: Optional[Dict[str, Any]] = None, offline: bool = False, **kwargs) -> 'Agent'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">generate_task</a>() -> 'Task'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">get_available_tools</a>() -> List[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">get_history_size</a>() -> int</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">get_learn_context</a>() -> str</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">get_memory_context</a>(query: Optional[str] = None) -> str</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">get_recommended_stage</a>(prompt: str) -> str</code>
@@ -52,29 +68,37 @@ Methods:
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">get_skills_prompt</a>() -> str</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">handoff_to</a>(target_agent: 'Agent', prompt: str, context: Optional[Dict[str, Any]] = None, config: Optional['HandoffConfig'] = None) -> 'HandoffResult'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">handoff_to_async</a>(target_agent: 'Agent', prompt: str, context: Optional[Dict[str, Any]] = None, config: Optional['HandoffConfig'] = None) -> 'HandoffResult'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">llm_model</a>() -> Optional[str]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">output_style</a>() -> Optional[str]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">output_style</a>(value: Optional[str]) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">policy</a>() -> Optional[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">policy</a>(value: Optional[Any]) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">iter_stream</a>(prompt: str, **kwargs)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">launch</a>(path: str = '/', port: int = 8000, host: str = '0.0.0.0', debug: bool = False, protocol: str = 'http')</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">llm_model</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">output_style</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">output_style</a>(value)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">pending_approval_count</a>() -> int</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">policy</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">policy</a>(value)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">prune_history</a>(keep_last: int = 5) -> int</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">query</a>(question: str, **kwargs) -> 'RAGResult'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">rag</a>() -> Optional[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">rag</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">rag_query</a>(question: str, **kwargs) -> 'RAGResult'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">redo</a>() -> bool</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">retrieval_config</a>() -> Optional[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">retrieval_config</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">retrieve</a>(query: str, **kwargs) -> 'ContextPack'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">rules_manager</a>() -> Optional[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">rules_manager</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">run</a>(prompt: str, **kwargs)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">run_autonomous</a>(prompt: str, max_iterations: Optional[int] = None, timeout_seconds: Optional[float] = None, completion_promise: Optional[str] = None, clear_context: bool = False)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">run_autonomous_async</a>(prompt: str, max_iterations: Optional[int] = None, timeout_seconds: Optional[float] = None, completion_promise: Optional[str] = None, clear_context: bool = False)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">run_until</a>(prompt: str, criteria: str, threshold: float = 8.0, max_iterations: int = 5, mode: str = 'optimize', on_iteration: Optional[Callable[[Any], None]] = None, verbose: bool = False) -> 'EvaluationLoopResult'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">run_until_async</a>(prompt: str, criteria: str, threshold: float = 8.0, max_iterations: int = 5, mode: str = 'optimize', on_iteration: Optional[Callable[[Any], None]] = None, verbose: bool = False) -> 'EvaluationLoopResult'</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">skill_manager</a>() -> Optional[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">store_memory</a>(content: str, memory_type: str = 'short_term', **kwargs: Any) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">stream_emitter</a>() -> Optional[Any]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">stream_emitter</a>(value: Optional[Any]) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">thinking_budget</a>() -> Optional[int]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">thinking_budget</a>(value: Optional[int]) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">total_cost</a>() -> float</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">session_id</a>() -> Optional[str]</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">skill_manager</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">start</a>(prompt: str = None, **kwargs)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">store_memory</a>(content: str, memory_type: str = 'short_term', **kwargs)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">stream_emitter</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">stream_emitter</a>(value)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">submit_for_approval</a>(function_name: str, arguments: Dict[str, Any]) -> str</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">switch_model</a>(new_model: str) -> None</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">thinking_budget</a>()</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">thinking_budget</a>(value)</code>
* <code title="class Agent">Agent.<a href="./src/praisonai-agents/praisonaiagents/agent/agent.py">undo</a>() -> bool</code>
* <code title="class AutoAgents">AutoAgents.<a href="./src/praisonai-agents/praisonaiagents/agents/autoagents.py">astart</a>()</code>
* <code title="class AutoAgents">AutoAgents.<a href="./src/praisonai-agents/praisonaiagents/agents/autoagents.py">start</a>()</code>
@@ -226,7 +250,6 @@ Methods:
* <code title="class Memory">Memory.<a href="./src/praisonai-agents/praisonaiagents/memory/memory.py">build_context_for_task</a>(task_descr: str, user_id: Optional[str] = None, additional: str = '', max_items: int = 3, include_in_output: Optional[bool] = None) -> str</code>
* <code title="class Memory">Memory.<a href="./src/praisonai-agents/praisonaiagents/memory/memory.py">calculate_quality_metrics</a>(output: str, expected_output: str, llm: Optional[str] = None, custom_prompt: Optional[str] = None) -> Dict[str, float]</code>
* <code title="class Memory">Memory.<a href="./src/praisonai-agents/praisonaiagents/memory/memory.py">close_connections</a>()</code>
* <code title="class Memory">Memory.<a href="./src/praisonai-agents/praisonaiagents/memory/memory.py">compute_quality_score</a>(completeness: float, relevance: float, clarity: float, accuracy: float, weights: Dict[str, float] = None) -> float</code>
* <code title="class Memory">Memory.<a href="./src/praisonai-agents/praisonaiagents/memory/memory.py">delete_long_term</a>(memory_id: str) -> bool</code>
* <code title="class Memory">Memory.<a href="./src/praisonai-agents/praisonaiagents/memory/memory.py">delete_memories</a>(memory_ids: List[str]) -> int</code>
@@ -358,7 +381,7 @@ from praisonaiagents import GuardrailAction, GuardrailConfig, LLMGuardrail
Methods:
* <code title="class GuardrailConfig">GuardrailConfig.<a href="./src/praisonai-agents/praisonaiagents/config/feature_configs.py">to_dict</a>() -> Dict[str, Any]</code>
* <code title="class LLMGuardrail">LLMGuardrail.<a href="./src/praisonai-agents/praisonaiagents/guardrails/llm_guardrail.py">__call__</a>(task_output) -> Tuple[bool, Union[str, 'TaskOutput']]</code>
* <code title="class LLMGuardrail">LLMGuardrail.<a href="./src/praisonai-agents/praisonaiagents/guardrails/llm_guardrail.py">__call__</a>(task_output: TaskOutput) -> Tuple[bool, Union[str, TaskOutput]]</code>
# Planning
@@ -727,6 +750,8 @@ Methods:
* <code title="class AutoApproveBackend">AutoApproveBackend.<a href="./src/praisonai-agents/praisonaiagents/approval/backends.py">request_approval_sync</a>(request: ApprovalRequest) -> ApprovalDecision</code>
* <code title="function">praisonaiagents.<a href="./src/praisonai-agents/praisonaiagents/embedding/embed.py">aembedding</a>(input: Union[str, List[str]], model: str = 'text-embedding-3-small', dimensions: Optional[int] = None, encoding_format: str = 'float', timeout: float = 600.0, api_key: Optional[str] = None, api_base: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> EmbeddingResult</code>
* <code title="function">praisonaiagents.<a href="./src/praisonai-agents/praisonaiagents/embedding/embed.py">aembeddings</a>(input: Union[str, List[str]], model: str = 'text-embedding-3-small', dimensions: Optional[int] = None, encoding_format: str = 'float', timeout: float = 600.0, api_key: Optional[str] = None, api_base: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> EmbeddingResult</code>
* <code title="function">praisonaiagents.<a href="./src/praisonai-agents/praisonaiagents/embedding/embed.py">embedding</a>(input: Union[str, List[str]], model: str = 'text-embedding-3-small', dimensions: Optional[int] = None, encoding_format: str = 'float', timeout: float = 600.0, api_key: Optional[str] = None, api_base: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> EmbeddingResult</code>
* <code title="function">praisonaiagents.<a href="./src/praisonai-agents/praisonaiagents/embedding/embed.py">embeddings</a>(input: Union[str, List[str]], model: str = 'text-embedding-3-small', dimensions: Optional[int] = None, encoding_format: str = 'float', timeout: float = 600.0, api_key: Optional[str] = None, api_base: Optional[str] = None, metadata: Optional[Dict[str, Any]] = None, **kwargs) -> EmbeddingResult</code>
* <code title="function">praisonaiagents.<a href="./src/praisonai-agents/praisonaiagents/embedding/dimensions.py">get_dimensions</a>(model_name: str) -> int</code>
# Wrapper (praisonai)
@@ -759,10 +784,8 @@ Methods:
* <code title="cli">praisonai benchmark profile <a href="./src/praisonai/praisonai/cli/commands/benchmark.py">--help</a></code>
* <code title="cli">praisonai benchmark sdk <a href="./src/praisonai/praisonai/cli/commands/benchmark.py">--help</a></code>
* <code title="cli">praisonai benchmark workflow <a href="./src/praisonai/praisonai/cli/commands/benchmark.py">--help</a></code>
* <code title="cli">praisonai bot agentmail <a href="./src/praisonai/praisonai/cli/commands/bot.py">--help</a></code>
* <code title="cli">praisonai bot bot-callback <a href="./src/praisonai/praisonai/cli/commands/bot.py">--help</a></code>
* <code title="cli">praisonai bot discord <a href="./src/praisonai/praisonai/cli/commands/bot.py">--help</a></code>
* <code title="cli">praisonai bot email <a href="./src/praisonai/praisonai/cli/commands/bot.py">--help</a></code>
* <code title="cli">praisonai bot slack <a href="./src/praisonai/praisonai/cli/commands/bot.py">--help</a></code>
* <code title="cli">praisonai bot start <a href="./src/praisonai/praisonai/cli/commands/bot.py">--help</a></code>
* <code title="cli">praisonai bot telegram <a href="./src/praisonai/praisonai/cli/commands/bot.py">--help</a></code>
@@ -779,7 +802,6 @@ Methods:
* <code title="cli">praisonai call call-main <a href="./src/praisonai/praisonai/cli/commands/call.py">--help</a></code>
* <code title="cli">praisonai chat <a href="./src/praisonai/praisonai/cli/main.py">--help</a></code>
* <code title="cli">praisonai chat chat-main <a href="./src/praisonai/praisonai/cli/commands/chat.py">--help</a></code>
* <code title="cli">praisonai claw claw <a href="./src/praisonai/praisonai/cli/commands/claw.py">--help</a></code>
* <code title="cli">praisonai code <a href="./src/praisonai/praisonai/cli/main.py">--help</a></code>
* <code title="cli">praisonai code code-main <a href="./src/praisonai/praisonai/cli/commands/code.py">--help</a></code>
* <code title="cli">praisonai commit commit-main <a href="./src/praisonai/praisonai/cli/commands/commit.py">--help</a></code>
@@ -787,8 +809,6 @@ Methods:
* <code title="cli">praisonai completion completion-callback <a href="./src/praisonai/praisonai/cli/commands/completion.py">--help</a></code>
* <code title="cli">praisonai completion fish <a href="./src/praisonai/praisonai/cli/commands/completion.py">--help</a></code>
* <code title="cli">praisonai completion zsh <a href="./src/praisonai/praisonai/cli/commands/completion.py">--help</a></code>
* <code title="cli">praisonai config doctor <a href="./src/praisonai/praisonai/cli/commands/config.py">--help</a></code>
* <code title="cli">praisonai config env <a href="./src/praisonai/praisonai/cli/commands/config.py">--help</a></code>
* <code title="cli">praisonai config get <a href="./src/praisonai/praisonai/cli/commands/config.py">--help</a></code>
* <code title="cli">praisonai config list <a href="./src/praisonai/praisonai/cli/commands/config.py">--help</a></code>
* <code title="cli">praisonai config path <a href="./src/praisonai/praisonai/cli/commands/config.py">--help</a></code>
@@ -848,11 +868,7 @@ Methods:
* <code title="cli">praisonai examples run <a href="./src/praisonai/praisonai/cli/commands/examples.py">--help</a></code>
* <code title="cli">praisonai examples run-all <a href="./src/praisonai/praisonai/cli/commands/examples.py">--help</a></code>
* <code title="cli">praisonai examples stats <a href="./src/praisonai/praisonai/cli/commands/examples.py">--help</a></code>
* <code title="cli">praisonai flow flow-start <a href="./src/praisonai/praisonai/cli/commands/flow.py">--help</a></code>
* <code title="cli">praisonai flow version <a href="./src/praisonai/praisonai/cli/commands/flow.py">--help</a></code>
* <code title="cli">praisonai gateway channels <a href="./src/praisonai/praisonai/cli/commands/gateway.py">--help</a></code>
* <code title="cli">praisonai gateway gateway-callback <a href="./src/praisonai/praisonai/cli/commands/gateway.py">--help</a></code>
* <code title="cli">praisonai gateway send <a href="./src/praisonai/praisonai/cli/commands/gateway.py">--help</a></code>
* <code title="cli">praisonai gateway start <a href="./src/praisonai/praisonai/cli/commands/gateway.py">--help</a></code>
* <code title="cli">praisonai gateway status <a href="./src/praisonai/praisonai/cli/commands/gateway.py">--help</a></code>
* <code title="cli">praisonai hooks add <a href="./src/praisonai/praisonai/cli/commands/hooks.py">--help</a></code>
@@ -890,7 +906,6 @@ Methods:
* <code title="cli">praisonai package install <a href="./src/praisonai/praisonai/cli/commands/package.py">--help</a></code>
* <code title="cli">praisonai package list <a href="./src/praisonai/praisonai/cli/commands/package.py">--help</a></code>
* <code title="cli">praisonai package uninstall <a href="./src/praisonai/praisonai/cli/commands/package.py">--help</a></code>
* <code title="cli">praisonai paths show <a href="./src/praisonai/praisonai/cli/commands/paths.py">--help</a></code>
* <code title="cli">praisonai plugins create <a href="./src/praisonai/praisonai/cli/commands/plugins.py">--help</a></code>
* <code title="cli">praisonai plugins disable <a href="./src/praisonai/praisonai/cli/commands/plugins.py">--help</a></code>
* <code title="cli">praisonai plugins discover <a href="./src/praisonai/praisonai/cli/commands/plugins.py">--help</a></code>
@@ -908,8 +923,6 @@ Methods:
* <code title="cli">praisonai profile snapshot <a href="./src/praisonai/praisonai/cli/commands/profile.py">--help</a></code>
* <code title="cli">praisonai profile startup <a href="./src/praisonai/praisonai/cli/commands/profile.py">--help</a></code>
* <code title="cli">praisonai profile suite <a href="./src/praisonai/praisonai/cli/commands/profile.py">--help</a></code>
* <code title="cli">praisonai publish publish-main <a href="./src/praisonai/praisonai/cli/commands/publish.py">--help</a></code>
* <code title="cli">praisonai publish pypi <a href="./src/praisonai/praisonai/cli/commands/publish.py">--help</a></code>
* <code title="cli">praisonai rag chat <a href="./src/praisonai/praisonai/cli/commands/rag.py">--help</a></code>
* <code title="cli">praisonai rag eval <a href="./src/praisonai/praisonai/cli/commands/rag.py">--help</a></code>
* <code title="cli">praisonai rag index <a href="./src/praisonai/praisonai/cli/commands/rag.py">--help</a></code>
@@ -948,7 +961,6 @@ Methods:
* <code title="cli">praisonai sandbox recreate <a href="./src/praisonai/praisonai/cli/commands/sandbox.py">--help</a></code>
* <code title="cli">praisonai sandbox sandbox-callback <a href="./src/praisonai/praisonai/cli/commands/sandbox.py">--help</a></code>
* <code title="cli">praisonai sandbox status <a href="./src/praisonai/praisonai/cli/commands/sandbox.py">--help</a></code>
* <code title="cli">praisonai schedule add <a href="./src/praisonai/praisonai/cli/commands/schedule.py">--help</a></code>
* <code title="cli">praisonai schedule delete <a href="./src/praisonai/praisonai/cli/commands/schedule.py">--help</a></code>
* <code title="cli">praisonai schedule describe <a href="./src/praisonai/praisonai/cli/commands/schedule.py">--help</a></code>
* <code title="cli">praisonai schedule list <a href="./src/praisonai/praisonai/cli/commands/schedule.py">--help</a></code>
@@ -1021,7 +1033,12 @@ Methods:
* <code title="cli">praisonai train llm <a href="./src/praisonai/praisonai/cli/commands/train.py">--help</a></code>
* <code title="cli">praisonai train show <a href="./src/praisonai/praisonai/cli/commands/train.py">--help</a></code>
* <code title="cli">praisonai train train-callback <a href="./src/praisonai/praisonai/cli/commands/train.py">--help</a></code>
* <code title="cli">praisonai ui ui <a href="./src/praisonai/praisonai/cli/commands/ui.py">--help</a></code>
* <code title="cli">praisonai ui bot <a href="./src/praisonai/praisonai/cli/commands/ui.py">--help</a></code>
* <code title="cli">praisonai ui chat <a href="./src/praisonai/praisonai/cli/commands/ui.py">--help</a></code>
* <code title="cli">praisonai ui code <a href="./src/praisonai/praisonai/cli/commands/ui.py">--help</a></code>
* <code title="cli">praisonai ui gradio <a href="./src/praisonai/praisonai/cli/commands/ui.py">--help</a></code>
* <code title="cli">praisonai ui realtime <a href="./src/praisonai/praisonai/cli/commands/ui.py">--help</a></code>
* <code title="cli">praisonai ui ui-main <a href="./src/praisonai/praisonai/cli/commands/ui.py">--help</a></code>
* <code title="cli">praisonai version check <a href="./src/praisonai/praisonai/cli/commands/version.py">--help</a></code>
* <code title="cli">praisonai version show <a href="./src/praisonai/praisonai/cli/commands/version.py">--help</a></code>
* <code title="cli">praisonai version version-callback <a href="./src/praisonai/praisonai/cli/commands/version.py">--help</a></code>
@@ -1174,7 +1191,7 @@ export { // Python parity additions
export { // Subagent Tool (agent-as-tool pattern)
SubagentTool, BaseTool, FunctionTool, ToolRegistry, ToolResult, ToolValidationError, createDelegator, createSubagentTool, createSubagentTools, createTool, getRegistry, getTool, registerTool, tool, validateTool } from "./tools";
export { airweaveSearch, bedrockBrowserClick, bedrockBrowserFill, bedrockBrowserNavigate, bedrockCodeInterpreter, codeExecution, codeMode, createCustomTool, exaSearch, firecrawlCrawl, firecrawlScrape, parallelSearch, perplexitySearch, registerCustomTool, registerLocalTool, registerNpmTool, superagentGuard, superagentRedact, superagentVerify, tavilyCrawl, tavilyExtract, tavilySearch, valyuBioSearch, valyuCompanyResearch, valyuEconomicsSearch, valyuFinanceSearch, valyuPaperSearch, valyuPatentSearch, valyuSecSearch, valyuWebSearch } from "./tools/builtins";
export { BudgetExceededError, MissingDependencyError, MissingEnvVarError, ToolsRegistry, composeMiddleware, createLoggingMiddleware, createRateLimitMiddleware, createRedactionMiddleware, createRetryMiddleware, createTimeoutMiddleware, createToolsRegistry, createTracingMiddleware, createValidationMiddleware, getRegistry, getTool, getToolsRegistry, get_registry, get_tool, registerTool, register_tool, resetToolsRegistry, validateTool, validate_tool } from "./tools/registry";
export { MissingDependencyError, MissingEnvVarError, ToolsRegistry, composeMiddleware, createLoggingMiddleware, createRateLimitMiddleware, createRedactionMiddleware, createRetryMiddleware, createTimeoutMiddleware, createToolsRegistry, createTracingMiddleware, createValidationMiddleware, getToolsRegistry, resetToolsRegistry } from "./tools/registry";
export type { InstallHints, PraisonTool, RedactionHooks, RegisteredTool, ToolCapabilities, ToolExecutionContext, ToolExecutionResult, ToolFactory, ToolHooks, ToolInstallStatus, ToolLimits, ToolLogger, ToolMetadata, ToolMiddleware, ToolParameterProperty, ToolParameterSchema } from "./tools/registry";
export { registerBuiltinTools, tools } from "./tools/tools";
export { // Classes
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.5.112" \
"praisonai>=4.5.15" \
"praisonai[chat]" \
"embedchain[github,youtube]"
-61
View File
@@ -1,61 +0,0 @@
# PraisonAI 🦞 Claw — All-in-one: dashboard + bots + gateway + agents
#
# Build: docker build -f docker/Dockerfile.claw -t praisonai:claw ..
# Run: docker run -p 8082:8082 -e OPENAI_API_KEY=sk-xxx praisonai:claw
# Health: curl http://localhost:8082/health
#
# Override CMD for other modes:
# Bot: docker run -e ... praisonai:claw praisonai bot telegram
# Gateway: docker run -e ... praisonai:claw praisonai gateway start
# Serve: docker run -e ... praisonai:claw praisonai serve agents.yaml
# Shell: docker run --rm -it praisonai:claw bash
FROM python:3.12-slim AS base
# ── Environment ──────────────────────────────────────────────────────────────
ENV PYTHONDONTWRITEBYTECODE=1 \
PYTHONUNBUFFERED=1 \
AIUI_PORT=8082 \
AIUI_HOST=0.0.0.0 \
AIUI_DATA_DIR=/data
WORKDIR /app
# ── System dependencies ─────────────────────────────────────────────────────
# tini: PID 1 signal handling (graceful shutdown on Fly/Railway/k8s)
# curl: HEALTHCHECK probe
# build-essential: compile native Python wheels (chromadb, etc.)
RUN apt-get update && apt-get install -y --no-install-recommends \
tini \
curl \
build-essential \
&& rm -rf /var/lib/apt/lists/*
# ── Install PraisonAI 🦞 ────────────────────────────────────────────────────
# Single command installs: AIUI dashboard, agents SDK (memory/knowledge/llm/mcp),
# bot channels (Telegram/Discord/Slack), gateway, search tools, and more.
RUN pip install --no-cache-dir "praisonai[claw]"
# ── Data volume ──────────────────────────────────────────────────────────────
# Persistence for sessions, config, memory, knowledge stores
RUN mkdir -p /data
VOLUME /data
# ── Entrypoint ───────────────────────────────────────────────────────────────
# Ensures /data exists and forwards all signals via tini
RUN printf '#!/bin/sh\n\
set -e\n\
mkdir -p /data 2>/dev/null || true\n\
exec "$@"\n' > /usr/local/bin/entrypoint.sh \
&& chmod +x /usr/local/bin/entrypoint.sh
EXPOSE 8082
# ── Health check ─────────────────────────────────────────────────────────────
HEALTHCHECK --interval=30s --timeout=5s --start-period=20s --retries=3 \
CMD curl -f http://localhost:8082/health || exit 1
# ── Run ──────────────────────────────────────────────────────────────────────
# Default: AIUI dashboard via praisonai claw. Override CMD for bot/gateway/serve.
ENTRYPOINT ["/usr/bin/tini", "--", "/usr/local/bin/entrypoint.sh"]
CMD ["praisonai", "claw", "--port", "8082"]
+1 -1
View File
@@ -20,7 +20,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.5.112" \
"praisonai>=4.5.15" \
"praisonai[ui]" \
"praisonai[chat]" \
"praisonai[realtime]" \
+1 -1
View File
@@ -16,7 +16,7 @@ RUN mkdir -p /root/.praison
# Install Python packages (using latest versions)
RUN pip install --no-cache-dir \
praisonai_tools \
"praisonai>=4.5.112" \
"praisonai>=4.5.15" \
"praisonai[ui]" \
"praisonai[crewai]"
-25
View File
@@ -1,29 +1,6 @@
version: '3.8'
services:
# PraisonAI 🦞 Claw — Recommended all-in-one service
claw:
build:
context: ..
dockerfile: docker/Dockerfile.claw
volumes:
- claw_data:/data
ports:
- "8082:8082"
environment:
OPENAI_API_KEY: ${OPENAI_API_KEY}
restart: unless-stopped
healthcheck:
test: [ "CMD", "curl", "-f", "http://localhost:8082/health" ]
interval: 30s
timeout: 5s
start_period: 20s
retries: 3
networks:
- praison_network
# ─── Legacy services (kept for backward compatibility) ─────────────────
# PraisonAI UI Service
ui:
build:
@@ -115,8 +92,6 @@ services:
# For bot services (Slack, Discord, Telegram), see docker/bots/
volumes:
claw_data:
driver: local
praison_data:
driver: local
-30
View File
@@ -1,30 +0,0 @@
framework: ag2
topic: "Research the latest developments in AI agents"
# Install: pip install "praisonai[ag2]"
# Run: praisonai --framework ag2 examples/ag2/ag2_basic.yaml
# or praisonai run examples/ag2/ag2_basic.yaml --framework ag2
roles:
research_agent:
role: "AI Research Specialist"
goal: "Research and summarise the latest developments in AI agent frameworks"
backstory: |
You are an experienced AI researcher with deep knowledge of multi-agent
systems, large language models, and the latest trends in AI tooling.
You excel at synthesising complex technical topics into clear summaries.
tasks:
research_task:
description: |
Research and summarise the latest developments in AI agent frameworks
for the topic: {topic}
Focus on:
1. Key frameworks and their unique capabilities
2. Recent innovations and improvements
3. Community adoption and ecosystem growth
4. Practical use cases and success stories
expected_output: |
A concise research summary covering the key developments,
major frameworks, and practical insights. Include 3-5 bullet
points of the most important findings.
-42
View File
@@ -1,42 +0,0 @@
framework: ag2
topic: "Cloud-native AI deployment strategies on AWS"
# AG2 exclusive feature: native AWS Bedrock support via LLMConfig(api_type="bedrock")
#
# Prerequisites:
# pip install "praisonai[ag2]"
# aws configure (or set AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, AWS_DEFAULT_REGION)
#
# Run:
# praisonai --framework ag2 examples/ag2/ag2_bedrock.yaml
#
# The AG2 adapter detects api_type="bedrock" from the llm config and uses
# LLMConfig(api_type="bedrock", model=...) — no OPENAI_API_KEY required.
# AWS credentials are sourced from boto3 (env vars, ~/.aws/credentials, IAM role).
roles:
cloud_architect:
role: "AWS Cloud Architect"
goal: "Design and explain cloud-native AI deployment strategies on AWS"
backstory: |
You are an AWS Solutions Architect specialising in AI/ML workloads.
You have deep expertise in Amazon Bedrock, SageMaker, ECS, and Lambda,
and you help organisations deploy AI agents at scale securely and cost-effectively.
llm:
model: "bedrock/anthropic.claude-3-5-sonnet-20241022-v2:0"
api_type: "bedrock"
aws_region: "us-east-1"
tasks:
architecture_task:
description: |
Design a cloud-native deployment strategy for AI agents on AWS for: {topic}
Cover:
1. Recommended AWS services (Bedrock, ECS, Lambda, etc.)
2. Scalability and cost optimisation patterns
3. Security and compliance considerations
4. A simple reference architecture overview
expected_output: |
A concise architecture guide with service recommendations,
a high-level deployment diagram description, and key
best practices for production AI agent deployments on AWS.
-54
View File
@@ -1,54 +0,0 @@
framework: ag2
topic: "The impact of open-source AI on enterprise software development"
# Install: pip install "praisonai[ag2]"
# Run: praisonai --framework ag2 examples/ag2/ag2_multi_agent.yaml
# or praisonai run examples/ag2/ag2_multi_agent.yaml --framework ag2
#
# This example demonstrates AG2's GroupChat multi-agent coordination.
# Both agents participate in a collaborative conversation managed by
# a GroupChatManager until the task is complete.
roles:
researcher:
role: "Research Specialist"
goal: "Gather and analyse information on the given topic"
backstory: |
You are a meticulous researcher who excels at finding relevant
information, analysing trends, and presenting data-backed insights.
You always cite your reasoning and structure your findings clearly.
tasks:
research_task:
description: |
Research the topic: {topic}
Investigate:
1. Current state and adoption rates
2. Key players and projects driving the trend
3. Technical advantages and challenges
4. Business impact and cost implications
expected_output: |
A structured research briefing with findings on the topic,
including key data points, trends, and technical observations.
writer:
role: "Technical Content Writer"
goal: "Transform research findings into clear, engaging written content"
backstory: |
You are a skilled technical writer who turns complex research into
accessible, well-structured articles. You focus on clarity, logical
flow, and actionable takeaways for a professional audience.
tasks:
writing_task:
description: |
Using the research findings provided by the Research Specialist,
write a concise article on: {topic}
The article should:
1. Open with a compelling hook
2. Present key findings logically
3. Include practical implications for developers
4. Close with a forward-looking conclusion
expected_output: |
A 400-500 word article suitable for a technical blog,
with clear sections, professional tone, and concrete takeaways.
+2 -2
View File
@@ -37,7 +37,7 @@ def example_simple_enable():
instructions="You are a helpful assistant",
memory=True, # Enable memory with defaults
reflection=True, # Enable self-reflection
web=WebConfig(fetch=False), # Enable web search + fetch
web=True, # Enable web search + fetch
)
print(f"Agent created with memory={agent._memory_instance is not None}")
print(f" self_reflect={agent.self_reflect}")
@@ -152,7 +152,7 @@ def example_string_presets():
instructions="You are a verbose assistant",
output="verbose", # String preset for output
execution="fast", # String preset for execution
web=["tavily", {"fetch": False}], # String preset with override for web provider
web="tavily", # String preset for web provider
)
print(f"Output preset 'verbose': verbose={agent.verbose}, metrics={agent.metrics}")
print(f"Execution preset 'fast': max_iter={agent.max_iter}")
-23
View File
@@ -1,23 +0,0 @@
"""Calculator with Tests - Editor Output Example.
Builds a calculator module, writes unit tests, runs them, generates a
coverage-style report, and reads it back.
"""
from praisonaiagents import Agent
from praisonaiagents.tools import (
write_file, read_file, execute_command
)
agent = Agent(
instructions="You are a helpful coding assistant.",
output="editor",
tools=[write_file, read_file, execute_command],
approval=True,
)
agent.start(
"Build a mini calculator - create /tmp/calculator.py with add, subtract, "
"multiply, divide functions, write unit tests in /tmp/test_calculator.py "
"using unittest, run the tests to make sure they pass, then generate a "
"coverage-style report in /tmp/calc_report.md listing which functions were "
"tested and read it back"
)
-22
View File
@@ -1,22 +0,0 @@
"""Fibonacci Generator - Editor Output Example.
Creates a Fibonacci script, runs it, writes a summary, and reads back
both files to verify everything looks good.
"""
from praisonaiagents import Agent
from praisonaiagents.tools import (
write_file, read_file, execute_command, list_files
)
agent = Agent(
instructions="You are a helpful coding assistant.",
output="editor",
tools=[write_file, read_file, execute_command, list_files],
approval=False,
)
agent.start(
"Create a Python file at /tmp/fibonacci.py that generates the first 20 "
"Fibonacci numbers, run it to verify the output is correct, then write "
"a summary to /tmp/fib_summary.md explaining the algorithm you used and "
"the output, finally read back both files to confirm everything looks good"
)
-36
View File
@@ -1,36 +0,0 @@
"""Multi-Step Research - Editor Output Example.
Researches Python frameworks, creates comparison code, runs it, writes a
markdown report, reads it back, lists files, and gets system info.
"""
from praisonaiagents import Agent
from praisonaiagents.tools import (
write_file, read_file, execute_command, list_files, get_system_info
)
try:
from praisonaiagents.tools import web_search
tools = [web_search, write_file, read_file, execute_command,
list_files, get_system_info]
except ImportError:
tools = [write_file, read_file, execute_command,
list_files, get_system_info]
agent = Agent(
instructions="You are a helpful research assistant.",
output="editor",
tools=tools,
approval=False,
)
agent.start(
"Research the top 3 Python web frameworks (Django, FastAPI, Flask), then: "
"1) Search the web for each framework's latest version and key features, "
"2) Create a file called /tmp/framework_comparison.py that contains a "
"Python dictionary with the comparison data, "
"3) Execute the code to verify the dictionary is valid, "
"4) Write a markdown report to /tmp/framework_report.md summarizing your "
"findings in a table format, "
"5) Read back the report file to verify it was written correctly, "
"6) List the files in /tmp to confirm both files exist, "
"7) Get system info to note what OS this report was generated on"
)
-21
View File
@@ -1,21 +0,0 @@
"""System Audit - Editor Output Example.
Runs system commands, gathers info, writes a report, and reads it back.
"""
from praisonaiagents import Agent
from praisonaiagents.tools import (
write_file, read_file, execute_command
)
agent = Agent(
instructions="You are a helpful system administration assistant.",
output="editor",
tools=[write_file, read_file, execute_command],
approval=True,
)
agent.start(
"Investigate my system - get the current date, check disk usage, find out "
"what Python version is installed, list running processes sorted by memory, "
"then write all findings to /tmp/system_audit.md as a neat report and read "
"it back to verify"
)
-28
View File
@@ -1,28 +0,0 @@
"""Weather Search - Editor Output Example.
Searches for weather, creates JSON data, writes a parser script, executes
it, and lists created files.
"""
from praisonaiagents import Agent
from praisonaiagents.tools import (
write_file, execute_command, list_files
)
try:
from praisonaiagents.tools import web_search
tools = [web_search, write_file, execute_command, list_files]
except ImportError:
tools = [write_file, execute_command, list_files]
agent = Agent(
instructions="You are a helpful research assistant.",
output="editor",
tools=tools,
approval=False,
)
agent.start(
"Search the web for the current weather in Tokyo, create a JSON file at "
"/tmp/weather_data.json with the findings, then write a Python script at "
"/tmp/parse_weather.py that reads the JSON and prints a formatted weather "
"report, execute the script, and list all files you created in /tmp"
)
-5
View File
@@ -1,5 +0,0 @@
#!/bin/bash
# Calculator with tests: code + unit tests + test execution + coverage report
# Tests: multiple file creation, test execution, report generation, file reading
praisonai "Build a mini calculator - create /tmp/calculator.py with add, subtract, multiply, divide functions, write unit tests in /tmp/test_calculator.py using unittest, run the tests to make sure they pass, then generate a coverage-style report in /tmp/calc_report.md listing which functions were tested and read it back" --trust
-5
View File
@@ -1,5 +0,0 @@
#!/bin/bash
# Fibonacci generator: code creation, execution, documentation, verification
# Tests: file creation, code execution, markdown writing, file reading
praisonai "Create a Python file at /tmp/fibonacci.py that generates the first 20 Fibonacci numbers, run it to verify the output is correct, then write a summary to /tmp/fib_summary.md explaining the algorithm you used and the output, finally read back both files to confirm everything looks good" --trust
-5
View File
@@ -1,5 +0,0 @@
#!/bin/bash
# Multi-step research: web search, file creation, code execution, reporting
# Tests: web search, file write, code execution, markdown report, file read, directory listing, system info
praisonai "Research the top 3 Python web frameworks (Django, FastAPI, Flask), then: 1) Search the web for each framework's latest version and key features, 2) Create a file called /tmp/framework_comparison.py that contains a Python dictionary with the comparison data, 3) Execute the code to verify the dictionary is valid, 4) Write a markdown report to /tmp/framework_report.md summarizing your findings in a table format, 5) Read back the report file to verify it was written correctly, 6) List the files in /tmp to confirm both files exist, 7) Get system info to note what OS this report was generated on, 8) Analyze the Python code you wrote for any issues, 9) Format the Python code properly, 10) Finally search for any recent news about Python 3.13 features" --trust
-5
View File
@@ -1,5 +0,0 @@
#!/bin/bash
# System audit: multiple command executions, report generation
# Tests: command execution (date, disk, python, processes), file creation, file reading
praisonai "Investigate my system - get the current date, check disk usage, find out what Python version is installed, list running processes sorted by memory, then write all findings to /tmp/system_audit.md as a neat report and read it back to verify" --trust
-5
View File
@@ -1,5 +0,0 @@
#!/bin/bash
# Todo app: multi-file app creation, execution, documentation, verification
# Tests: multiple file creation, code execution, markdown docs, directory listing
praisonai "Write a todo list app at /tmp/todo.py with functions to add, remove, and list tasks stored in /tmp/todos.json, run the script with some sample tasks added, then create documentation at /tmp/todo_docs.md explaining usage with examples, and verify all three files exist" --trust
-5
View File
@@ -1,5 +0,0 @@
#!/bin/bash
# Weather search: web search, JSON creation, Python script, execution
# Tests: web search, JSON file creation, Python scripting, code execution, directory listing
praisonai "Search the web for the current weather in Tokyo, create a JSON file at /tmp/weather_data.json with the findings, then write a Python script at /tmp/parse_weather.py that reads the JSON and prints a formatted weather report, execute the script, and list all files you created in /tmp" --trust
+1 -9
View File
@@ -19,15 +19,7 @@ async function main() {
},
execute: async ({ expression }) => {
try {
// Only allow safe numeric math characters
if (!/^[0-9+\-*/.() ]+$/.test(expression)) {
return 'Error: Only basic math expressions are allowed';
}
// Use Function constructor scoped to math only, no globals
const result = new Function(`"use strict"; return (${expression})`)();
if (typeof result !== 'number' || !isFinite(result)) {
return 'Error: Invalid result';
}
const result = eval(expression);
return `Result: ${result}`;
} catch (e) {
return 'Error: Invalid expression';
+1 -7
View File
@@ -38,13 +38,7 @@ const calculatorTool = createTool({
},
run: (params: { expression: string }) => {
try {
// Only allow safe numeric math characters
if (!/^[0-9+\-*/.() ]+$/.test(params.expression)) {
return 'Error: Only basic math expressions are allowed';
}
const result = new Function(`"use strict"; return (${params.expression})`)();
if (typeof result !== 'number' || !isFinite(result)) return 'Error: Invalid result';
return result;
return eval(params.expression);
} catch {
return 'Error: Invalid expression';
}
+2 -2
View File
@@ -4,8 +4,8 @@ from praisonai.persistence import create_conversation_store
store = create_conversation_store("sqlite", path="/tmp/multi_agent.db")
agent1 = Agent(name="Researcher", llm="gpt-4o-mini", memory={"backend": "sqlite", "session_id": "shared-session", "db": store})
agent2 = Agent(name="Writer", llm="gpt-4o-mini", memory={"backend": "sqlite", "session_id": "shared-session", "db": store})
agent1 = Agent(name="Researcher", llm="gpt-4o-mini", db=store, session_id="shared-session")
agent2 = Agent(name="Writer", llm="gpt-4o-mini", db=store, session_id="shared-session")
r1 = agent1.chat("Research topic: AI in healthcare. Key finding: reduces diagnosis time by 50%")
print(f"Researcher: {r1[:50]}...")
-216
View File
@@ -1,216 +0,0 @@
"""
Email Bot Example — Deploy an AI Agent to Your Mailbox
This example shows how to deploy PraisonAI agents as email bots
using IMAP/SMTP. The bot monitors an inbox, processes incoming emails,
and replies intelligently using an LLM-powered agent.
Supported providers:
- Gmail (with App Password)
- Outlook/Microsoft 365
- Any IMAP/SMTP server
Environment Variables:
export OPENAI_API_KEY=your_key
export [email protected]
export EMAIL_APP_PASSWORD=your_app_password
export EMAIL_IMAP_SERVER=imap.gmail.com # optional, default: imap.gmail.com
export EMAIL_SMTP_SERVER=smtp.gmail.com # optional, default: smtp.gmail.com
Usage:
python bot_email_example.py
"""
import asyncio
import os
from praisonaiagents import Agent
# ── Example 1: Minimal — Bot() wrapper (recommended) ──────────────
def example_minimal():
"""Minimal email bot — 3 lines to start."""
from praisonai.bots import Bot
agent = Agent(
name="email_assistant",
instructions="You are a helpful email assistant. Reply concisely and professionally.",
llm="gpt-4o-mini",
)
# Token and server resolved from env vars automatically:
# EMAIL_APP_PASSWORD, EMAIL_ADDRESS, EMAIL_IMAP_SERVER, EMAIL_SMTP_SERVER
bot = Bot("email", agent=agent)
bot.run() # Blocks until Ctrl+C
# ── Example 2: Custom configuration ───────────────────────────────
def example_with_config():
"""Email bot with explicit configuration."""
from praisonai.bots import Bot
from praisonaiagents import BotConfig
config = BotConfig(
polling_interval=30.0, # Check inbox every 30s
allowed_users=[ # Only respond to these senders
"[email protected]",
"[email protected]",
],
max_message_length=10000, # Allow long email replies
session_ttl=86400, # Clear session after 24h inactivity
metadata={
"imap_folder": "INBOX", # Which folder to monitor
},
)
agent = Agent(
name="support_agent",
instructions="""You are a technical support agent for ExampleCo.
Guidelines:
- Be professional and empathetic
- Provide clear step-by-step solutions
- If you don't know the answer, escalate to [email protected]
- Keep replies under 500 words
""",
llm="gpt-4o-mini",
)
bot = Bot("email", agent=agent, config=config)
bot.run()
# ── Example 3: Direct EmailBot with custom handlers ──────────────
def example_direct():
"""Direct EmailBot usage with custom message handler and commands."""
from praisonai.bots import EmailBot
agent = Agent(
name="smart_inbox",
instructions="You help triage and respond to support emails.",
llm="gpt-4o-mini",
)
bot = EmailBot(
token=os.environ.get("EMAIL_APP_PASSWORD", ""),
agent=agent,
email_address=os.environ.get("EMAIL_ADDRESS", ""),
imap_server=os.environ.get("EMAIL_IMAP_SERVER", "imap.gmail.com"),
smtp_server=os.environ.get("EMAIL_SMTP_SERVER", "smtp.gmail.com"),
)
# Custom message handler — runs on every incoming email
@bot.on_message
async def log_incoming(message):
print(f"📧 New email from: {message.sender.username}")
print(f" Subject: {message.metadata.get('subject', '(no subject)')}")
# Custom command — triggered when subject starts with "/status"
@bot.on_command("status")
async def handle_status(message):
await bot.send_message(
channel_id=message.sender.user_id,
content={
"subject": "Re: Bot Status",
"body": f"🤖 Bot is running!\nProcessed emails: {bot._emails_processed}",
},
reply_to=message.message_id,
)
asyncio.run(bot.start())
# ── Example 4: Multi-platform with BotOS ─────────────────────────
def example_multi_platform():
"""Run email bot alongside Telegram and Discord bots."""
from praisonai.bots import BotOS, Bot
agent = Agent(
name="omni_assistant",
instructions="You are a helpful assistant available on email, Telegram, and Discord.",
llm="gpt-4o-mini",
)
botos = BotOS(agent=agent, platforms=["email", "telegram", "discord"])
botos.run() # All three bots run concurrently
# ── Example 5: Probe connectivity ─────────────────────────────────
async def example_probe():
"""Test email server connectivity without starting the bot."""
from praisonai.bots import Bot
bot = Bot("email")
result = await bot.probe()
print(f"Connection OK: {result.ok}")
print(f"Platform: {result.platform}")
if result.bot_username:
print(f"Email: {result.bot_username}")
if result.error:
print(f"Error: {result.error}")
print(f"Latency: {result.elapsed_ms:.0f}ms")
# ── Example 6: YAML config (for praisonai bot CLI) ───────────────
YAML_EXAMPLE = """
# bot.yaml — Save this file and run: praisonai bot --config bot.yaml
agent:
name: email_support
instructions: >
You are a professional support agent.
Reply concisely and helpfully.
llm: gpt-4o-mini
tools:
- search_web
platforms:
email:
token: ${EMAIL_APP_PASSWORD}
"""
# ── Main ──────────────────────────────────────────────────────────
if __name__ == "__main__":
import sys
examples = {
"minimal": ("Minimal email bot", example_minimal),
"config": ("With custom config", example_with_config),
"direct": ("Direct EmailBot with handlers", example_direct),
"multi": ("Multi-platform (email+telegram+discord)", example_multi_platform),
"probe": ("Test connectivity", lambda: asyncio.run(example_probe())),
}
if len(sys.argv) > 1 and sys.argv[1] in examples:
name = sys.argv[1]
desc, fn = examples[name]
print(f"Running: {desc}")
fn()
else:
print("PraisonAI Email Bot Examples")
print("=" * 40)
print()
print("Usage: python bot_email_example.py <example>")
print()
print("Available examples:")
for key, (desc, _) in examples.items():
print(f" {key:10s} {desc}")
print()
print("Required environment variables:")
print(" OPENAI_API_KEY Your OpenAI API key")
print(" EMAIL_ADDRESS Bot's email address")
print(" EMAIL_APP_PASSWORD App password (Gmail: myaccount.google.com/apppasswords)")
print()
print("Optional:")
print(" EMAIL_IMAP_SERVER IMAP server (default: imap.gmail.com)")
print(" EMAIL_SMTP_SERVER SMTP server (default: smtp.gmail.com)")
print()
print("YAML config example:")
print(YAML_EXAMPLE)
-117
View File
@@ -1,117 +0,0 @@
"""
SandlockSandbox Security Demo
Demonstrates how to use SandlockSandbox for kernel-level code isolation.
Requires: pip install 'praisonai[sandbox]' (installs sandlock)
"""
import asyncio
from praisonaiagents.sandbox import ResourceLimits, SecurityPolicy, SandboxConfig
async def demonstrate_sandlock_security():
"""Show SandlockSandbox blocking malicious operations."""
try:
from praisonai.sandbox import SandlockSandbox
except ImportError:
print("❌ SandlockSandbox requires: pip install 'praisonai[sandbox]'")
print(" Falling back to SubprocessSandbox (less secure)")
from praisonai.sandbox import SubprocessSandbox
sandbox = SubprocessSandbox()
else:
# Create sandbox with strict security policy
config = SandboxConfig.native(
writable_paths=["./safe_workspace"], # Only allow writes to this dir
network=False, # Block all network access
)
sandbox = SandlockSandbox(config)
print("✅ Using SandlockSandbox with kernel-level isolation")
await sandbox.start()
# Test 1: Safe code execution
print("\n🟢 Test 1: Safe Python code")
result = await sandbox.execute(
"print('Hello from isolated sandbox!')",
limits=ResourceLimits.minimal()
)
print(f"Status: {result.status}")
print(f"Output: {result.stdout}")
# Test 2: Attempt file system access (should be blocked by Landlock)
print("\n🔒 Test 2: Attempt to read sensitive files")
result = await sandbox.execute("""
try:
with open('/etc/passwd', 'r') as f:
print(f.read()[:100])
except Exception as e:
print(f'Access blocked: {e}')
""")
print(f"Status: {result.status}")
print(f"Output: {result.stdout}")
if result.stderr:
print(f"Stderr: {result.stderr}")
# Test 3: Attempt network access (should be blocked)
print("\n🌐 Test 3: Attempt network access")
result = await sandbox.execute("""
try:
import socket
s = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
s.connect(('example.com', 80))
print('Network connection successful')
s.close()
except Exception as e:
print(f'Network blocked: {e}')
""")
print(f"Status: {result.status}")
print(f"Output: {result.stdout}")
# Test 4: Attempt subprocess execution (blocked by seccomp)
print("\n🚫 Test 4: Attempt subprocess execution")
result = await sandbox.execute("""
try:
import subprocess
result = subprocess.run(['ls', '/'], capture_output=True, text=True)
print(f'Command output: {result.stdout}')
except Exception as e:
print(f'Subprocess blocked: {e}')
""")
print(f"Status: {result.status}")
print(f"Output: {result.stdout}")
# Test 5: Resource limits in action
print("\n⏱️ Test 5: Resource limits (timeout)")
result = await sandbox.execute(
"import time; time.sleep(100)", # Will timeout
limits=ResourceLimits(timeout_seconds=2)
)
print(f"Status: {result.status}")
print(f"Error: {result.error}")
await sandbox.stop()
# Show security features
status = sandbox.get_status()
if 'features' in status:
print(f"\n🛡️ Security features enabled:")
for feature, enabled in status['features'].items():
emoji = "✅" if enabled else "❌"
print(f" {emoji} {feature}: {enabled}")
if __name__ == "__main__":
print("🔒 SandlockSandbox Security Demonstration")
print("="*50)
asyncio.run(demonstrate_sandlock_security())
print("\n" + "="*50)
print("🎯 Key Security Benefits:")
print(" • Landlock: Kernel-enforced filesystem allowlisting")
print(" • seccomp-bpf: System call filtering")
print(" • Resource limits: Memory, CPU, process constraints")
print(" • Network isolation: Block unauthorized connections")
print(" • ~5ms overhead: Faster than Docker containers")
print(" • No root required: User-space security")
@@ -1,123 +0,0 @@
"""Social Media Cross-Posting Agent Example.
Demonstrates using PraisonAI Agent with all social media tools
to cross-post content across multiple platforms.
Required environment variables (set only the ones you need):
# X (Twitter)
X_API_KEY, X_API_SECRET, X_ACCESS_TOKEN, X_ACCESS_SECRET
# LinkedIn
LINKEDIN_ACCESS_TOKEN, LINKEDIN_PERSON_URN
# Facebook
FACEBOOK_PAGE_ACCESS_TOKEN, FACEBOOK_PAGE_ID
# Instagram
INSTAGRAM_ACCESS_TOKEN, INSTAGRAM_BUSINESS_ACCOUNT_ID
# TikTok
TIKTOK_ACCESS_TOKEN
# Threads
THREADS_ACCESS_TOKEN, THREADS_USER_ID
# Pinterest
PINTEREST_ACCESS_TOKEN
# Medium
MEDIUM_TOKEN
# WordPress (uses praisonaiwp-cli config — no env vars needed)
# OpenAI (for the agent)
OPENAI_API_KEY
Usage:
python social_media_crosspost.py
"""
from praisonaiagents import Agent
from praisonai_tools import (
# X (Twitter)
post_to_x,
# LinkedIn
linkedin_post_text,
linkedin_post_image,
linkedin_post_article,
# Facebook
facebook_post_text,
facebook_post_image,
facebook_post_link,
# Instagram
instagram_post_image,
instagram_post_reel,
# TikTok
tiktok_post_video,
tiktok_post_photo,
# Threads
threads_post_text,
threads_post_image,
# Pinterest
pinterest_create_pin,
pinterest_list_boards,
# Medium
medium_publish_post,
# WordPress
create_wp_post,
check_wp_duplicate,
)
# Create a social media manager agent
agent = Agent(
name="Social Media Manager",
instructions="""You are a social media manager. You help users cross-post content
across multiple platforms including X (Twitter), LinkedIn, Facebook, Instagram,
TikTok, Threads, Pinterest, Medium, and WordPress.
When asked to cross-post:
1. Adapt the content format for each platform (character limits, hashtags, etc.)
2. Use the appropriate tool for each platform
3. Report which platforms succeeded and which had errors
Platform-specific notes:
- X: 280 char limit
- LinkedIn: 3000 char limit, professional tone
- Facebook: No strict limit, supports links
- Instagram: Needs image URL (public URL), max 2200 chars caption
- TikTok: Video/photo only, 150 char title
- Threads: 500 char limit
- Pinterest: Needs board_id and image URL
- Medium: Full article support (markdown/HTML), default to 'draft' status
- WordPress: Full article support (HTML/Gutenberg blocks), check duplicates first
""",
tools=[
post_to_x,
linkedin_post_text,
linkedin_post_image,
linkedin_post_article,
facebook_post_text,
facebook_post_image,
facebook_post_link,
instagram_post_image,
instagram_post_reel,
tiktok_post_video,
tiktok_post_photo,
threads_post_text,
threads_post_image,
pinterest_create_pin,
pinterest_list_boards,
medium_publish_post,
create_wp_post,
check_wp_duplicate,
],
)
# Example: Post to all text-based platforms
result = agent.start(
"Post this announcement to LinkedIn and Threads: "
"'PraisonAI v2.0 is here! Build AI agents in 3 lines of code. "
"Multi-agent workflows, memory, tools, and more. Try it: pip install praisonaiagents'"
)
print(result)
@@ -1,49 +0,0 @@
"""HeyGen + ElevenLabs Video Generation Example.
Generate an AI avatar video using HeyGen with ElevenLabs voice.
The agent autonomously: generates audio → uploads to HeyGen → creates video → waits for completion.
Required env vars:
HEYGEN_API_KEY: HeyGen API key (https://app.heygen.com/settings/api)
ELEVENLABS_API_KEY: ElevenLabs API key (https://elevenlabs.io)
OPENAI_API_KEY: OpenAI API key (for the agent LLM)
Usage:
export HEYGEN_API_KEY=your_key
export ELEVENLABS_API_KEY=your_key
export OPENAI_API_KEY=your_key
python video_heygen_elevenlabs.py
"""
from praisonaiagents import Agent
from praisonai_tools import (
elevenlabs_speak_to_file,
heygen_upload_asset,
heygen_generate_video_with_audio,
heygen_wait_for_video,
)
agent = Agent(
name="Video Producer",
instructions="""You create AI avatar videos. Follow these steps:
Step 1: Call elevenlabs_speak_to_file with text and output_path="/tmp/speech.mp3"
Step 2: Call heygen_upload_asset with file_path="/tmp/speech.mp3", content_type="audio/mpeg"
Step 3: Call heygen_generate_video_with_audio with the avatar_id and audio_asset_id from Step 2
Step 4: Call heygen_wait_for_video with the video_id from Step 3
Step 5: Report the final video URL
""",
tools=[
elevenlabs_speak_to_file,
heygen_upload_asset,
heygen_generate_video_with_audio,
heygen_wait_for_video,
],
)
result = agent.start(
'Create a video with this script: "Welcome to PraisonAI! '
'Build powerful AI agents in just three lines of code." '
'Use avatar_id: "YOUR_AVATAR_ID"'
)
print(result)
+1 -19
View File
@@ -134,28 +134,10 @@ def main():
except Exception as e:
return {"error": str(e)}
# Safe AST-based math evaluator (no eval on arbitrary expressions)
def _safe_calculate(expression: str) -> str:
import ast
try:
allowed = set("0123456789+-*/.() ")
if not all(c in allowed for c in expression):
return "Error: Invalid characters in expression"
tree = ast.parse(expression, mode="eval")
for node in ast.walk(tree):
if not isinstance(node, (ast.Expression, ast.BinOp, ast.UnaryOp,
ast.Constant, ast.Add, ast.Sub, ast.Mult,
ast.Div, ast.USub, ast.UAdd)):
return "Error: Only basic math operations are allowed"
result = eval(compile(tree, "<expr>", "eval"), {"__builtins__": {}})
return f"Result: {result}"
except Exception as e:
return f"Error: {e}"
# MCP endpoints
mcp_tools = {
"search": {"description": "Search the web", "func": lambda q: f"Results for: {q}"},
"calculate": {"description": "Calculate expression", "func": _safe_calculate},
"calculate": {"description": "Calculate expression", "func": lambda e: str(eval(e)) if e.replace(" ", "").replace("+", "").replace("-", "").replace("*", "").replace("/", "").replace(".", "").isdigit() or True else "Error"},
}
@app.get("/mcp/tools")
+5 -1
View File
@@ -5,7 +5,11 @@ from praisonaiagents import Agent
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant with access to documents.",
knowledge={"sources": ["./docs/guide.pdf"], "vector_store": {"provider": "chroma", "path": "/tmp/chroma_demo"}}
knowledge=["./docs/guide.pdf"], # Add your documents here
knowledge={
"vector_store": "chroma",
"path": "/tmp/chroma_demo"
}
)
# Chat - agent uses knowledge for RAG
+5 -1
View File
@@ -5,7 +5,11 @@ from praisonaiagents import Agent
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant with access to documents.",
knowledge={"sources": ["./docs/guide.pdf"], "vector_store": {"provider": "lancedb", "path": "/tmp/lancedb_test"}}
knowledge=["./docs/guide.pdf"], # Add your documents here
knowledge={
"vector_store": "lancedb",
"path": "/tmp/lancedb_test"
}
)
# Chat - agent uses knowledge for RAG
+5 -1
View File
@@ -5,7 +5,11 @@ from praisonaiagents import Agent
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant with access to documents.",
knowledge={"sources": ["./docs/guide.pdf"], "vector_store": {"provider": "lancedb", "path": "/tmp/lancedb_demo"}}
knowledge=["./docs/guide.pdf"], # Add your documents here
knowledge={
"vector_store": "lancedb",
"path": "/tmp/lancedb_demo"
}
)
# Chat - agent uses knowledge for RAG
+5 -1
View File
@@ -11,7 +11,11 @@ url = os.getenv("PGVECTOR_URL", "postgresql://postgres:postgres@localhost:5433/p
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant with access to documents.",
knowledge={"sources": ["./docs/guide.pdf"], "vector_store": {"provider": "pgvector", "url": url}}
knowledge=["./docs/guide.pdf"], # Add your documents here
knowledge={
"vector_store": "pgvector",
"url": url
}
)
# Chat - agent uses knowledge for RAG
+5 -1
View File
@@ -11,7 +11,11 @@ url = os.getenv("PGVECTOR_URL", "postgresql://postgres:postgres@localhost:5433/p
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant with access to documents.",
knowledge={"sources": ["./docs/guide.pdf"], "vector_store": {"provider": "pgvector", "url": url}}
knowledge=["./docs/guide.pdf"], # Add your documents here
knowledge={
"vector_store": "pgvector",
"url": url
}
)
# Chat - agent uses knowledge for RAG
+1 -1
View File
@@ -15,8 +15,8 @@ if not api_key:
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant with access to documents.",
knowledge=["./docs/guide.pdf"], # Add your documents here
knowledge={
"sources": ["./docs/guide.pdf"],
"vector_store": "pinecone",
"api_key": api_key,
"environment": "us-east-1"
+5 -1
View File
@@ -11,7 +11,11 @@ url = os.getenv("QDRANT_URL", "http://localhost:6333")
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant with access to documents.",
knowledge={"sources": ["./docs/guide.pdf"], "vector_store": {"provider": "qdrant", "url": url}}
knowledge=["./docs/guide.pdf"], # Add your documents here
knowledge={
"vector_store": "qdrant",
"url": url
}
)
# Chat - agent uses knowledge for RAG
+1 -1
View File
@@ -16,8 +16,8 @@ if not weaviate_key:
agent = Agent(
name="Assistant",
instructions="You are a helpful assistant with access to documents.",
knowledge=["./docs/guide.pdf"], # Add your documents here
knowledge={
"sources": ["./docs/guide.pdf"],
"vector_store": "weaviate",
"url": weaviate_url,
"api_key": weaviate_key
-41
View File
@@ -1,41 +0,0 @@
"""
Example file-based action: line-count
Counts lines in files matching a pattern. Demonstrates how actions
receive step config and flags from the workflow YAML.
Usage in workflow:
- name: Count lines
action: line-count
pattern: "*.py"
directory: src/
"""
import os
from pathlib import Path
def run(step, flags, cwd):
"""Count lines in files matching a glob pattern."""
pattern = step.get("pattern", "*.py")
directory = step.get("directory", ".")
target = Path(cwd) / directory
if not target.exists():
return {"ok": False, "error": f"Directory not found: {target}"}
total_lines = 0
file_count = 0
for filepath in target.rglob(pattern):
if filepath.is_file():
try:
total_lines += len(filepath.read_text().splitlines())
file_count += 1
except (UnicodeDecodeError, PermissionError):
continue
return {
"ok": True,
"output": f"{file_count} files, {total_lines} lines ({pattern} in {directory})",
}
-33
View File
@@ -1,33 +0,0 @@
"""
Example file-based action: system-info
Collects basic system information. Demonstrates the action file contract:
- Must define run(step, flags, cwd) → dict
- Return {"ok": True, "output": "..."} on success
- Return {"ok": False, "error": "..."} on failure
Place in: actions/system_info.py (next to workflow)
or: .praison/actions/system_info.py (project-level)
"""
import platform
import os
def run(step, flags, cwd):
"""Collect system information."""
info_parts = [
f"OS: {platform.system()} {platform.release()}",
f"Python: {platform.python_version()}",
f"Machine: {platform.machine()}",
f"CWD: {cwd}",
]
# Optional: include env vars if requested via step config
if step.get("show_env"):
env_vars = step.get("show_env", "").split(",")
for var in env_vars:
var = var.strip()
info_parts.append(f"{var}: {os.environ.get(var, '(not set)')}")
return {"ok": True, "output": " | ".join(info_parts)}
-33
View File
@@ -1,33 +0,0 @@
# Example: File-Based Actions (Option A)
#
# Actions loaded from .py files in the actions/ directory next to this workflow.
# Each action file exports: run(step, flags, cwd) → dict
#
# Directory structure:
# examples/workflows/
# ├── file-actions-demo.yaml ← this file
# └── actions/
# ├── system_info.py ← action: system-info
# └── line_count.py ← action: line-count
#
# Usage:
# praisonai workflow run file-actions-demo.yaml
# praisonai workflow run file-actions-demo.yaml --dry-run
type: job
name: file-actions-demo
description: Demonstrates file-based custom actions from actions/ directory
steps:
- name: System info
action: system-info
- name: Count Python files
action: line-count
pattern: "*.py"
directory: "."
- name: Count YAML files
action: line-count
pattern: "*.yaml"
directory: "."
-40
View File
@@ -1,40 +0,0 @@
# Example Step Workflow: Publish to PyPI
# Usage:
# praisonai workflow run publish-pypi.yaml --dry-run
# praisonai workflow run publish-pypi.yaml
# praisonai workflow run publish-pypi.yaml --major
# praisonai workflow run publish-pypi.yaml --minor
# praisonai workflow run publish-pypi.yaml --no-bump
type: job
name: publish-pypi
description: Publish package to PyPI with automatic version bump
vars:
token_var:
default: PYPI_TOKEN
description: Environment variable for PyPI token
flags:
major: { description: "Bump major version (X.0.0)" }
minor: { description: "Bump minor version (X.Y.0)" }
no-bump: { description: "Skip version bump" }
steps:
- name: Bump version
action: bump-version
file: pyproject.toml
strategy: patch
if: "{{ not flags.no_bump }}"
- name: Clean dist
run: rm -rf dist
- name: Lock dependencies
run: uv lock
- name: Build package
run: uv build
- name: Publish to PyPI
run: uv publish --token ${{ env.PYPI_TOKEN }}
-40
View File
@@ -1,40 +0,0 @@
# Example: YAML-Defined Actions (Option B)
#
# Actions defined inline in the workflow — self-contained, portable.
# No external files needed.
#
# Usage:
# praisonai workflow run yaml-actions-demo.yaml
# praisonai workflow run yaml-actions-demo.yaml --dry-run
type: job
name: yaml-actions-demo
description: Demonstrates YAML-defined custom actions
# Define reusable actions inline
actions:
check-python:
run: python3 --version
count-files:
script: |
import os
cwd = os.getcwd()
py_files = [f for f in os.listdir(cwd) if f.endswith('.py')]
yaml_files = [f for f in os.listdir(cwd) if f.endswith('.yaml') or f.endswith('.yml')]
result = f"Python: {len(py_files)}, YAML: {len(yaml_files)}"
timestamp:
script: |
from datetime import datetime
result = datetime.now().strftime("%Y-%m-%d %H:%M:%S")
steps:
- name: Check Python version
action: check-python
- name: Count project files
action: count-files
- name: Get timestamp
action: timestamp
@@ -1,70 +0,0 @@
# Agent-Centric Job Workflow Example
#
# This workflow demonstrates the new agent-centric step types:
# - agent: AI agent execution
# - judge: AI quality gate with threshold
# - approve: AI or human approval gate
#
# Run with: praisonai workflow run agent-centric-job-workflow.yaml
# Dry run: praisonai workflow run agent-centric-job-workflow.yaml --dry-run
type: job
name: smart-release
description: Intelligent release workflow with AI-powered steps
flags:
major:
description: Bump major version
minor:
description: Bump minor version
skip-approval:
description: Skip approval gate (auto-approve)
steps:
# Step 1: Deterministic - Bump version
- name: Bump version
action: bump-version
strategy: patch
# Step 2: Agent - Generate changelog
- name: Generate changelog
agent:
role: Technical Writer
instructions: |
You are a technical writer who creates clear, concise changelogs.
Focus on user-facing changes, bug fixes, and new features.
prompt: |
Generate a changelog entry for the latest release.
Include sections for: Features, Bug Fixes, and Breaking Changes.
Keep it concise and professional.
model: gpt-4o-mini
output_file: CHANGELOG_ENTRY.md
# Step 3: Judge - Quality check
- name: Quality check
judge:
input_file: CHANGELOG_ENTRY.md
criteria: |
- Completeness: All sections present (Features, Bug Fixes, Breaking Changes)
- Clarity: Easy to understand for end users
- Formatting: Proper markdown structure
- Conciseness: Not overly verbose
threshold: 7.0
on_fail: warn
model: gpt-4o-mini
# Step 4: Approve - Human approval gate
- name: Approve release
approve:
description: Review and approve the release
risk_level: medium
auto_approve: "{{ flags.skip_approval }}"
# Step 5: Deterministic - Build
- name: Build package
run: echo "Building package..."
# Step 6: Deterministic - Publish (conditional)
- name: Publish to PyPI
run: echo "Publishing to PyPI..."
if: "{{ not flags.skip_approval }}"
-27
View File
@@ -1,27 +0,0 @@
# PraisonAI AgentMail Bot Configuration (Zero-Code)
#
# AgentMail = API-first email (no IMAP/SMTP). Programmatic inboxes.
#
# Usage:
# praisonai bot start --config agentmail-bot.yaml
#
# Requires:
# pip install praisonai agentmail
# export AGENTMAIL_API_KEY=am_...
#
# Optional env vars:
# AGENTMAIL_INBOX_ID=inbox_... (reuse existing inbox)
# AGENTMAIL_DOMAIN=mycompany.com (custom domain for new inboxes)
# Agent configuration
agent:
name: "Email Assistant"
instructions: "You are a helpful email assistant. Keep replies concise and professional."
model: "gpt-4o-mini"
memory: true
# Channel configuration (multi-channel format)
channels:
agentmail:
token: "${AGENTMAIL_API_KEY}"
# Optional: inbox_id, domain are resolved from env vars automatically
+6 -6
View File
@@ -34,14 +34,14 @@ variables:
agents: # Canonical: use 'agents' instead of 'roles'
classifier:
role: Request Classifier
instructions: | # Canonical
instructions: # Canonical |
You are an expert at classifying requests into categories.
Respond with ONLY one word: 'technical', 'creative', or 'research'.
goal: Classify incoming requests accurately
researcher:
role: Research Analyst
instructions: | # Canonical
instructions: # Canonical |
You are a skilled research analyst with expertise in technology trends.
You provide concise, factual research findings with citations.
goal: Research topics thoroughly and provide insights
@@ -52,28 +52,28 @@ agents: # Canonical: use 'agents' instead of 'roles'
tech_expert:
role: Technical Expert
instructions: | # Canonical
instructions: # Canonical |
You are a technical expert with deep knowledge in AI and ML.
You provide detailed technical explanations.
goal: Handle technical questions with expertise
creative_writer:
role: Creative Writer
instructions: | # Canonical
instructions: # Canonical |
You are a creative writer who can make complex topics engaging.
You write in a clear, accessible style.
goal: Create engaging content from research
market_analyst:
role: Market Analyst
instructions: | # Canonical
instructions: # Canonical |
You analyze market trends and competitive landscapes.
You provide actionable business insights.
goal: Analyze market trends and opportunities
aggregator:
role: Synthesizer
instructions: | # Canonical
instructions: # Canonical |
You combine findings from multiple sources into coherent reports.
You identify patterns and key insights.
goal: Synthesize all findings into comprehensive reports
-89
View File
@@ -1,89 +0,0 @@
# Hybrid Workflow Example
#
# This workflow demonstrates the `type: hybrid` feature that combines:
# - Deterministic steps (run, action) from job workflows
# - Agent-centric steps (agent, judge, approve) from job workflows
# - Multi-agent workflow steps (workflow, parallel)
#
# Run with: praisonai workflow run hybrid-workflow.yaml
# Dry run: praisonai workflow run hybrid-workflow.yaml --dry-run
type: hybrid
name: hybrid-release-pipeline
description: Hybrid workflow combining shell commands, AI agents, and multi-agent steps
# Define agents for multi-agent workflow steps
agents:
researcher:
name: Researcher
role: Research Analyst
goal: Research and gather information
instructions: Provide concise, factual research findings
model: gpt-4o-mini
writer:
name: Writer
role: Content Writer
goal: Write clear, engaging content
instructions: Write professional documentation
model: gpt-4o-mini
flags:
skip-tests:
description: Skip test execution
auto-approve:
description: Auto-approve deployment
steps:
# Step 1: Deterministic - Check environment
- name: Check environment
run: echo "Checking environment..." && python --version
# Step 2: Agent - Generate release notes
- name: Generate release notes
agent:
role: Technical Writer
instructions: You write clear, concise release notes
prompt: Generate release notes for version 1.2.0 with bug fixes and new features
model: gpt-4o-mini
output_file: RELEASE_NOTES.md
# Step 3: Parallel - Run multiple checks simultaneously
- name: Parallel checks
parallel:
- run: echo "Running lint check..."
- run: echo "Running type check..."
- run: echo "Running security scan..."
# Step 4: Multi-agent workflow step
- name: Research and document
workflow:
agent: researcher
action: Research best practices for release management
# Step 5: Judge - Quality gate
- name: Quality check
judge:
input_file: RELEASE_NOTES.md
criteria: |
- Completeness: All sections present
- Clarity: Easy to understand
- Professional tone
threshold: 7.0
on_fail: warn
# Step 6: Approve - Human approval gate
- name: Approve release
approve:
description: Review and approve the release
risk_level: medium
auto_approve: "{{ flags.auto_approve }}"
# Step 7: Deterministic - Build
- name: Build package
run: echo "Building package..."
if: "{{ not flags.skip_tests }}"
# Step 8: Final notification
- name: Notify completion
run: echo "✅ Hybrid workflow completed successfully!"
@@ -1,87 +0,0 @@
# HeyGen + ElevenLabs Video Generation Workflow
#
# Sequential multi-agent workflow:
# 1. Audio Agent → generates speech with ElevenLabs
# 2. Upload Agent → uploads audio to HeyGen
# 3. Video Agent → triggers HeyGen video generation
# 4. Status Agent → polls and waits for video completion
#
# Usage:
# python video_heygen_elevenlabs_workflow.py
#
# Required env vars:
# HEYGEN_API_KEY, ELEVENLABS_API_KEY, OPENAI_API_KEY
framework: praisonai
process: sequential
agents:
audio_generator:
role: Audio Generator
goal: Generate speech audio from text using ElevenLabs
instructions: |
You generate speech audio files using ElevenLabs text-to-speech.
When given text, call elevenlabs_speak_to_file with the text and output_path.
IMPORTANT: Only pass 'text' and 'output_path' parameters. Use all defaults for other params.
Report the output_path and audio_bytes from the result.
tools:
- elevenlabs_speak_to_file
asset_uploader:
role: Asset Uploader
goal: Upload audio files to HeyGen as assets
instructions: |
You upload audio files to HeyGen for video generation.
Call heygen_upload_asset with the file_path and content_type="audio/mpeg".
Report the asset "id" from the result - this is critical for the next step.
tools:
- heygen_upload_asset
video_generator:
role: Video Generator
goal: Generate HeyGen avatar video using uploaded audio
instructions: |
You create HeyGen avatar videos using external audio.
Call heygen_generate_video_with_audio with the avatar_id and audio_asset_id.
The audio_asset_id comes from the previous step's upload result.
Report the video_id from the result data.
tools:
- heygen_generate_video_with_audio
video_monitor:
role: Video Monitor
goal: Wait for video completion and report the final URL
instructions: |
You monitor HeyGen video generation status.
Call heygen_wait_for_video with the video_id from the previous step.
Use poll_interval=10 and max_wait=300.
When complete, report the video_url from the result.
tools:
- heygen_wait_for_video
steps:
- agent: audio_generator
action: |
Generate speech audio for this text: "{{script}}"
Save to output_path: "/tmp/workflow_speech.mp3"
- agent: asset_uploader
action: |
Upload the audio file at "/tmp/workflow_speech.mp3" to HeyGen.
Use content_type "audio/mpeg".
- agent: video_generator
action: |
Generate a HeyGen video using:
- avatar_id: "{{avatar_id}}"
- audio_asset_id: use the asset id from the previous upload step
- agent: video_monitor
action: |
Wait for the video to complete. Use the video_id from the previous step.
Poll every 10 seconds, max wait 300 seconds.
Report the final video URL.
variables:
script: "Welcome to PraisonAI! Build powerful AI agents in just three lines of code. Fast, simple, and production-ready."
avatar_id: "YOUR_AVATAR_ID"
@@ -1,48 +0,0 @@
#!/usr/bin/env python3
"""Run the HeyGen + ElevenLabs YAML workflow.
This loads the YAML workflow and registers the praisonai_tools
functions so the YAML parser can resolve them by name.
Usage:
export HEYGEN_API_KEY=your_key
export ELEVENLABS_API_KEY=your_key
export OPENAI_API_KEY=your_key
python video_heygen_elevenlabs_workflow.py
"""
import os
from pathlib import Path
from praisonai_tools import (
elevenlabs_speak_to_file,
heygen_upload_asset,
heygen_generate_video_with_audio,
heygen_wait_for_video,
)
from praisonaiagents.workflows.yaml_parser import YAMLWorkflowParser
# Register praisonai_tools functions for YAML tool resolution
tool_registry = {
"elevenlabs_speak_to_file": elevenlabs_speak_to_file,
"heygen_upload_asset": heygen_upload_asset,
"heygen_generate_video_with_audio": heygen_generate_video_with_audio,
"heygen_wait_for_video": heygen_wait_for_video,
}
# Parse YAML workflow
yaml_path = Path(__file__).parent / "video_heygen_elevenlabs.yaml"
parser = YAMLWorkflowParser(tool_registry=tool_registry)
workflow = parser.parse_file(yaml_path)
print("=" * 60)
print("HeyGen + ElevenLabs YAML Workflow")
print("=" * 60)
# Run the workflow
result = workflow.start()
print("\n" + "=" * 60)
print("WORKFLOW RESULT:")
print("=" * 60)
print(result)
@@ -1,275 +0,0 @@
---
description: Review, validate, and merge GitHub pull requests or triage issues
---
# PR / Issue Review Workflow
When given a GitHub PR or Issue URL, follow this procedure end-to-end.
---
## Step 0 — Determine Type
Parse the URL to identify whether it is a **Pull Request** or an **Issue**.
```
https://github.com/MervinPraison/PraisonAI/pull/<NUMBER> → PR
https://github.com/MervinPraison/PraisonAI/issues/<NUMBER> → Issue
```
- **PR** → go to Step 1
- **Issue** → go to Step 8
---
## Step 1 — Fetch PR Metadata
// turbo
```bash
cd /Users/praison/praisonai-package && \
gh pr view <NUMBER> --json title,body,author,state,additions,deletions,changedFiles,headRefName,baseRefName,labels
```
Record: title, author, branch, file count, +/- lines.
---
## Step 2 — Read the Full Diff
// turbo
```bash
cd /Users/praison/praisonai-package && gh pr diff <NUMBER>
```
If the diff is very large (>500 lines), pipe through `head -500` first, then read remaining chunks.
---
## Step 3 — Review the Diff
For each changed file, evaluate against **PraisonAI engineering principles** (from AGENTS.md):
| Principle | What to Check |
|-----------|---------------|
| **Protocol-driven core** | No heavy implementations in `praisonaiagents/` (core SDK) |
| **Lazy imports** | Optional deps imported inside functions, not at module level |
| **DRY** | No code duplication; reuse existing abstractions |
| **Naming conventions** | `add_X()`, `get_X()`, `XConfig`, `XProtocol`, `XAdapter` |
| **Async-safe** | No blocking I/O in async context; asyncio primitives used |
| **Multi-agent safe** | No shared mutable global state without locks |
| **Thread safety** | Double-checked locking for lazy caches; `threading.Lock` for mutables |
| **Security** | No hardcoded secrets; `hmac.compare_digest` for comparisons; restricted `exec()` |
| **Backward compat** | Public API changes require deprecation cycle |
| **Test coverage** | Tests included; TDD pattern; both unit + agentic tests |
**Red flags to catch:**
- Module-level imports of optional deps (chromadb, litellm, etc.)
- Hardcoded credentials or `debug=True` in production paths
- Direct string comparison for secrets (timing attacks)
- `exec()`/`eval()` without sandbox
- Shared mutable globals without `threading.Lock`
- Missing error handling or swallowed exceptions
---
## Step 4 — Checkout and Run Tests Locally
// turbo
```bash
cd /Users/praison/praisonai-package && git checkout main && git pull origin main
```
// turbo
```bash
cd /Users/praison/praisonai-package && gh pr checkout <NUMBER>
```
Run targeted tests for changed files first:
```bash
cd /Users/praison/praisonai-package/src/praisonai-agents && \
python -m pytest tests/ -x -q \
--ignore=tests/integration/test_whatsapp_web_real.py \
--ignore=tests/unit/tools/test_profiles.py \
--tb=short 2>&1 | tail -20
```
For PRs touching security-sensitive code, also run:
```bash
# Sandbox tests
python -m pytest tests/unit/tools/test_python_tools_sandbox.py -v
# CWE-78 env injection tests
python -m pytest src/praisonai/tests/unit/test_cwe78_env_injection.py -v
# Thread-safety tests
python -m pytest tests/unit/test_thread_safety.py -v
```
---
## Step 5 — Verify No Regressions
Run the full test suite:
```bash
cd /Users/praison/praisonai-package/src/praisonai-agents && \
python -m pytest tests/ -q \
--ignore=tests/integration/test_whatsapp_web_real.py \
--ignore=tests/unit/tools/test_profiles.py \
--tb=no 2>&1 | tail -5
```
**Acceptable result:** All tests pass, or only pre-existing flaky tests fail (e.g., `test_file_memory.py::test_memory_persistence_across_agent_instances`).
**Unacceptable:** Any NEW failure introduced by the PR.
---
## Step 6 — Approve or Request Changes
**If the PR is good:**
```bash
cd /Users/praison/praisonai-package && \
gh pr review <NUMBER> --approve --body "LGTM — reviewed diff, tests pass, follows PraisonAI engineering principles."
```
**If changes are needed:**
```bash
cd /Users/praison/praisonai-package && \
gh pr review <NUMBER> --request-changes --body "Requesting changes: <specific feedback>"
```
---
## Step 7 — Merge
```bash
cd /Users/praison/praisonai-package && \
gh pr merge <NUMBER> --merge --subject "<PR title>"
```
Verify merge:
// turbo
```bash
cd /Users/praison/praisonai-package && gh pr view <NUMBER> --json state,mergedAt
```
Then return to main:
// turbo
```bash
cd /Users/praison/praisonai-package && git checkout main && git pull origin main
```
---
## Step 8 — Issue Triage (if URL is an Issue)
### 8a. Fetch issue details
// turbo
```bash
cd /Users/praison/praisonai-package && \
gh issue view <NUMBER> --json title,body,author,state,labels,comments
```
### 8b. Classify severity
| Tier | Criteria | Examples |
|------|----------|---------|
| **Tier 1 — Critical** | Security vuln, data loss, crash in hot path | exec() without sandbox, hardcoded secrets, unprotected globals |
| **Tier 2 — High** | Performance regression, broken feature, wrong output | Duplicate API calls, memory leak, silent failure |
| **Tier 3 — Medium** | DX issue, missing validation, doc gap | Bad error messages, missing CLI parity, stale docs |
| **Tier 4 — Low** | Cosmetic, code style, minor refactor | Trailing whitespace, naming inconsistency |
### 8c. Deep analysis (for Tier 1-2)
1. Read ALL relevant source files end-to-end
2. Trace the code path that the issue describes
3. Identify root cause with file paths and line numbers
4. Assess blast radius (what else could be affected)
5. Determine if the issue is **actually what it claims** (re-classify if needed)
### 8d. Delegate Implementation to GitHub Workflow Agents
> **KEY PHILOSOPHY: We act as the Manager, GitHub Actions execute the Workflow.**
**DO NOT implement the fix yourself locally.** PraisonAI uses autonomous GitHub Action workflows (such as `gemini-issue-review.yml` and `claude.yml`) to automatically resolve issues and create PRs. Your job as the local agent is to supervise, analyze gaps, and trigger these cloud agents to do the heavy lifting. If there is a gap (e.g. strict test violations), provide detailed relevant information in the PR/Issue and trigger the agents again.
1. Issue the command to trigger the cloud agent on the issue:
```bash
cd /Users/praison/praisonai-package && \
gh issue comment <NUMBER> --body "@gemini please review and fix this issue"
```
*(Note: You can use `@claude` or `@gemini` depending on preference or active bots).*
2. Check the GitHub Actions logs (`gh run list`) and wait for the cloud agent to open a Pull Request (`gh pr list`).
3. Once the cloud bot opens a Pull Request for the issue, return to **Step 1** to review the PR, test the branch locally, and merge it if it passes the checks.
---
## Step 9 — (Skipped) Local PR Creation
> **Note:** As the local agent, you should delegate code fixes to the cloud agents. Only implement code locally and create a PR if the USER explicitly forces you to bypass the cloud agents. If forced, use standard prefixes: `fix:`, `feat:`, `security:`, `refactor:`, `docs:`, `test:`.
---
## Step 10 — Security-Specific Checks
When reviewing security-related PRs, additionally verify:
### Credentials / Secrets
```bash
# Check for hardcoded secrets
grep -rn "secret\|password\|token\|api_key" --include="*.py" <changed-files> | \
grep -v "test_\|#\|environ\|getenv\|config"
```
### Timing Attacks
```bash
# Ensure hmac.compare_digest for secret comparisons
grep -rn "==.*api_key\|==.*secret\|==.*token" --include="*.py" <changed-files>
```
### Authentication & Workflow Secrets
When reviewing GitHub Actions workflows (especially ones using cloud actions like `claude-code-action`):
- **OIDC Validation**: Any workflow using OIDC to authenticate with a cloud provider (e.g. AWS Bedrock for Claude, GCP for Vertex) **MUST** include `id-token: write` in the job's `permissions`. Without it, you will see `Could not fetch an OIDC token` errors.
- **Valid PAT Usage**: When injecting tokens into workflows via `github_token:`, ensure you use `secrets.GH_TOKEN`. `secrets.PAT_TOKEN` has been known to be invalid or cause `401 Bad credentials` errors when curling GitHub resources. By design, `@copilot` mentions also strictly require `GH_TOKEN`.
### Supply Chain
```bash
# Check dependency versions
pip show <package-name>
# Check for known compromised versions
pip install <package>==999 2>&1 | grep "from versions"
```
### IoC Scanning
```bash
# Check for known malicious files
find $(python -c "import site; print(site.getsitepackages()[0])") -name "<suspicious-file>" 2>/dev/null
```
---
## Quick Reference — Common Commands
| Action | Command |
|--------|---------|
| View PR | `gh pr view <N> --json title,body,state,additions,deletions` |
| View diff | `gh pr diff <N>` |
| Checkout PR | `gh pr checkout <N>` |
| List open PRs | `gh pr list` |
| List open issues | `gh issue list` |
| View issue | `gh issue view <N>` |
| Approve PR | `gh pr review <N> --approve` |
| Request changes | `gh pr review <N> --request-changes --body "..."` |
| Merge PR | `gh pr merge <N> --merge` |
| Create PR | `gh pr create --title "..." --body "..." --head <branch> --base main` |
| Run tests | `cd src/praisonai-agents && python -m pytest tests/ -q --tb=no` |
| Check dep version | `pip show <package>` |
@@ -1,44 +0,0 @@
---
description: PR review chain — how automated reviews flow for every PR
---
## Review Chain (Sequential)
> **KEY PHILOSOPHY: We act as the Manager, GitHub Actions execute the Workflow.**
> As the local agent, our job is to analyze, supervise, and coordinate the cloud bots. If we identify a gap in the review chain or code (e.g., missing tests), provide detailed relevant information and trigger the agents (like `@claude`) again.
```
PR opened
↓
CodeRabbit (@coderabbitai) ─── auto for human PRs, triggered via comment for bot PRs
Qodo (/review) ─── auto for human PRs, triggered via comment for bot PRs
Gemini (@gemini) ─── triggered via comment for bot PRs/Issues
↓ (~3-5 min) ↓ (auto triggers Claude on completion)
Copilot (@copilot) ─── triggered ONLY after CodeRabbit or Qodo post their review
↓
Claude (@claude) ─── triggered ONLY after Copilot OR Gemini finishes (final reviewer)
```
## Workflow Files
| File | Trigger | Does what |
|------|---------|-----------|
| `auto-pr-comment.yml` | `issue_comment`, `pull_request_review`, `pull_request:opened` | Triggers Copilot after CodeRabbit/Qodo finish. For bot PRs: triggers CodeRabbit+Qodo+Gemini first. |
| `chain-claude-after-copilot.yml` | `pull_request_review:submitted`, `issue_comment` | Triggers Claude after Copilot reviews, AND automatically after Gemini Code Assist finishes fixing issues/PRs. |
| `claude.yml` | `issue_comment`, `pull_request_review_comment`, `issues:assigned/labeled` | Claude responds to @claude mentions. |
## Bot PR fix
CodeRabbit and Qodo skip `github-actions[bot]` authored PRs by default. The `bot-pr-trigger-reviews` job in `auto-pr-comment.yml` explicitly triggers them via comments.
## Key rules
- **Copilot ignores bot comments.** All `@copilot` mentions MUST use `GH_TOKEN` (not `GITHUB_TOKEN`) so comments post as `MervinPraison`.
- Copilot NEVER triggers before CodeRabbit/Qodo complete.
- Claude NEVER triggers before Copilot completes.
- Duplicate `@copilot` comments are prevented by checking existing comments.
- PraisonAI PRs: NEVER merge automatically — user merges manually.
## Security & Credentials
- **OIDC Configuration (`id-token: write`)**: Any workflow utilizing the `anthropics/claude-code-action@beta` (or similar actions requiring JWTs for AWS Bedrock/GCP Vertex) MUST define `id-token: write` under the job's `permissions` block. Missing this causes deep, opaque failures like "Could not fetch an OIDC token" paired with `Bad credentials` execution limits.
- **Valid `github_token` Payload**: Always pass `secrets.GH_TOKEN` into `github_token` inputs rather than `secrets.PAT_TOKEN`, as the latter has historically proven invalid and caused silent 401 exceptions on curl requests behind the scenes.
+1 -3
View File
@@ -93,6 +93,4 @@ chroma_db/
.praisonai
.windsurf
.ruff_cache
*.sfdx
.sfdx/
.agent
+24 -75
View File
@@ -21,11 +21,9 @@ Simpler than competitors • More extensible • Faster • Agent-centric
| **Minimal API** | Fewer parameters, sensible defaults, explicit overrides |
| **Performance-First** | Lazy loading, optional dependencies, no hot-path regressions |
| **Production-Ready** | Safe by default, multi-agent safe, async-safe |
| **Open Core** | Core free and open source; clear paid upgrade path (support/cloud/services) |
Powerful, lightweight, highly reliable and robust.
Easy and developer-friendly for non-developers.
Each feature runs 3 ways: **CLI, YAML, Python**.
Powerful, lightweight, highly reliable and robust
Easy and developer frienldy for non developers
Easy and user friendly
---
## 2. Repository Structure
@@ -98,33 +96,22 @@ Each feature runs 3 ways: **CLI, YAML, Python**.
| Module | Size | Purpose |
|--------|------|---------|
| `agent/` | 1.7M | Agent class, protocols, handoff, autonomy |
| `memory/` | 784K | Memory protocols, adapters, file memory |
| `context/` | 840K | Context management, artifacts, fast context |
| `tools/` | 816K | Tool SDK, decorators, registry, protocols |
| `llm/` | 756K | LLM client, model router |
| `workflows/` | 472K | Workflow engine, patterns (Route, Parallel, Loop) |
| `mcp/` | 404K | Model Context Protocol integration |
| `eval/` | 384K | Evaluation framework |
| `agents/` | 376K | Multi-agent orchestration (AgentTeam, AgentFlow) |
| `knowledge/` | 300K | Knowledge/RAG protocols, vector stores |
| `agent/` | 1.4M | Agent class, protocols, handoff, autonomy |
| `memory/` | 984K | Memory protocols, adapters, file memory |
| `context/` | 960K | Context management, artifacts, fast context |
| `tools/` | 732K | Tool SDK, decorators, registry, protocols |
| `llm/` | 620K | LLM client, model router |
| `workflows/` | 456K | Workflow engine, patterns (Route, Parallel, Loop) |
| `knowledge/` | 436K | Knowledge/RAG protocols, vector stores |
| `hooks/` | 260K | Hook system, middleware, events |
| `eval/` | 240K | Evaluation framework |
| `rag/` | 264K | RAG protocols, retriever, reranker |
| `config/` | 252K | Feature configs (ExecutionConfig, OutputConfig, etc.) |
| `session/` | 224K | Session management, persistence |
| `plugins/` | 204K | Plugin manager, registry |
| `hooks/` | 184K | Hook system, middleware, events |
| `storage/` | 136K | Storage protocols, adapters |
| `scheduler/` | 132K | Schedule models, store, parser, runner |
| `trace/` | 116K | Trace protocols, context events |
| `approval/` | 92K | Human-in-the-loop approval protocols |
| `bots/` | 80K | BotOS protocols, config |
| `policy/` | 76K | Policy engine |
| `gateway/` | 60K | Gateway protocols |
| `sandbox/` | 56K | Code execution sandbox |
| `plugins/` | 56K | Plugin manager, registry |
| `policy/` | 64K | Policy engine |
| `bus/` | 48K | Event bus |
| `streaming/` | 44K | Streaming events, callbacks |
| `conditions/` | 40K | Conditional logic protocols |
| `db/` | 32K | Database adapter protocols |
| `streaming/` | 56K | Streaming events, callbacks |
| `trace/` | 152K | Trace protocols, context events |
| `scheduler/` | 48K | Schedule models, store, parser, runner |
### 3.2 Protocol-First Design
@@ -136,8 +123,6 @@ Pattern: Each major module has a protocols.py file
- Protocols define WHAT (interface contract)
- Adapters implement HOW (concrete implementation)
- Naming: XProtocol for interfaces, XAdapter for implementations
(ALWAYS suffix with "Protocol" — never use bare concept names like TraceSink)
- File placement: All protocols live in protocols.py within their module
- Users can implement any protocol for custom behavior
```
@@ -301,19 +286,9 @@ save() / load() # Disk persistence (NOT store)
# Configuration
class XConfig: # Configuration dataclass (MemoryConfig, HooksConfig)
# Protocols — ALWAYS suffix with "Protocol"
class XProtocol(Protocol): # Abstract interface (TraceSinkProtocol, MemoryProtocol)
class XAdapter: # Concrete implementation (ChromaAdapter, FileAdapter)
# ✅ CORRECT protocol naming:
class MemoryProtocol(Protocol): ... # Clear it's a protocol
class SessionStoreProtocol(Protocol): ... # Descriptive + Protocol suffix
class TraceSinkProtocol(Protocol): ... # In protocols.py + suffixed
# ❌ WRONG protocol naming:
class TraceSink(Protocol): ... # Missing Protocol suffix — ambiguous
class IMemory(Protocol): ... # TypeScript convention, not Python
class MemoryBase(Protocol): ... # "Base" implies ABC, not Protocol
# Protocols
class XProtocol(Protocol): # Abstract interface
class XAdapter: # Implementation
# Execution
run() # Synchronous, blocking
@@ -525,9 +500,9 @@ class MyDbAdapter(DbAdapter):
---
## 7. CLI & YAML Representation
## 7. CLI Representation
Every feature must run 3 ways: **Python, CLI, and YAML**.
Every feature must have CLI parity:
```bash
# Basic agent
@@ -649,30 +624,6 @@ pytest tests/unit/
pytest --cov=praisonaiagents tests/
```
### 9.4 Real Agentic Test (MANDATORY)
Every feature MUST include a real agentic test — not just smoke tests.
A **real agentic test** means the agent actually runs and calls the LLM:
```python
# ✅ REAL agentic test — agent runs end-to-end
from praisonaiagents import Agent
agent = Agent(name="test", instructions="You are a helpful assistant")
result = agent.start("Say hello in one sentence")
print(result) # Must produce actual LLM output
# ❌ SMOKE test only — NOT sufficient alone
agent = Agent(name="test") # Just object construction
assert agent.name == "test" # No LLM call
```
**Rules:**
- Both smoke AND real agentic tests are required
- Agent MUST call `agent.start()` with a real prompt
- Agent MUST call the LLM and produce a text response
- Print full output so developers can verify end-to-end behavior
---
## 10. Implementation Checklist
@@ -683,10 +634,8 @@ For every feature/change:
- [ ] **No new deps**: Use optional dependencies only
- [ ] **Lazy imports**: Heavy deps imported inside functions
- [ ] **Naming**: Follow conventions (add_*, get_*, XConfig)
- [ ] **Tests**: TDD — write failing tests first
- [ ] **Real agentic test**: Agent must call LLM end-to-end (§9.4)
- [ ] **Tests**: TDD - write failing tests first
- [ ] **CLI**: Add corresponding CLI command/option
- [ ] **YAML**: Ensure YAML config parity with Python API
- [ ] **Docs**: Update Mintlify documentation
- [ ] **Examples**: Add to examples/ directory
- [ ] **Multi-agent safe**: No shared mutable state
@@ -892,7 +841,7 @@ platforms:
---
## 14. Paid Value Path
## 13. Paid Value Path
The core remains **free and open source**. Clear upgrade paths to paid value:
-192
View File
@@ -1,192 +0,0 @@
# Centralized Logging in PraisonAI Agents
This document explains the enhanced centralized logging system implemented to address inconsistent logging patterns across the codebase.
## Problem Addressed
- **53+ scattered logger instances** with no unified configuration
- **No standard log format** across modules
- **Mixed logging approaches** (logger.debug(), print(), console.print())
- **No structured logging option** for production deployments
- **Difficult filtering** by subsystem in multi-agent runs
## Solution
Enhanced the existing `praisonaiagents/_logging.py` with:
1. **Consistent naming convention**: All loggers follow `praisonaiagents.<module>` pattern
2. **Structured logging support**: JSON output for production environments
3. **Backward compatibility**: Existing code continues to work
4. **Centralized configuration**: Single place to configure all logging
5. **Optional extra data**: Structured data for better observability
## Quick Start
### Basic Usage
```python
# New recommended approach
from praisonaiagents import get_logger
# Automatic module detection
logger = get_logger()
logger.info("This is a log message")
# Explicit module name
logger = get_logger(__name__)
logger.info("Explicit module logging")
```
### Structured Logging
```python
import os
from praisonaiagents import get_logger, configure_structured_logging
# Enable structured JSON logging
os.environ['PRAISONAI_STRUCTURED_LOGS'] = 'true'
configure_structured_logging()
# Logger with extra structured data
logger = get_logger(extra_data={"agent_id": "assistant", "session": "123"})
logger.info("Task completed", extra={"task_id": "task_001", "duration": 1.5})
```
Output:
```json
{
"timestamp": "2026-03-30T21:35:00Z",
"level": "INFO",
"logger": "praisonaiagents.agent.agent",
"message": "Task completed",
"module": "agent",
"function": "start",
"line": 42,
"agent_id": "assistant",
"session": "123",
"task_id": "task_001",
"duration": 1.5
}
```
### Environment Variables
| Variable | Default | Description |
|----------|---------|-------------|
| `LOGLEVEL` | `WARNING` | Global log level (DEBUG, INFO, WARNING, ERROR) |
| `PRAISONAI_STRUCTURED_LOGS` | `false` | Enable JSON structured logging |
### Per-Module Configuration
```bash
# Set specific module to DEBUG level
export LOGLEVEL=INFO
# Configure in Python:
logging.getLogger('praisonaiagents.memory').setLevel(logging.DEBUG)
```
## Migration Guide
### For New Code
Use the new logging utilities:
```python
# ✅ Recommended - new code
from praisonaiagents import get_logger
logger = get_logger()
```
### For Existing Code
**No changes required** - existing code continues to work:
```python
# ✅ Still works - existing code
import logging
logger = logging.getLogger(__name__)
```
**Optional enhancement** for better observability:
```python
# ✅ Enhanced - gradually migrate
from praisonaiagents._logging import get_logger
logger = get_logger(__name__, extra_data={"subsystem": "agent"})
```
## Naming Convention
The `get_logger()` function automatically ensures consistent naming:
| Input | Output Logger Name |
|-------|--------------------|
| `"my_module"` | `"praisonaiagents.my_module"` |
| `"praisonaiagents.existing"` | `"praisonaiagents.existing"` (unchanged) |
| `"praisonai.other"` | `"praisonaiagents.other"` |
| `"__main__"` | `"praisonaiagents.main"` |
| `None` (auto-detect) | `"praisonaiagents.<current_module>"` |
## Production Deployment
### ELK Stack / Elasticsearch
```python
import os
from praisonaiagents import configure_structured_logging
# Enable JSON logging for log shipping
os.environ['PRAISONAI_STRUCTURED_LOGS'] = 'true'
configure_structured_logging()
```
### CloudWatch / Splunk
```python
import logging
from praisonaiagents import get_logger, StructuredFormatter
# Custom handler with structured format
handler = logging.StreamHandler()
handler.setFormatter(StructuredFormatter())
logger = get_logger()
logger.addHandler(handler)
```
### Filtering by Subsystem
With structured logging enabled, you can easily filter logs:
```bash
# Filter by agent subsystem
jq 'select(.logger | startswith("praisonaiagents.agent"))' logs.json
# Filter by specific agent
jq 'select(.agent_id == "assistant")' logs.json
# Filter by session
jq 'select(.session == "session_123")' logs.json
```
## Backward Compatibility
- ✅ All existing `logging.getLogger(__name__)` calls continue to work
- ✅ No performance impact on existing code
- ✅ No breaking changes to public APIs
- ✅ Gradual migration path available
## Examples
See the updated modules for examples:
- `praisonaiagents/plugins/builtin/logging_plugin.py` - Logging plugin with extra data
- `praisonaiagents/memory/memory.py` - Memory module with subsystem tagging
## Benefits
1. **Unified format**: All PraisonAI logs follow the same format
2. **Better observability**: Structured data for monitoring and debugging
3. **Easy filtering**: Filter by subsystem, agent, or session
4. **Production ready**: JSON output for log aggregation systems
5. **Zero breaking changes**: Existing code continues to work unchanged
6. **Performance conscious**: No import-time overhead for normal usage
-20
View File
@@ -1,20 +0,0 @@
import cProfile
import pstats
import io
from praisonaiagents import Agent
# Warm up
for _ in range(100):
_ = Agent(name="Test", llm="gpt-4o-mini", output="silent")
pr = cProfile.Profile()
pr.enable()
for _ in range(5000):
_ = Agent(name="Test", llm="gpt-4o-mini", output="silent")
pr.disable()
s = io.StringIO()
ps = pstats.Stats(pr, stream=s).sort_stats('cumtime')
ps.print_stats(30)
print(s.getvalue())
@@ -1,31 +0,0 @@
import cProfile
import pstats
import io
import time
from praisonaiagents import Agent
def func():
return Agent(name='Test', llm='gpt-4o-mini', output="silent")
# Warm up to fill caches
for _ in range(100):
func()
start_time = time.perf_counter()
for _ in range(1000):
func()
end_time = time.perf_counter()
avg_time = (end_time - start_time) / 1000 * 1_000_000
print(f"Time without profile: {avg_time:.2f} μs")
pr = cProfile.Profile()
pr.enable()
for _ in range(1000):
func()
pr.disable()
s = io.StringIO()
ps = pstats.Stats(pr, stream=s).sort_stats('cumtime')
ps.print_stats(30)
print(s.getvalue())
+39 -103
View File
@@ -59,7 +59,18 @@ _logging.configure_root_logger()
# Import configuration (lightweight, no heavy deps)
from . import _config
# Note: tools, config, memory, workflows, db, obs, knowledge and mcp are lazy-loaded via __getattr__ due to heavy deps
# Lightweight imports that don't trigger heavy dependency chains
from .tools.tools import Tools
from .tools.base import BaseTool, ToolResult, ToolValidationError, validate_tool
from .tools.decorator import tool, FunctionTool
from .tools.registry import get_registry, register_tool, get_tool, ToolRegistry
# db and obs are lazy-loaded via __getattr__ for performance
# Sub-packages for organized imports (pa.config, pa.tools, etc.)
# These enable: import praisonaiagents as pa; pa.config.MemoryConfig
from . import config
from . import tools
# Note: db, obs, knowledge and mcp are lazy-loaded via __getattr__ due to heavy deps
# Embedding API - LAZY LOADED via __getattr__ for performance
# Supports: embedding, embeddings, aembedding, aembeddings, EmbeddingResult, get_dimensions
@@ -114,19 +125,6 @@ def _get_lazy_cache():
# ============================================================================
_LAZY_IMPORTS = {
# Tools (moved from eager imports for lazy loading)
'Tools': ('praisonaiagents.tools.tools', 'Tools'),
'BaseTool': ('praisonaiagents.tools.base', 'BaseTool'),
'ToolResult': ('praisonaiagents.tools.base', 'ToolResult'),
'ToolValidationError': ('praisonaiagents.tools.base', 'ToolValidationError'),
'validate_tool': ('praisonaiagents.tools.base', 'validate_tool'),
'tool': ('praisonaiagents.tools.decorator', 'tool'),
'FunctionTool': ('praisonaiagents.tools.decorator', 'FunctionTool'),
'get_registry': ('praisonaiagents.tools.registry', 'get_registry'),
'register_tool': ('praisonaiagents.tools.registry', 'register_tool'),
'get_tool': ('praisonaiagents.tools.registry', 'get_tool'),
'ToolRegistry': ('praisonaiagents.tools.registry', 'ToolRegistry'),
# Main display utilities (imports rich)
'TaskOutput': ('praisonaiagents.main', 'TaskOutput'),
'ReflectionOutput': ('praisonaiagents.main', 'ReflectionOutput'),
@@ -181,7 +179,9 @@ _LAZY_IMPORTS = {
'HandoffDepthError': ('praisonaiagents.agent.handoff', 'HandoffDepthError'),
'HandoffTimeoutError': ('praisonaiagents.agent.handoff', 'HandoffTimeoutError'),
# Embedding API (Note: embedding/embeddings handled in custom_handler to override subpackage)
# Embedding API
'embedding': ('praisonaiagents.embedding.embed', 'embedding'),
'embeddings': ('praisonaiagents.embedding.embed', 'embedding'),
'aembedding': ('praisonaiagents.embedding.embed', 'aembedding'),
'aembeddings': ('praisonaiagents.embedding.embed', 'aembedding'),
'embed': ('praisonaiagents.embedding.embed', 'embed'),
@@ -203,9 +203,6 @@ _LAZY_IMPORTS = {
# Agent classes
'Agent': ('praisonaiagents.agent.agent', 'Agent'),
'BudgetExceededError': ('praisonaiagents.agent.agent', 'BudgetExceededError'),
'Heartbeat': ('praisonaiagents.agent.heartbeat', 'Heartbeat'),
'HeartbeatConfig': ('praisonaiagents.agent.heartbeat', 'HeartbeatConfig'),
'ImageAgent': ('praisonaiagents.agent.image_agent', 'ImageAgent'),
'VideoAgent': ('praisonaiagents.agent.video_agent', 'VideoAgent'),
'VideoConfig': ('praisonaiagents.agent.video_agent', 'VideoConfig'),
@@ -347,14 +344,6 @@ _LAZY_IMPORTS = {
'ObservabilityEventType': ('praisonaiagents.escalation.observability', 'EventType'),
'DoomLoopDetector': ('praisonaiagents.escalation.doom_loop', 'DoomLoopDetector'),
'MemoryBackend': ('praisonaiagents.config.feature_configs', 'MemoryBackend'),
'LearnConfig': ('praisonaiagents.config.feature_configs', 'LearnConfig'),
'LearnScope': ('praisonaiagents.config.feature_configs', 'LearnScope'),
'LearnMode': ('praisonaiagents.config.feature_configs', 'LearnMode'),
'LearnBackend': ('praisonaiagents.config.feature_configs', 'LearnBackend'),
'LearnProtocol': ('praisonaiagents.memory.learn.protocols', 'LearnProtocol'),
'AsyncLearnProtocol': ('praisonaiagents.memory.learn.protocols', 'AsyncLearnProtocol'),
'LearnManagerProtocol': ('praisonaiagents.memory.learn.protocols', 'LearnManagerProtocol'),
'LearnManager': ('praisonaiagents.memory.learn', 'LearnManager'),
'ChunkingStrategy': ('praisonaiagents.config.feature_configs', 'ChunkingStrategy'),
'GuardrailAction': ('praisonaiagents.config.feature_configs', 'GuardrailAction'),
'WebSearchProvider': ('praisonaiagents.config.feature_configs', 'WebSearchProvider'),
@@ -492,61 +481,8 @@ _LAZY_IMPORTS = {
'PraisonConfig': ('praisonaiagents.config.loader', 'PraisonConfig'),
'PluginsConfig': ('praisonaiagents.config.loader', 'PluginsConfig'),
'DefaultsConfig': ('praisonaiagents.config.loader', 'DefaultsConfig'),
# Centralized Logging Utilities
'get_logger': ('praisonaiagents._logging', 'get_logger'),
'configure_structured_logging': ('praisonaiagents._logging', 'configure_structured_logging'),
'StructuredFormatter': ('praisonaiagents._logging', 'StructuredFormatter'),
}
# ============================================================================
# SUBPACKAGE FUNCTION OVERRIDES
# ============================================================================
# Some subpackage names conflict with function names we want to export.
# Override them here to return the function instead of the module.
# ============================================================================
# Override 'embedding' and 'embeddings' at module level to prevent subpackage import
# These need to be set after _LAZY_IMPORTS is defined but before __getattr__ is created
def _get_embedding_func():
"""Lazy getter for embedding function."""
# Import with alias to avoid overwriting the module proxy
from .embedding.embed import embedding as _embedding_func
return _embedding_func
# Create lazy properties that override the submodule
class _EmbeddingProxy:
"""Proxy object that loads embedding function on first access."""
def __init__(self):
self._func = None
def _load(self):
"""Load the actual embedding function if not already loaded."""
if self._func is None:
self._func = _get_embedding_func()
return self._func
def __call__(self, *args, **kwargs):
return self._load()(*args, **kwargs)
def __getattr__(self, name):
return getattr(self._load(), name)
@property
def __wrapped__(self):
"""Support for inspect.signature() and functools.wraps."""
return self._load()
@property
def __signature__(self):
"""Support for inspect.signature()."""
import inspect
return inspect.signature(self._load())
def __repr__(self):
return f"<lazy proxy for {self._load()!r}>"
_global_embedding_proxy = _EmbeddingProxy()
def _custom_handler(name, cache):
"""Handle special cases that need custom logic."""
@@ -558,39 +494,39 @@ def _custom_handler(name, cache):
cache['AgentManager'] = value
cache['Agents'] = value
return value
# Handle embedding specifically if missing from module dict due to submodule reload
if name in ("embedding", "embeddings"):
return _global_embedding_proxy
# Task removed in v4.0.0 - use Task instead
if name == "Task":
raise ImportError(
"Task has been removed in v4.0.0. Use Task instead.\n"
"Migration: Replace 'from praisonaiagents import Task' with 'from praisonaiagents import Task'\n"
"Task supports all Task features including action, handler, loop_over, etc."
)
# Module imports (return the module itself)
if name == 'tools':
import importlib
mod = importlib.import_module('.tools', 'praisonaiagents')
cache['tools'] = mod
return mod
if name == 'config':
import importlib
mod = importlib.import_module('.config', 'praisonaiagents')
cache['config'] = mod
return mod
if name == 'memory':
import importlib
mod = importlib.import_module('.memory', 'praisonaiagents')
cache['memory'] = mod
return mod
return importlib.import_module('.memory', 'praisonaiagents')
if name == 'workflows':
import importlib
mod = importlib.import_module('.workflows', 'praisonaiagents')
cache['workflows'] = mod
return mod
return importlib.import_module('.workflows', 'praisonaiagents')
raise AttributeError(f"Not handled by custom_handler: {name}")
# Override the submodule with our function proxy
embedding = _global_embedding_proxy
embeddings = embedding # embeddings is an alias
# ============================================================================
# SUBPACKAGE FUNCTION OVERRIDES
# ============================================================================
# Some subpackage names conflict with function names we want to export.
# Override them here to return the function instead of the module.
# ============================================================================
# Override 'embedding' to return the function, not the subpackage
from .embedding.embed import embedding as _embedding_func
embedding = _embedding_func
# Also provide embeddings alias
embeddings = _embedding_func
# Create the __getattr__ function using centralized utility
@@ -598,7 +534,7 @@ __getattr__ = create_lazy_getattr_with_fallback(
mapping=_LAZY_IMPORTS,
module_name=__name__,
cache=_lazy_cache,
fallback_modules=[], # Note: 'embedding' excluded to avoid conflict with embedding() function
fallback_modules=['tools', 'memory', 'config', 'workflows'],
custom_handler=_custom_handler
)
@@ -4,9 +4,8 @@ This module consolidates all logging configuration in one place to avoid duplica
"""
import os
import json
import logging
from typing import Any, Dict, List, Optional, Union
from typing import List
# ========================================================================
# ENVIRONMENT CONFIGURATION
@@ -162,150 +161,5 @@ def initialize_logging():
# It will be called lazily when LLM class is instantiated
# ========================================================================
# STRUCTURED LOGGING SUPPORT
# ========================================================================
class StructuredFormatter(logging.Formatter):
"""JSON formatter for structured logging in production environments."""
_STANDARD_FIELDS: frozenset = frozenset({
"timestamp", "level", "logger", "message",
"module", "function", "line", "exc_info", "stack_info",
})
def format(self, record: logging.LogRecord) -> str:
"""Format log record as structured JSON."""
log_data: Dict[str, Any] = {
"timestamp": self.formatTime(record, self.datefmt),
"level": record.levelname,
"logger": record.name,
"message": record.getMessage(),
"module": record.module,
"function": record.funcName,
"line": record.lineno,
}
# Include exception info if present
if record.exc_info:
log_data["exc_info"] = self.formatException(record.exc_info)
if record.stack_info:
log_data["stack_info"] = self.formatStack(record.stack_info)
# Merge extra fields without overwriting standard log fields
if hasattr(record, 'extra_data'):
extra = {k: v for k, v in record.extra_data.items() if k not in self._STANDARD_FIELDS}
log_data.update(extra)
return json.dumps(log_data)
def configure_structured_logging():
"""Configure structured JSON logging for production environments.
Call this function to enable structured logging across all PraisonAI modules.
Useful for log aggregation systems like ELK, Splunk, or CloudWatch.
Example:
import os
from praisonaiagents._logging import configure_structured_logging
# Enable structured logging
os.environ['PRAISONAI_STRUCTURED_LOGS'] = 'true'
configure_structured_logging()
"""
if os.environ.get('PRAISONAI_STRUCTURED_LOGS', '').lower() == 'true':
structured_formatter = StructuredFormatter()
# Reconfigure the root logger handler so propagating loggers get JSON output
for handler in logging.getLogger().handlers:
handler.setFormatter(structured_formatter)
# Also reconfigure any praisonaiagents loggers that have their own handlers
for logger_name in logging.Logger.manager.loggerDict:
if logger_name.startswith('praisonaiagents.'):
child_logger = logging.getLogger(logger_name)
for handler in child_logger.handlers:
handler.setFormatter(structured_formatter)
# ========================================================================
# CONSISTENT LOGGER NAMING
# ========================================================================
class _ExtraDataAdapter(logging.LoggerAdapter):
"""LoggerAdapter that injects extra_data into every log record."""
def process(self, msg: str, kwargs: Dict[str, Any]) -> tuple:
kwargs.setdefault('extra', {})
kwargs['extra']['extra_data'] = self.extra
return msg, kwargs
def get_logger(
name: Optional[str] = None,
*,
extra_data: Optional[Dict[str, Any]] = None,
) -> Union[logging.Logger, logging.LoggerAdapter]:
"""Get a logger with consistent naming convention for PraisonAI modules.
This function ensures all loggers follow the 'praisonaiagents.<module>' pattern
and provides optional structured logging support.
Args:
name: Logger name. If None, uses the calling module's __name__.
If it doesn't start with 'praisonaiagents.', the prefix is added.
extra_data: Optional dict of extra data to include in all log records.
Returns:
Logger instance with consistent naming and optional structured data.
Example:
# In any module file:
from praisonaiagents._logging import get_logger
logger = get_logger(__name__)
# Or with automatic detection:
logger = get_logger()
# With extra structured data:
logger = get_logger(extra_data={"agent_id": "assistant", "session": "123"})
"""
import inspect
# Auto-detect module name if not provided
if name is None:
frame = inspect.currentframe()
try:
caller_frame = frame.f_back
name = caller_frame.f_globals.get('__name__', 'unknown')
finally:
del caller_frame # avoid reference cycle / frame leak
del frame
# Ensure consistent naming convention
if not name.startswith('praisonaiagents.'):
if name == '__main__':
name = 'praisonaiagents.main'
elif name == 'praisonai' or name.startswith('praisonai.'):
# Handle cases like 'praisonai.something' -> 'praisonaiagents.something'
name = 'praisonaiagents' + name[len('praisonai'):]
else:
# Add prefix for non-praisonai modules
name = f'praisonaiagents.{name}'
base_logger = logging.getLogger(name)
# Wrap with adapter when extra structured data is requested
if extra_data:
return _ExtraDataAdapter(base_logger, extra_data)
return base_logger
# ========================================================================
# BACKWARD COMPATIBILITY ALIASES
# ========================================================================
# These maintain compatibility with existing code
getLogger = get_logger # Snake case alias
get_praisonai_logger = get_logger # Descriptive alias
# Auto-initialize on import (but NOT litellm)
initialize_logging()
@@ -1,12 +1,4 @@
"""Agent module for AI agents - uses lazy loading for performance
The Agent class has been decomposed into focused modules for better maintainability:
- tool_execution: Tool calling and execution functionality
- chat_handler: Chat and conversation management
- session_manager: Session persistence and state management
Backward compatibility is maintained via mixins in the main Agent class.
"""
"""Agent module for AI agents - uses lazy loading for performance"""
# Lazy loading cache
_lazy_cache = {}
@@ -21,18 +13,6 @@ def __getattr__(name):
from .agent import Agent
_lazy_cache[name] = Agent
return Agent
if name == 'BudgetExceededError':
from .agent import BudgetExceededError
_lazy_cache[name] = BudgetExceededError
return BudgetExceededError
if name == 'Heartbeat':
from .heartbeat import Heartbeat
_lazy_cache[name] = Heartbeat
return Heartbeat
if name == 'HeartbeatConfig':
from .heartbeat import HeartbeatConfig
_lazy_cache[name] = HeartbeatConfig
return HeartbeatConfig
# Specialized agents - lazy loaded (import rich)
if name == 'ImageAgent':
@@ -161,39 +141,10 @@ def __getattr__(name):
_lazy_cache[name] = value
return value
# Decomposed mixins - for advanced use cases
if name == 'ToolExecutionMixin':
from .tool_execution import ToolExecutionMixin
_lazy_cache[name] = ToolExecutionMixin
return ToolExecutionMixin
elif name == 'ChatHandlerMixin':
from .chat_handler import ChatHandlerMixin
_lazy_cache[name] = ChatHandlerMixin
return ChatHandlerMixin
elif name == 'SessionManagerMixin':
from .session_manager import SessionManagerMixin
_lazy_cache[name] = SessionManagerMixin
return SessionManagerMixin
elif name == 'ChatMixin':
from .chat_mixin import ChatMixin
_lazy_cache[name] = ChatMixin
return ChatMixin
elif name == 'ExecutionMixin':
from .execution_mixin import ExecutionMixin
_lazy_cache[name] = ExecutionMixin
return ExecutionMixin
elif name == 'MemoryMixin':
from .memory_mixin import MemoryMixin
_lazy_cache[name] = MemoryMixin
return MemoryMixin
raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
__all__ = [
'Agent',
'BudgetExceededError',
'Heartbeat',
'HeartbeatConfig',
'ImageAgent',
'VideoAgent',
'VideoConfig',
@@ -247,11 +198,4 @@ __all__ = [
'MemoryAwareAgentProtocol',
'FullAgentProtocol',
'ContextEngineerProtocol',
# Decomposed mixins (for advanced use cases)
'ToolExecutionMixin',
'ChatHandlerMixin',
'SessionManagerMixin',
'ChatMixin',
'ExecutionMixin',
'MemoryMixin',
]
File diff suppressed because it is too large. Load diff
@@ -9,7 +9,6 @@ Follows the Agent() class patterns:
"""
import os
import logging
from praisonaiagents._logging import get_logger
import warnings
from dataclasses import dataclass, field
from typing import Optional, Any, Dict, Union, BinaryIO
@@ -18,6 +17,7 @@ from pathlib import Path
# Filter out Pydantic warning about fields
warnings.filterwarnings("ignore", "Valid config keys have changed in V2", UserWarning)
# ─────────────────────────────────────────────────────────────────────────────
# AudioConfig - Configuration dataclass following feature_configs.py patterns
# ─────────────────────────────────────────────────────────────────────────────
@@ -59,6 +59,7 @@ class AudioConfig:
"api_key": self.api_key,
}
# ─────────────────────────────────────────────────────────────────────────────
# AudioAgent Class - Agent-centric audio processing
# ─────────────────────────────────────────────────────────────────────────────
@@ -191,10 +192,10 @@ class AudioAgent:
def _configure_logging(self, verbose: Union[bool, int]) -> None:
"""Configure logging levels."""
if isinstance(verbose, int) and verbose >= 10:
get_logger("litellm").setLevel(logging.DEBUG)
logging.getLogger("litellm").setLevel(logging.DEBUG)
else:
get_logger("litellm").setLevel(logging.WARNING)
get_logger("httpx").setLevel(logging.WARNING)
logging.getLogger("litellm").setLevel(logging.WARNING)
logging.getLogger("httpx").setLevel(logging.WARNING)
def _get_model_params(self, model: Optional[str] = None) -> Dict[str, Any]:
"""Build parameters for LiteLLM calls."""
@@ -35,9 +35,8 @@ from dataclasses import dataclass, field
from typing import Optional, Dict, Any, List, Set
from enum import Enum
import logging
from praisonaiagents._logging import get_logger
logger = get_logger(__name__)
logger = logging.getLogger(__name__)
# ============================================================================
# Unified Stage Enum (G-DUP-1 fix: single source of truth)
@@ -73,15 +72,6 @@ _ESCALATION_TO_AUTONOMY_SIGNAL = {
# Reverse map for converting autonomy signal strings back to EscalationSignal values
_AUTONOMY_TO_ESCALATION_SIGNAL = {v: k for k, v in _ESCALATION_TO_AUTONOMY_SIGNAL.items()}
# Valid autonomy modes
VALID_AUTONOMY_MODES = {"caller", "iterative"}
# Smart default mode based on level
_LEVEL_TO_DEFAULT_MODE = {
"suggest": "caller",
"auto_edit": "caller",
"full_auto": "iterative",
}
@dataclass
class AutonomyConfig:
@@ -93,10 +83,6 @@ class AutonomyConfig:
Attributes:
enabled: Whether autonomy is enabled
level: Autonomy level (suggest, auto_edit, full_auto)
mode: Execution mode — "caller" (single chat call, wrapper-equivalent)
or "iterative" (internal loop with completion detection).
Defaults based on level: suggest/auto_edit → "caller",
full_auto → "iterative".
max_iterations: Maximum iterations before stopping
doom_loop_threshold: Number of repeated actions to trigger doom loop
auto_escalate: Whether to automatically escalate complexity
@@ -113,21 +99,18 @@ class AutonomyConfig:
Usage::
# Simple — default caller mode (wrapper-equivalent, no wasteful loop)
Agent(autonomy=True) # level=suggest, mode=caller
# Full auto — iterative loop with completion detection
# Simple — full_auto auto-enables tracking + sandbox
Agent(autonomy="full_auto")
# Ralph Loop — explicit iterative mode with completion promise
# Advanced — explicit config
Agent(autonomy=AutonomyConfig(
mode="iterative",
completion_promise="COMPLETE",
level="full_auto",
track_changes=True,
sandbox=SandboxConfig.native(writable_paths=["./src"]),
))
"""
enabled: bool = True
level: str = "suggest"
mode: Optional[str] = None # None = smart default based on level
max_iterations: int = 20
doom_loop_threshold: int = 3
auto_escalate: bool = True
@@ -139,8 +122,6 @@ class AutonomyConfig:
track_changes: Optional[bool] = None # None = auto (True for full_auto)
sandbox: Optional[Any] = None # SandboxConfig (lazy import to avoid circular)
snapshot_dir: Optional[str] = None # Defaults to ~/.praisonai/snapshots
# Default tools for autonomy mode (auto-populated with code intelligence tools)
default_tools: Optional[List[Any]] = None # None = auto (uses get_autonomy_default_tools())
def __post_init__(self):
if self.level not in VALID_AUTONOMY_LEVELS:
@@ -148,21 +129,15 @@ class AutonomyConfig:
f"Invalid autonomy level: {self.level!r}. "
f"Must be one of {sorted(VALID_AUTONOMY_LEVELS)}"
)
# Smart default mode based on level
if self.mode is None:
self.mode = _LEVEL_TO_DEFAULT_MODE.get(self.level, "caller")
elif self.mode not in VALID_AUTONOMY_MODES:
raise ValueError(
f"Invalid autonomy mode: {self.mode!r}. "
f"Must be one of {sorted(VALID_AUTONOMY_MODES)}"
)
# Auto-enable track_changes for full_auto if not explicitly set
if self.track_changes is None:
self.track_changes = (self.level == "full_auto")
# Default snapshot directory
if self.snapshot_dir is None:
from ..paths import get_snapshots_dir
self.snapshot_dir = str(get_snapshots_dir())
import os
self.snapshot_dir = os.path.join(
os.path.expanduser("~"), ".praisonai", "snapshots"
)
@property
def effective_track_changes(self) -> bool:
@@ -181,7 +156,6 @@ class AutonomyConfig:
return cls(
enabled=data.get("enabled", True),
level=level,
mode=data.get("mode"), # None = smart default in __post_init__
max_iterations=data.get("max_iterations", 20),
doom_loop_threshold=data.get("doom_loop_threshold", 3),
auto_escalate=data.get("auto_escalate", True),
@@ -192,9 +166,9 @@ class AutonomyConfig:
track_changes=data.get("track_changes"),
sandbox=data.get("sandbox"),
snapshot_dir=data.get("snapshot_dir"),
default_tools=data.get("default_tools"),
)
class AutonomySignal(str, Enum):
"""Signals detected from prompts for autonomy decisions.
@@ -213,27 +187,26 @@ class AutonomySignal(str, Enum):
COMPLEX_KEYWORDS = "complex_keywords"
def __init_subclass__(cls, **kwargs):
from ..utils.deprecation import warn_deprecated_param
warn_deprecated_param(
"AutonomySignal class",
since="1.0.0",
removal="2.0.0",
alternative="use EscalationSignal from praisonaiagents.escalation.types instead",
stacklevel=3
import warnings
warnings.warn(
"AutonomySignal is deprecated. Use EscalationSignal instead.",
DeprecationWarning,
stacklevel=2,
)
super().__init_subclass__(**kwargs)
def _warn_autonomy_signal():
"""Emit deprecation warning when AutonomySignal is accessed."""
from ..utils.deprecation import warn_deprecated_param
warn_deprecated_param(
"AutonomySignal",
since="1.0.0",
removal="2.0.0",
alternative="use EscalationSignal from praisonaiagents.escalation.types instead",
stacklevel=4
import warnings
warnings.warn(
"AutonomySignal is deprecated. Use EscalationSignal from "
"praisonaiagents.escalation.types instead.",
DeprecationWarning,
stacklevel=3,
)
class AutonomyTrigger:
"""Detects signals from prompts for autonomy decisions.
@@ -279,6 +252,7 @@ class AutonomyTrigger:
pass
return self._delegate.recommend_stage(esc_signals)
@dataclass
class AutonomyResult:
"""Result of an autonomous execution.
@@ -313,6 +287,7 @@ class AutonomyResult:
"""
return self.output or ""
class DoomLoopTracker:
"""Tracks actions to detect doom loops with graduated recovery.
@@ -402,19 +377,12 @@ class DoomLoopTracker:
"""
self._delegate.mark_progress(marker)
def record_response(self, text: str) -> None:
"""Record model response text for content streaming loop detection.
Args:
text: The model's response text
"""
self._delegate.record_response(text)
def reset(self) -> None:
"""Reset the tracker completely."""
self._delegate.start_session()
self._recovery_attempts = 0
class AutonomyMixin:
"""Helper-only trait for autonomy utilities.
@@ -1,118 +0,0 @@
"""
Chat handler mixin for the Agent class.
Contains chat management, response processing, and message formatting.
Extracted from agent.py for better modularity and maintainability.
"""
import logging
import time
from typing import Optional, Any, Dict, List, TYPE_CHECKING
if TYPE_CHECKING:
pass
logger = logging.getLogger(__name__)
class ChatHandlerMixin:
"""Mixin providing chat handling methods for the Agent class.
This mixin focuses on high-level chat coordination and response processing,
while the actual LLM interaction is handled by ChatMixin.
"""
def _format_chat_response(self, response: str, metadata: Optional[Dict[str, Any]] = None) -> str:
"""Format chat response with any necessary post-processing.
Args:
response: Raw response from the LLM
metadata: Optional metadata about the response
Returns:
Formatted response string
"""
if not response:
return ""
# Basic response formatting - can be extended with additional logic
formatted = response.strip()
# Add any metadata-based formatting if needed
if metadata and metadata.get('add_timestamp'):
timestamp = time.strftime('%Y-%m-%d %H:%M:%S')
formatted = f"[{timestamp}] {formatted}"
return formatted
def _validate_chat_input(self, prompt: str) -> bool:
"""Validate chat input before processing.
Args:
prompt: Input prompt to validate
Returns:
True if valid, False otherwise
"""
if not prompt or not isinstance(prompt, str):
logger.warning("Invalid chat input: prompt must be a non-empty string")
return False
if len(prompt.strip()) == 0:
logger.warning("Invalid chat input: prompt cannot be empty or whitespace only")
return False
return True
def _prepare_chat_context(self, prompt: str, **kwargs) -> Dict[str, Any]:
"""Prepare context for chat processing.
Args:
prompt: Input prompt
**kwargs: Additional context parameters
Returns:
Context dictionary for chat processing
"""
context = {
'prompt': prompt,
'timestamp': time.time(),
'agent_name': getattr(self, 'name', None) or 'Agent',
}
# Add any additional context from kwargs
context.update(kwargs)
return context
def _handle_chat_error(self, error: Exception, prompt: str) -> str:
"""Handle chat processing errors gracefully.
Args:
error: The exception that occurred
prompt: The original prompt that caused the error
Returns:
Error response message
"""
logger.error(f"Chat error occurred: {error}", exc_info=True)
# Return a user-friendly error message without exposing internal details.
# Include a timestamp reference so users can correlate with server logs.
error_ref = time.strftime('%Y%m%d%H%M%S')
return f"I encountered an error while processing your request (ref: {error_ref}). Please try again."
def _log_chat_interaction(self, prompt: str, response: str, duration: Optional[float] = None):
"""Log chat interaction for debugging and analytics.
Args:
prompt: Input prompt
response: Generated response
duration: Processing duration in seconds
"""
agent_name = getattr(self, 'name', None) or 'Agent'
duration_str = f" (took {duration:.2f}s)" if duration else ""
logger.debug(f"[{agent_name}] Chat interaction{duration_str}")
logger.debug(f"[{agent_name}] Prompt: {prompt[:100]}{'...' if len(prompt) > 100 else ''}")
logger.debug(f"[{agent_name}] Response: {response[:100]}{'...' if len(response) > 100 else ''}")
File diff suppressed because it is too large. Load diff
@@ -4,7 +4,7 @@ from dataclasses import dataclass, field, asdict
from typing import Any, Dict, List, Optional, Union
import asyncio
import logging
from praisonaiagents._logging import get_logger
@dataclass
class CodeConfig:
@@ -29,6 +29,7 @@ class CodeConfig:
"""Convert config to dictionary."""
return {k: v for k, v in asdict(self).items() if v is not None}
class CodeAgent:
"""Agent for code generation, execution, review, and refactoring.
@@ -95,7 +96,7 @@ class CodeAgent:
self._console = None
# Configure logging
self._logger = get_logger(f"CodeAgent.{name}")
self._logger = logging.getLogger(f"CodeAgent.{name}")
if not verbose:
self._logger.setLevel(logging.WARNING)
@@ -308,9 +309,8 @@ Follow best practices and coding standards."""
# Clean up temp file
try:
os.unlink(temp_file)
except Exception as e:
# Temp file cleanup failed - not critical
get_logger(__name__).debug(f"Failed to clean up temp file {temp_file}: {e}")
except:
pass
async def aexecute(self, code: str, language: str = "python", **kwargs) -> Dict[str, Any]:
"""Execute code asynchronously.
@@ -14,7 +14,6 @@ This class implements proper Context Engineering principles following the PRD te
import os
import json
import logging
from praisonaiagents._logging import get_logger
from datetime import datetime
from pathlib import Path
from typing import Optional, Any, Dict, Union, List, TYPE_CHECKING
@@ -95,6 +94,7 @@ async def _async_subprocess_run(cmd: list, timeout: int = 60) -> tuple:
from ..agent.agent import Agent
from ..task import Task
class ContextAgent(Agent):
"""
Advanced Context Engineering Agent - Comprehensive context generation for AI coding assistants.
@@ -162,8 +162,7 @@ class ContextAgent(Agent):
# Enhanced logging and output management
self.debug_mode = os.getenv('LOGLEVEL', '').lower() == 'debug'
from ..paths import get_project_prp_dir
self.output_dir = get_project_prp_dir() # Save in .praisonai/prp folder
self.output_dir = Path(".praisonai/prp") # Save in .praisonai/prp folder
self.setup_output_directories() # Create directories first
self.setup_logging() # Then setup logging
@@ -207,7 +206,7 @@ class ContextAgent(Agent):
"""Setup comprehensive logging based on debug mode."""
try:
# Create logger
self.logger = get_logger(f"ContextAgent_{id(self)}")
self.logger = logging.getLogger(f"ContextAgent_{id(self)}")
self.logger.setLevel(logging.DEBUG if self.debug_mode else logging.INFO)
# Clear existing handlers
@@ -247,7 +246,7 @@ class ContextAgent(Agent):
except Exception as e:
print(f"⚠️ Warning: Could not setup logging: {e}")
# Create a minimal logger as fallback
self.logger = get_logger(f"ContextAgent_{id(self)}")
self.logger = logging.getLogger(f"ContextAgent_{id(self)}")
self.logger.setLevel(logging.INFO)
def setup_output_directories(self):
@@ -2445,7 +2444,7 @@ This PRP provides:
"""
asyncio = _get_asyncio()
# Run sync method in executor for now (subprocess calls are blocking)
loop = asyncio.get_running_loop()
loop = asyncio.get_event_loop()
return await loop.run_in_executor(
None,
self.analyze_codebase_with_gitingest,
@@ -2461,7 +2460,7 @@ This PRP provides:
Async version of generate_prp.
"""
asyncio = _get_asyncio()
loop = asyncio.get_running_loop()
loop = asyncio.get_event_loop()
return await loop.run_in_executor(
None,
lambda: self.generate_comprehensive_prp(feature_request, context_analysis)
@@ -2476,12 +2475,13 @@ This PRP provides:
Async version of create_implementation_blueprint.
"""
asyncio = _get_asyncio()
loop = asyncio.get_running_loop()
loop = asyncio.get_event_loop()
return await loop.run_in_executor(
None,
lambda: self.build_implementation_blueprint(feature_request, context_analysis)
)
def create_context_agent(llm: Optional[Union[str, Any]] = None, **kwargs) -> ContextAgent:
"""
Factory function to create a ContextAgent following Context Engineering and PRD methodology.
@@ -1,135 +0,0 @@
"""Cost persistence — saves agent cost_summary to disk after runs.
Writes JSON files to ``~/.praisonai/costs/`` for CLI dashboard consumption.
Zero overhead when not used (this module is never imported unless explicitly called).
Usage::
from praisonaiagents.agent.cost_persistence import save_cost_report, load_cost_report
save_cost_report(agent, session_name="my_run")
report = load_cost_report("my_run")
"""
import json
import logging
from praisonaiagents._logging import get_logger
import os
import time
from pathlib import Path
from typing import Any, Dict, List, Optional
logger = get_logger(__name__)
COST_DIR = Path.home() / ".praisonai" / "costs"
def save_cost_report(
agent,
session_name: Optional[str] = None,
) -> str:
"""Persist an agent's cost_summary to disk.
Args:
agent: Agent instance with cost_summary property.
session_name: Optional session identifier. Auto-generated if None.
Returns:
Path to the saved JSON file.
"""
COST_DIR.mkdir(parents=True, exist_ok=True)
name = session_name or f"{agent.name}_{int(time.time())}"
safe_name = "".join(c if c.isalnum() or c in "-_" else "_" for c in name)
summary = getattr(agent, "cost_summary", None)
if summary is None:
summary = {
"tokens_in": 0,
"tokens_out": 0,
"cost": 0.0,
"llm_calls": 0,
}
report = {
"session": name,
"agent_name": getattr(agent, "name", "unknown"),
"timestamp": time.time(),
"iso_time": time.strftime("%Y-%m-%dT%H:%M:%SZ", time.gmtime()),
**summary,
}
filepath = COST_DIR / f"{safe_name}.json"
with open(filepath, "w") as f:
json.dump(report, f, indent=2)
logger.info(f"[costs] Saved cost report to {filepath}")
return str(filepath)
def load_cost_report(session_name: str) -> Optional[Dict[str, Any]]:
"""Load a cost report by session name.
Args:
session_name: Session identifier.
Returns:
Parsed JSON dict, or None if not found.
"""
safe_name = "".join(c if c.isalnum() or c in "-_" else "_" for c in session_name)
filepath = COST_DIR / f"{safe_name}.json"
if filepath.exists():
with open(filepath) as f:
return json.load(f)
return None
def list_cost_reports(limit: int = 20) -> List[Dict[str, Any]]:
"""List recent cost reports, sorted by timestamp (newest first).
Args:
limit: Max number of reports to return.
Returns:
List of parsed JSON report dicts.
"""
if not COST_DIR.exists():
return []
reports = []
for fpath in sorted(COST_DIR.glob("*.json"), key=lambda p: p.stat().st_mtime, reverse=True):
try:
with open(fpath) as f:
reports.append(json.load(f))
except (json.JSONDecodeError, OSError):
continue
if len(reports) >= limit:
break
return reports
def format_cost_table(reports: List[Dict[str, Any]], as_json: bool = False) -> str:
"""Format cost reports for terminal display.
Args:
reports: List of report dicts from list_cost_reports().
as_json: If True, returns JSON string instead of table.
Returns:
Formatted string for terminal output.
"""
if as_json:
return json.dumps(reports, indent=2)
if not reports:
return "No cost reports found."
lines = []
lines.append(f"{'Session':<30} {'Agent':<20} {'Cost ($)':<12} {'Tokens In':<12} {'Tokens Out':<12} {'LLM Calls':<10}")
lines.append("-" * 96)
for r in reports:
lines.append(
f"{r.get('session', '?'):<30} "
f"{r.get('agent_name', '?'):<20} "
f"${r.get('cost', 0):<11.4f} "
f"{r.get('tokens_in', 0):<12} "
f"{r.get('tokens_out', 0):<12} "
f"{r.get('llm_calls', 0):<10}"
)
return "\n".join(lines)
@@ -35,13 +35,13 @@ Example:
import os
import logging
from praisonaiagents._logging import get_logger
import time
import asyncio
from typing import List, Optional, Any, Dict, Literal
from dataclasses import dataclass, field
from enum import Enum
# Data classes for Deep Research response types
@dataclass
class Citation:
@@ -54,6 +54,7 @@ class Citation:
def __repr__(self):
return f"Citation(title='{self.title}', url='{self.url}')"
@dataclass
class ReasoningStep:
"""Represents a reasoning step in the research process."""
@@ -63,6 +64,7 @@ class ReasoningStep:
def __repr__(self):
return f"ReasoningStep(text='{self.text[:50]}...')" if len(self.text) > 50 else f"ReasoningStep(text='{self.text}')"
@dataclass
class WebSearchCall:
"""Represents a web search call made during research."""
@@ -72,6 +74,7 @@ class WebSearchCall:
def __repr__(self):
return f"WebSearchCall(query='{self.query}', status='{self.status}')"
@dataclass
class CodeExecutionStep:
"""Represents a code execution step during research."""
@@ -81,6 +84,7 @@ class CodeExecutionStep:
def __repr__(self):
return f"CodeExecutionStep(input='{self.input_code[:50]}...')" if len(self.input_code) > 50 else f"CodeExecutionStep(input='{self.input_code}')"
@dataclass
class MCPCall:
"""Represents an MCP tool call during research."""
@@ -91,6 +95,7 @@ class MCPCall:
def __repr__(self):
return f"MCPCall(name='{self.name}', server='{self.server_label}')"
@dataclass
class FileSearchCall:
"""Represents a file search call (Gemini-specific)."""
@@ -99,6 +104,7 @@ class FileSearchCall:
def __repr__(self):
return f"FileSearchCall(stores={self.store_names})"
@dataclass
class DeepResearchResponse:
"""
@@ -143,12 +149,14 @@ class DeepResearchResponse:
sources.append({"title": c.title, "url": c.url})
return sources
class Provider(Enum):
"""Supported Deep Research providers."""
OPENAI = "openai"
GEMINI = "gemini"
LITELLM = "litellm"
class DeepResearchAgent:
"""
Agent for performing deep research using multiple provider APIs.
@@ -287,7 +295,7 @@ You are a professional research analyst. When conducting research:
self._gemini_client = None
# Configure logging
self.logger = get_logger(__name__)
self.logger = logging.getLogger(__name__)
if self.verbose:
self.logger.debug(f"DeepResearchAgent initialized: provider={self.provider.value}, model={self.model}")
@@ -860,78 +868,6 @@ You are a professional research analyst. When conducting research:
return self._parse_gemini_response(interaction)
async def _research_gemini_async(
self,
query: str,
instructions: Optional[str] = None,
model: Optional[str] = None,
file_search: bool = False,
file_search_stores: Optional[List[Dict[str, Any]]] = None,
grounding_file_prompt: Optional[str] = None,
) -> DeepResearchResponse:
"""
Async version of _research_gemini with non-blocking polling.
Uses asyncio.sleep() to prevent blocking the event loop.
"""
import asyncio
import time
if self.provider != Provider.GEMINI:
raise ValueError("This method requires GEMINI provider")
if not self.gemini_client:
raise RuntimeError("Gemini client is required for Deep Research")
create_params = {
"query": query,
"file_search": file_search,
}
if instructions:
create_params["instructions"] = instructions
if model:
create_params["model"] = model
if file_search_stores:
create_params["file_search_stores"] = file_search_stores
if grounding_file_prompt:
create_params["grounding_file_prompt"] = grounding_file_prompt
interaction = self.gemini_client.interactions.create(**create_params)
if self.verbose:
self.logger.debug(f"Gemini research started (async): {interaction.id}")
start_time = time.time()
while True:
interaction = self.gemini_client.interactions.get(interaction.id)
if interaction.status == "completed":
if self.verbose:
self.logger.debug("Gemini research completed (async)")
break
elif interaction.status == "failed":
error = getattr(interaction, 'error', 'Unknown error')
raise RuntimeError(f"Gemini Deep Research failed: {error}")
elif interaction.status == "cancelled":
raise RuntimeError("Gemini Deep Research was cancelled")
elapsed = time.time() - start_time
if elapsed > self.max_wait_time:
raise TimeoutError(
f"Gemini Deep Research timed out after {self.max_wait_time}s"
)
if self.verbose:
self.logger.debug(f"Research in progress (async)... ({elapsed:.0f}s)")
# Use async sleep to avoid blocking event loop
await asyncio.sleep(self.poll_interval)
return self._parse_gemini_response(interaction)
def _research_gemini_streaming(
self,
create_params: Dict[str, Any],
@@ -1247,13 +1183,17 @@ You are a professional research analyst. When conducting research:
try:
if self.provider == Provider.GEMINI:
# Use async Gemini method for non-blocking polling
result = await self._research_gemini_async(
query=query,
instructions=instructions,
model=model,
file_search=file_search if file_search is not None else self.enable_file_search,
file_search_stores=file_search_stores or self.file_search_stores,
# Gemini async - run sync in executor
loop = asyncio.get_event_loop()
result = await loop.run_in_executor(
None,
lambda: self._research_gemini(
query=query,
instructions=instructions,
model=model,
file_search=file_search if file_search is not None else self.enable_file_search,
file_search_stores=file_search_stores or self.file_search_stores,
)
)
elif self.provider == Provider.LITELLM:
# LiteLLM async
@@ -12,12 +12,12 @@ Follows the Agent() class patterns with:
import os
import logging
from praisonaiagents._logging import get_logger
import math
from dataclasses import dataclass
from typing import Optional, Dict, Any, Union, List
logger = get_logger(__name__)
logger = logging.getLogger(__name__)
@dataclass
class EmbeddingConfig:
@@ -44,6 +44,7 @@ class EmbeddingConfig:
"api_key": self.api_key,
}
class EmbeddingAgent:
"""
A specialized agent for generating text embeddings.
@@ -163,10 +164,10 @@ class EmbeddingAgent:
def _configure_logging(self, verbose: Union[bool, int]) -> None:
"""Configure logging levels."""
if isinstance(verbose, int) and verbose >= 10:
get_logger("litellm").setLevel(logging.DEBUG)
logging.getLogger("litellm").setLevel(logging.DEBUG)
else:
get_logger("litellm").setLevel(logging.WARNING)
get_logger("httpx").setLevel(logging.WARNING)
logging.getLogger("litellm").setLevel(logging.WARNING)
logging.getLogger("httpx").setLevel(logging.WARNING)
def _get_model_params(self, model: Optional[str] = None) -> Dict[str, Any]:
"""Build parameters for LiteLLM calls."""
File diff suppressed because it is too large. Load diff
@@ -15,7 +15,6 @@ from dataclasses import dataclass, field
from enum import Enum
import inspect
import logging
from praisonaiagents._logging import get_logger
import asyncio
import threading
import time
@@ -23,7 +22,8 @@ import time
if TYPE_CHECKING:
from .agent import Agent
logger = get_logger(__name__)
logger = logging.getLogger(__name__)
class ContextPolicy(Enum):
"""Policy for context sharing during handoff."""
@@ -32,6 +32,7 @@ class ContextPolicy(Enum):
NONE = "none" # No context sharing
LAST_N = "last_n" # Share last N messages
@dataclass
class HandoffConfig:
"""
@@ -97,16 +98,19 @@ class HandoffConfig:
data["context_policy"] = ContextPolicy(data["context_policy"])
return cls(**{k: v for k, v in data.items() if k in cls.__dataclass_fields__})
class HandoffError(Exception):
"""Base exception for handoff errors."""
pass
class HandoffCycleError(HandoffError):
"""Raised when a cycle is detected in handoff chain."""
def __init__(self, chain: List[str]):
self.chain = chain
super().__init__(f"Handoff cycle detected: {' -> '.join(chain)}")
class HandoffDepthError(HandoffError):
"""Raised when max handoff depth is exceeded."""
def __init__(self, depth: int, max_depth: int):
@@ -114,6 +118,7 @@ class HandoffDepthError(HandoffError):
self.max_depth = max_depth
super().__init__(f"Max handoff depth exceeded: {depth} > {max_depth}")
class HandoffTimeoutError(HandoffError):
"""Raised when handoff times out."""
def __init__(self, timeout: float, agent_name: str):
@@ -121,34 +126,41 @@ class HandoffTimeoutError(HandoffError):
self.agent_name = agent_name
super().__init__(f"Handoff to {agent_name} timed out after {timeout}s")
# Thread-local storage for tracking handoff chains
_handoff_context = threading.local()
def _get_handoff_chain() -> List[str]:
"""Get current handoff chain from thread-local storage."""
if not hasattr(_handoff_context, 'chain'):
_handoff_context.chain = []
return _handoff_context.chain
def _get_handoff_depth() -> int:
"""Get current handoff depth."""
return len(_get_handoff_chain())
def _push_handoff(agent_name: str) -> None:
"""Push agent to handoff chain."""
chain = _get_handoff_chain()
chain.append(agent_name)
def _pop_handoff() -> Optional[str]:
"""Pop agent from handoff chain."""
chain = _get_handoff_chain()
return chain.pop() if chain else None
def _clear_handoff_chain() -> None:
"""Clear the handoff chain."""
if hasattr(_handoff_context, 'chain'):
_handoff_context.chain = []
@dataclass
class HandoffInputData:
"""Data passed to a handoff target agent."""
@@ -158,6 +170,7 @@ class HandoffInputData:
handoff_depth: int = 0
handoff_chain: List[str] = field(default_factory=list)
@dataclass
class HandoffResult:
"""Result of a handoff operation."""
@@ -658,6 +671,7 @@ class Handoff:
return handoff_tool
def handoff(
agent: 'Agent',
tool_name_override: Optional[str] = None,
@@ -746,6 +760,7 @@ def handoff(
config=config,
)
# Handoff filters - common patterns for filtering handoff data
class handoff_filters:
"""Common handoff input filters."""
@@ -812,12 +827,14 @@ class handoff_filters:
return data
# Recommended prompt prefix for agents that use handoffs
RECOMMENDED_PROMPT_PREFIX = """You have the ability to transfer tasks to specialized agents when appropriate.
When you determine that a task would be better handled by another agent with specific expertise,
use the transfer tool to hand off the task. The receiving agent will have the full context of
the conversation and will continue helping the user."""
def prompt_with_handoff_instructions(base_prompt: str, agent: 'Agent') -> str:
"""
Add handoff instructions to an agent's prompt.
@@ -1,176 +0,0 @@
"""Heartbeat — runs an agent on a schedule, delivers results via callback.
Standalone wrapper class. Does NOT modify the Agent class.
Usage::
from praisonaiagents import Agent, Heartbeat
agent = Agent(instructions="Check server status")
hb = Heartbeat(agent, schedule="every 30m", prompt="Report status")
hb.start() # blocking loop
# hb.start(blocking=False) # background thread
"""
import asyncio
import logging
from praisonaiagents._logging import get_logger
import threading
import time
from dataclasses import dataclass, field
from typing import Any, Callable, Optional, Union
logger = get_logger(__name__)
@dataclass
class HeartbeatConfig:
"""Configuration for Heartbeat scheduler.
Attributes:
schedule: Human-friendly schedule expression. Supports:
- Keywords: "hourly", "daily", "weekly"
- Intervals: "every 30m", "every 6h", "*/30m", "*/10s"
- Cron: "cron:0 7 * * *"
- One-shot: "at:2026-03-01T09:00:00"
prompt: Override prompt sent to agent each tick. None = use agent's default.
on_result: Callback receiving (result_text: str). Default: log to stdout.
on_error: "retry" | "skip" | callable(error). Default: "retry".
max_retries: Max consecutive retries before skipping. Default: 3.
"""
schedule: str = "hourly"
prompt: Optional[str] = None
on_result: Optional[Callable] = None
on_error: Union[str, Callable] = "retry"
max_retries: int = 3
class Heartbeat:
"""Standalone heartbeat coordinator.
Runs an Agent on a schedule and delivers results via callback.
Does NOT add any params to the Agent class.
Usage::
from praisonaiagents import Agent, Heartbeat
agent = Agent(instructions="Monitor server health")
hb = Heartbeat(agent, schedule="hourly")
hb.start()
"""
def __init__(
self,
agent,
schedule: str = "hourly",
prompt: Optional[str] = None,
on_result: Optional[Callable] = None,
on_error: Union[str, Callable] = "retry",
max_retries: int = 3,
):
self.agent = agent
self.config = HeartbeatConfig(
schedule=schedule,
prompt=prompt,
on_result=on_result,
on_error=on_error,
max_retries=max_retries,
)
self._running = False
self._thread: Optional[threading.Thread] = None
self._interval_seconds = self._resolve_interval(schedule)
def start(self, blocking: bool = True) -> None:
"""Start the heartbeat loop.
Args:
blocking: If True, blocks the calling thread. If False,
runs in a background daemon thread.
"""
self._running = True
if blocking:
self._loop()
else:
self._thread = threading.Thread(target=self._loop, daemon=True)
self._thread.start()
def stop(self) -> None:
"""Stop the heartbeat loop."""
self._running = False
@property
def is_running(self) -> bool:
return self._running
# ── internals ────────────────────────────────────────────────────
def _loop(self) -> None:
"""Main polling loop."""
retries = 0
while self._running:
try:
result = self._tick()
retries = 0 # Reset on success
self._deliver(result)
except Exception as e:
retries += 1
logger.error(f"[heartbeat] {self.agent.name}: error on tick #{retries}: {e}")
if callable(self.config.on_error):
self.config.on_error(e)
elif self.config.on_error == "skip":
logger.warning(f"[heartbeat] Skipping error: {e}")
else: # "retry"
if retries >= self.config.max_retries:
logger.error(
f"[heartbeat] {self.agent.name}: max retries "
f"({self.config.max_retries}) reached, skipping."
)
retries = 0
time.sleep(self._interval_seconds)
def _tick(self) -> str:
"""Execute one heartbeat tick — run the agent and return result."""
prompt = self.config.prompt or "Run your scheduled check."
result = self.agent.start(prompt)
return str(result) if result else ""
def _deliver(self, result: str) -> None:
"""Deliver result via callback or log."""
if self.config.on_result:
self.config.on_result(result)
else:
logger.info(f"[heartbeat] {self.agent.name}: {result[:200]}")
@staticmethod
def _resolve_interval(schedule: str) -> float:
"""Convert schedule string to interval in seconds.
Uses the scheduler parser if available, otherwise falls back to
simple keyword parsing.
"""
try:
from ..scheduler.parser import parse_schedule
sched = parse_schedule(schedule)
if sched.every_seconds:
return float(sched.every_seconds)
except (ImportError, Exception):
pass
# Fallback keyword resolution
keywords = {
"hourly": 3600,
"daily": 86400,
"weekly": 604800,
}
lower = schedule.lower().strip()
if lower in keywords:
return float(keywords[lower])
# Try parsing "every Xm/h/s" patterns
import re
match = re.match(r"(?:every\s+)?(\d+)\s*(s|m|h)", lower)
if match:
val, unit = int(match.group(1)), match.group(2)
multipliers = {"s": 1, "m": 60, "h": 3600}
return float(val * multipliers.get(unit, 60))
return 3600.0 # Default to hourly
Loaded 100 of 584 files, more files were not shown because too many files have changed in this diff. Show more