Skip to content

2.2.18#534

Merged
MervinPraison merged 2 commits intomainfrom
develop
May 29, 2025
Merged

2.2.18#534
MervinPraison merged 2 commits intomainfrom
develop

Conversation

@MervinPraison
Copy link
Copy Markdown
Owner

@MervinPraison MervinPraison commented May 29, 2025

Summary by CodeRabbit

  • Chores
    • Upgraded the PraisonAI package and related dependencies to version 2.2.18 across all Docker environments, documentation, and deployment scripts.
    • Updated dependency requirements for optional features to improve compatibility and stability.
    • Incremented project versions to reflect the latest updates.
  • Tests
    • Enhanced test suite by marking tests that require real API interaction and improved environment variable handling for more reliable test execution.
  • Bug Fixes
    • Improved handling and secure display of API keys in CI workflow debug output, reducing risk of accidental exposure.

- Introduced a dummy class for SecretStr to handle cases where Pydantic is not available, ensuring compatibility in minimal contexts.
- Added a utility function to display API key values more securely, improving the visibility of sensitive information during testing.
- Updated test cases to ensure the OPENAI_API_KEY is available for subprocess commands, enhancing the reliability of tests that require real API interactions.

These changes aim to improve the robustness of API key handling and enhance the testing framework's functionality.
…ling

- Upgraded PraisonAI version from 2.2.17 to 2.2.18 across multiple Dockerfiles and configuration files for improved functionality.
- Enhanced GitHub Actions workflow by exporting additional environment variables related to the OpenAI API, improving integration and debugging capabilities.

These changes aim to ensure better performance and reliability in the workflow and API interactions.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented May 29, 2025

Caution

Review failed

The pull request is closed.

Walkthrough

This update increases the PraisonAI package version from 2.2.17 to 2.2.18 across all Dockerfiles, documentation, and deployment scripts. It also upgrades dependencies in agent-related configuration files and enhances test scripts with environment propagation and real test markers. CI workflow scripts improve API key handling and debugging output.

Changes

File(s) Change Summary
docker/Dockerfile, docker/Dockerfile.chat, docker/Dockerfile.dev, docker/Dockerfile.ui Bump praisonai package version from 2.2.17 to 2.2.18.
docs/api/praisonai/deploy.html, src/praisonai/praisonai/deploy.py Update Dockerfile creation logic to install praisonai 2.2.18.
docs/developers/local-development.mdx, docs/ui/chat.mdx, docs/ui/code.mdx Update documentation to reference praisonai 2.2.18 in Dockerfile install commands.
src/praisonai-agents/pyproject.toml Bump project version to 0.0.91; update chromadb and markitdown[all] dependency versions.
src/praisonai/pyproject.toml Bump PraisonAI version to 2.2.18; update praisonaiagents dependency to >=0.0.91.
src/praisonai/praisonai.rb Update formula to use Praisonai 2.2.18 and new SHA-256 hash.
src/praisonai/tests/test.py Add @pytest.mark.real to tests; improve env var passing and command quoting in CLI tests.
.github/workflows/test-core.yml Enhance API key handling in CI: safer display, robust retrieval, improved debug output.

Sequence Diagram(s)

sequenceDiagram
    participant CI as GitHub Actions Workflow
    participant Script as Inline Python Script
    participant Env as Environment Variables
    participant PraisonAI as PraisonAIModel

    CI->>Script: Run debug script
    Script->>Env: Retrieve OPENAI_API_KEY
    Script->>Script: Use get_key_display_value to display key safely
    Script->>PraisonAI: Create LLM instance with API key
    PraisonAI-->>Script: Return instance or raise exception
    Script->>Script: Display LLM instance API key (truncated)
    Script-->>CI: Print debug output
Loading

Possibly related PRs

  • MervinPraison/PraisonAI#532: Refactors the same test file to remove conditional skipping and simplify test execution; both PRs modify src/praisonai/tests/test.py but focus on different aspects.
  • MervinPraison/PraisonAI#508: Adds a debug step for API key presence in CI workflows; both PRs enhance CI workflow API key debugging, though with different approaches.

Poem

Hop, hop, a version hops anew,
From seventeen to eighteen, we bid adieu!
Dockerfiles and docs, all in line,
Agents and tests, now work just fine.
API keys are safe and sound,
In every script and workflow found.
🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4e04bbe and 51d27cc.

⛔ Files ignored due to path filters (2)
  • src/praisonai-agents/uv.lock is excluded by !**/*.lock
  • src/praisonai/uv.lock is excluded by !**/*.lock
📒 Files selected for processing (14)
  • .github/workflows/test-core.yml (2 hunks)
  • docker/Dockerfile (1 hunks)
  • docker/Dockerfile.chat (1 hunks)
  • docker/Dockerfile.dev (1 hunks)
  • docker/Dockerfile.ui (1 hunks)
  • docs/api/praisonai/deploy.html (1 hunks)
  • docs/developers/local-development.mdx (1 hunks)
  • docs/ui/chat.mdx (1 hunks)
  • docs/ui/code.mdx (1 hunks)
  • src/praisonai-agents/pyproject.toml (2 hunks)
  • src/praisonai/praisonai.rb (1 hunks)
  • src/praisonai/praisonai/deploy.py (1 hunks)
  • src/praisonai/pyproject.toml (4 hunks)
  • src/praisonai/tests/test.py (4 hunks)
✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@MervinPraison MervinPraison merged commit f2ada5f into main May 29, 2025
7 of 11 checks passed
@netlify
Copy link
Copy Markdown

netlify bot commented May 29, 2025

Deploy Preview for praisonai ready!

Name Link
🔨 Latest commit 51d27cc
🔍 Latest deploy log https://app.netlify.com/projects/praisonai/deploys/6837d9faac6b5500085fd1b8
😎 Deploy Preview https://deploy-preview-534--praisonai.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @MervinPraison, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

Summary of Changes

As gemini-code-assist, I've reviewed this pull request titled "2.2.18". Based on the changes, this PR appears to be a version bump release, updating the project to version 2.2.18. The core changes involve updating version numbers across various configuration and documentation files, as well as performing significant dependency updates, particularly reflected in the lock files.

Highlights

  • Version Bump: The main PraisonAI package version has been updated from 2.2.17 to 2.2.18.
  • Agent Package Version: The praisonaiagents package version has been updated from 0.0.90 to 0.0.91.
  • Dependency Updates: Several dependencies have been updated, including a major version bump for chromadb (from 0.5.23 to 1.0.11) and markitdown (from 0.0.1a3 to 0.1.2). New dependencies like azure-ai-documentintelligence, azure-identity, isodate, magika, msal, msal-extensions, olefile, pyjwt, xlrd, and youtube-transcript-api (with a version bump) have been added, while chroma-hnswlib, pathvalidate, and puremagic have been removed.
  • Configuration and Documentation Alignment: Dockerfiles, documentation code snippets, and the Homebrew formula have been updated to reference the new PraisonAI version (2.2.18) and align with the updated dependencies.
  • Test File Adjustments: Test files have been slightly modified to import pytest, add @pytest.mark.real markers to several tests (indicating they might require a real environment or API key), and quote command arguments in CLI tests.

Changelog

Click here to see the changelog
  • docker/Dockerfile
    • Updated praisonai dependency version to 2.2.18.
  • docker/Dockerfile.chat
    • Updated praisonai dependency version to 2.2.18.
  • docker/Dockerfile.dev
    • Updated praisonai dependency version to 2.2.18.
  • docker/Dockerfile.ui
    • Updated praisonai dependency version to 2.2.18.
  • docs/api/praisonai/deploy.html
    • Updated praisonai version in the Dockerfile code snippet within the documentation to 2.2.18.
  • docs/developers/local-development.mdx
    • Updated praisonai version in the Dockerfile code snippet within the documentation to 2.2.18.
  • docs/ui/chat.mdx
    • Updated praisonai version in the Dockerfile code snippet within the documentation to 2.2.18.
  • docs/ui/code.mdx
    • Updated praisonai version in the Dockerfile code snippet within the documentation to 2.2.18.
  • src/praisonai-agents/pyproject.toml
    • Updated praisonaiagents package version to 0.0.91.
    • Updated chromadb dependency constraint for memory and knowledge extras to >=1.0.0.
    • Updated markitdown[all] dependency constraint for knowledge extra to >=0.1.0.
  • src/praisonai-agents/uv.lock
    • Updated locked version of chromadb to 1.0.11.
    • Updated locked version of fastapi to 0.115.9.
    • Updated locked version of exceptiongroup dependency marker.
    • Updated locked version of markitdown to 0.1.2 and adjusted its dependencies.
    • Updated locked version of youtube-transcript-api to 1.0.3.
    • Added locked dependencies for azure-ai-documentintelligence, azure-core, azure-identity, isodate, magika, msal, msal-extensions, olefile, pyjwt, and xlrd.
    • Removed locked dependencies for chroma-hnswlib, pathvalidate, and puremagic.
  • src/praisonai/praisonai.rb
    • Updated Homebrew formula URL and SHA256 hash to reference the v2.2.18 tag.
  • src/praisonai/praisonai/deploy.py
    • Updated the hardcoded praisonai version string used in the generated Dockerfile to 2.2.18.
  • src/praisonai/pyproject.toml
    • Updated PraisonAI package version to 2.2.18.
    • Updated praisonaiagents dependency constraint to >=0.0.91.
    • Updated markitdown dependency for all, knowledge extras to include [all] and constraint >=0.1.0.
  • src/praisonai/tests/test.py
    • Imported pytest.
    • Added @pytest.mark.real decorator to several test methods (test_main_with_agents_advanced, test_main_with_autogen_framework, test_main_with_custom_framework, test_main_with_internet_search_tool, test_main_with_built_in_tool, test_auto_example).
    • Updated CLI command strings to wrap the prompt in double quotes.
  • src/praisonai/uv.lock
    • Updated locked version of praisonai to 2.2.18.
    • Updated locked version of praisonaiagents to 0.0.91.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in issue comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.


Version bumps arrive,
Dependencies take a dive,
Lock file reflects change.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Copy Markdown
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request primarily handles the version bump to 2.2.18 for PraisonAI and praisonaiagents, along with updating various dependencies. The consistency across Dockerfiles, documentation, and configuration files is good. The improvements in src/praisonai/tests/test.py, such as adding pytest.mark.real for test categorization and enhancing CLI test robustness (quoting arguments, environment variable handling), are positive contributions.

However, there are a couple of points regarding dependency management and packaging practices that would be good to address.

Summary of Findings

  • Major Dependency Update (chromadb): The chromadb dependency was upgraded from v0.5.x to v1.0.x. This major version change requires careful testing to ensure no breaking changes affect praisonaiagents.
  • Homebrew Formula SHA256 Calculation: The Homebrew formula (praisonai.rb) uses a dynamic SHA256 calculation for the release tarball. For security and integrity, a static, pre-calculated SHA256 hash is recommended for tagged releases.
  • Test Enhancements: Improvements in test.py (using pytest.mark.real, better CLI argument handling) are positive and enhance test suite robustness. This was not commented on directly as it's a positive change.
  • Dependency Version Consistency: Version numbers for praisonai and its sub-packages/dependencies have been consistently updated across various configuration files and documentation. This was not commented on directly as it's a positive aspect of the PR.

Merge Readiness

This pull request makes necessary version updates and includes some good test enhancements. However, before merging, I recommend addressing the points raised regarding the chromadb major version update (ensuring thorough testing and compatibility) and the dynamic SHA256 calculation in the Homebrew formula. Addressing these will improve the stability and security of the release. As a reviewer, I am not authorized to approve pull requests; please ensure these changes are reviewed and approved by other maintainers before merging.


memory = [
"chromadb>=0.5.23"
"chromadb>=1.0.0"
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The chromadb dependency has been updated from version 0.5.x to >=1.0.0 (locked to 1.0.11 in uv.lock). This is a major version upgrade, which can often introduce breaking changes or require migration steps.

Could you clarify if the implications of this major version bump have been thoroughly tested within praisonaiagents? Highlighting any specific testing performed or referencing upstream migration guides for chromadb 1.0 would be beneficial to ensure compatibility and prevent potential regressions.

url "https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.2.17.tar.gz"
sha256 `curl -sL https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.2.17.tar.gz | shasum -a 256`.split.first
url "https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.2.18.tar.gz"
sha256 `curl -sL https://github.com/MervinPraison/PraisonAI/archive/refs/tags/v2.2.18.tar.gz | shasum -a 256`.split.first
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The SHA256 hash for the release tarball is currently calculated dynamically at runtime using curl and shasum. For Homebrew formulas, especially those tracking tagged releases, it's a crucial best practice for security and integrity to use a static, pre-calculated SHA256 hash. This ensures that Homebrew users always install the exact, verified version of the software corresponding to the tag.

Using a dynamic hash could lead to issues if the tag were ever re-pointed or the tarball content changed unexpectedly. Could this be updated to a static hash for version 2.2.18?

To get the static hash, you can download the tarball and run shasum -a 256 v2.2.18.tar.gz locally.

    sha256 "YOUR_PRECALCULATED_SHA256_FOR_V2.2.18_HERE" # Replace with the actual hash

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant