Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(license): pypi license not displayed for the ee extensions #1634

Merged
merged 3 commits into from
Feb 24, 2025

Conversation

ArslanSaleem
Copy link
Collaborator

@ArslanSaleem ArslanSaleem commented Feb 24, 2025

Important

Added license information and updated version numbers for multiple extensions, along with adding documentation and repository URLs in pyproject.toml.

  • License Information:
    • Added license details to README.md for bigquery, databricks, oracle, snowflake, chromadb, lancedb, milvus, pinecone, qdrant extensions.
    • Updated pyproject.toml to include license field and license-files for the same extensions.
  • Version Updates:
    • Incremented version numbers in pyproject.toml for bigquery, databricks, oracle, snowflake, chromadb, lancedb, milvus, pinecone, qdrant, bedrock, google, huggingface, ibm, langchain, local, openai, docker extensions.
  • URLs Addition:
    • Added Documentation and Repository URLs in pyproject.toml for all mentioned extensions.

This description was created by Ellipsis for 327bcce. It will automatically update as commits are pushed.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Reviewed everything up to f3831e6 in 2 minutes and 20 seconds

More details
  • Looked at 560 lines of code in 27 files
  • Skipped 0 files when reviewing.
  • Skipped posting 31 drafted comments based on config settings.
1. extensions/ee/connectors/bigquery/pyproject.toml:7
  • Draft comment:
    License field set to 'Proprietary' is now added. Confirm that the LICENSE file exists and that the legal details are correct.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    The comment is asking the PR author to confirm the existence and correctness of the LICENSE file, which violates the rule against asking for confirmation or verification. It does not provide a specific code suggestion or point out a specific issue with the code itself.
2. extensions/ee/connectors/bigquery/README.md:13
  • Draft comment:
    License section is added in the README. Consider adding a link or reference to the full license text if available.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 20% vs. threshold = 50%
    The comment suggests a nice-to-have improvement but doesn't point out a critical issue. For enterprise licenses, the full text is often not publicly available, and the current text already provides the essential information and a contact point. The comment is more of a suggestion than pointing out a clear problem that needs fixing.
    The suggestion could improve documentation completeness. Not having a license link could make it harder for users to understand the full terms before contacting.
    For enterprise licenses, directing users to contact the company is often the intended approach rather than publishing the full license text. The current content achieves its primary purpose.
    The comment should be removed as it's a non-critical suggestion that may not even be applicable for an enterprise license, and the current text adequately serves its purpose.
3. extensions/ee/connectors/databricks/pyproject.toml:7
  • Draft comment:
    License field set to 'Proprietary' appears correctly with updated version (0.1.4). Ensure consistency with the LICENSE file.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is asking the author to ensure consistency between the license field and the LICENSE file. It is not a direct code suggestion or a request for a specific change, which violates the rule against asking the author to ensure or verify things. Therefore, this comment should not be approved.
4. extensions/ee/connectors/oracle/pyproject.toml:7
  • Draft comment:
    Oracle connector now uses 'Proprietary' license and version is bumped to 0.1.4. Verify that the dependency details and test group remain valid.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is about a dependency change, specifically mentioning a license change and a version bump. It asks the PR author to verify the dependency details and test group, which violates the rule against asking for verification or confirmation. Additionally, it doesn't provide a specific suggestion or point out a specific issue with the code.
5. extensions/ee/connectors/snowflake/pyproject.toml:1
  • Draft comment:
    Snowflake connector version updated to 0.1.5 with license 'Proprietary'. Confirm that dependency versions meet your requirements.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is about a dependency change, specifically the version update of the Snowflake connector. The comment asks the PR author to confirm that the dependency versions meet their requirements, which violates the rule against asking for confirmation on dependency changes. Therefore, this comment should be removed.
6. extensions/ee/vectorstores/chromadb/pyproject.toml:1
  • Draft comment:
    ChromaDB extension updated to version 0.1.4 with license 'Proprietary'. The added URLs improve discoverability; ensure the onnxruntime range is intended.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 0% vs. threshold = 50%
    The comment has multiple parts: 1) Noting version/license changes (which is just stating facts, not suggesting changes) 2) Questioning onnxruntime range (which wasn't changed in this PR). According to rules, we shouldn't make purely informative comments or question things that weren't changed.
    The onnxruntime version range could be problematic even if unchanged, and version bumps sometimes warrant dependency reviews.
    Per the rules, we should only comment on changed code, and dependency questions should be ignored. The comment is both informational and questioning unchanged dependencies.
    The comment should be deleted as it's purely informational about the changes and questions an unchanged dependency, both of which violate the review rules.
7. extensions/ee/vectorstores/lancedb/pyproject.toml:1
  • Draft comment:
    LanceDB extension now shows updated version 0.1.4 and proprietary license. Verify that all dependencies are compatible with the new version.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is asking the PR author to verify compatibility of dependencies with the new version, which violates the rule against asking for confirmation or verification of intentions. It also relates to dependency changes, which should not be commented on unless there's a specific issue identified.
8. extensions/ee/vectorstores/milvus/pyproject.toml:1
  • Draft comment:
    Milvus extension updated to version 0.1.4 with added license 'Proprietary'. Check that extra dependencies (e.g., 'model') are necessary and correctly documented.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    The comment is related to a dependency change, specifically the Milvus extension update. It asks to check if extra dependencies are necessary and documented, which is not allowed by the rules. The comment does not provide a specific code suggestion or point out a specific issue with the code.
9. extensions/ee/vectorstores/pinecone/pyproject.toml:1
  • Draft comment:
    Pinecone extension now updated to version 0.1.4 and license 'Proprietary'. Confirm that dependency versions, especially for 'pinecone-client', align with your integration requirements.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    The comment is asking the PR author to confirm dependency versions, which violates the rule against commenting on dependency changes or asking for confirmation. It doesn't provide a specific suggestion or point out a specific issue with the code.
10. extensions/ee/vectorstores/qdrant/pyproject.toml:1
  • Draft comment:
    Qdrant extension updated to version 0.1.4 with 'Proprietary' license. Dependency versions look standard; ensure that the specified python range (>=3.9,<3.12) is appropriate.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is about a dependency change and asks the author to ensure the Python version range is appropriate. It violates the rule against commenting on dependency changes and asking the author to ensure something is appropriate.
11. extensions/llms/bedrock/pyproject.toml:1
  • Draft comment:
    AWS Bedrock integration bumped to version 0.1.5, retaining MIT license. License and URL metadata are clear; ensure integration tests pass with updated dependencies.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and discusses dependency changes, which are not to be commented on. It also asks to ensure tests pass, which is against the rules.
12. extensions/llms/google/pyproject.toml:1
  • Draft comment:
    Google integration now at version 0.1.5 with MIT license. Metadata changes are consistent; no issues detected.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It violates the rule against making purely informative comments.
13. extensions/llms/huggingface/pyproject.toml:1
  • Draft comment:
    Hugging Face integration updated to version 0.1.5 with MIT license and complete URL metadata. Confirm dependencies (like 'text-generation') are up-to-date.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and asks the PR author to confirm dependencies, which violates the rules. It does not provide a specific code suggestion or point out a specific issue with the code.
14. extensions/llms/ibm/pyproject.toml:1
  • Draft comment:
    IBM integration bumped to version 0.1.5 with MIT license. Ensure that the dependency 'ibm-watsonx-ai' is current and fully compatible.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is about a dependency change and asks the author to ensure compatibility, which violates the rules. It doesn't provide a specific suggestion or point out a specific issue.
15. extensions/llms/langchain/pyproject.toml:1
  • Draft comment:
    Langchain integration updated to version 0.1.5 with MIT license. The dependency set (including community packages) is clear; verify version constraints meet future updates.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and asks the PR author to verify version constraints, which violates the rules. It does not provide any actionable feedback or suggestions for improvement.
16. extensions/llms/local/pyproject.toml:1
  • Draft comment:
    Local LLM integration is version bumped to 0.1.5 with MIT license. Dependencies including transformers, torch, and openai are specified; ensure compatibility.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and does not provide any actionable feedback or suggestions. It mentions a version bump and lists dependencies, but it does not suggest any specific action or improvement. It also asks to ensure compatibility, which is against the rules.
17. extensions/llms/openai/pyproject.toml:1
  • Draft comment:
    OpenAI integration updated to version 0.1.5 with MIT license. All metadata fields are consistent; no concerns detected.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and does not provide any actionable feedback or suggestions for improvement. It simply states that the OpenAI integration was updated and that there are no concerns, which violates the rule against making purely informative comments.
18. extensions/sandbox/docker/pyproject.toml:1
  • Draft comment:
    Docker extension updated to version 0.1.3 with MIT license. The URLs point to privacy-security documentation. Check that the empty description is acceptable or update if needed.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is purely informative and asks the PR author to check if the empty description is acceptable, which violates the rules. It does not provide any specific code suggestions or highlight any issues that need addressing.
19. pyproject.toml:1
  • Draft comment:
    Root pyproject.toml now includes URLs and setuptools license-files. Verify that all project metadata is correctly displayed on PyPI.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
20. extensions/ee/connectors/bigquery/README.md:13
  • Draft comment:
    EE Connectors: License section added consistently across connectors (e.g., BigQuery, Databricks, Oracle, Snowflake). Consider adding a direct link to the LICENSE file in the README for clarity.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
21. extensions/ee/vectorstores/chromadb/README.md:13
  • Draft comment:
    Vectorstores: License details are now included across all vectorstore extensions (ChromaDB, LanceDB, Milvus, Pinecone, Qdrant). Consider linking to the LICENSE file directly in the README to improve discoverability.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
22. extensions/llms/bedrock/pyproject.toml:6
  • Draft comment:
    LLM Extensions: Version bumps and URL additions are consistent and the MIT license is preserved. No issues found.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
23. extensions/sandbox/docker/pyproject.toml:4
  • Draft comment:
    Sandbox Docker: The description field is currently empty. It’s recommended to add a meaningful description for clarity.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is asking the PR author to update the PR description, which is against the rules. The comment does not provide any specific code suggestions or identify any issues with the code itself.
24. pyproject.toml:10
  • Draft comment:
    Root pyproject.toml: URLs and setuptools license-files have been added, ensuring consistency with submodules. This enhances metadata visibility on PyPI.
  • Reason this comment was not posted:
    Confidence changes required: 0% <= threshold 50%
    None
25. extensions/ee/connectors/bigquery/pyproject.toml:4
  • Draft comment:
    There's an inconsistent branding: the package is called 'pandasai-bigquery' (all lowercase) but the description on line 4 uses 'PandaAI'. Consider standardizing the naming (e.g. using 'pandasai' consistently) for clarity.
  • Reason this comment was not posted:
    Comment was on unchanged code.
26. extensions/ee/connectors/databricks/README.md:1
  • Draft comment:
    There appears to be an inconsistency in the naming of the product. The title and the description use 'PandaAI', while the installation command uses 'pandasai-databricks'. Consider aligning the naming throughout the document for clarity.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
27. extensions/ee/connectors/databricks/pyproject.toml:4
  • Draft comment:
    There appears to be an inconsistency in the capitalization of 'PandaAI' in the description (line 4). The package name in other parts (e.g., line 2 and dependency names) is 'pandasai'. Consider standardizing the capitalization for consistency.
  • Reason this comment was not posted:
    Comment was on unchanged code.
28. extensions/ee/vectorstores/lancedb/README.md:1
  • Draft comment:
    Consider verifying the product name's capitalization. If the product is consistently named 'PandasAI' across the repository, update line 1 to 'LanceDB Extension for PandasAI'. This will improve clarity and consistency.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
29. extensions/ee/vectorstores/lancedb/README.md:3
  • Draft comment:
    Ensure that the product name is consistently used across the documentation. If the official name is 'PandasAI', update line 3 accordingly.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
30. extensions/ee/vectorstores/qdrant/README.md:1
  • Draft comment:
    Typographical/lexicographical inconsistency: The header uses 'PandaAI' whereas the package name and usual reference appears as 'pandasai'. Please consider standardizing the naming for consistency.
  • Reason this comment was not posted:
    Comment was not on a location in the diff, so it can't be submitted as a review comment.
31. pyproject.toml:58
  • Draft comment:
    A trailing newline at the end of the file is missing. Adding a newline would improve the file’s readability and conform to common style practices.
  • Reason this comment was not posted:
    Decided after close inspection that this draft comment was likely wrong and/or not actionable: usefulness confidence = 10% vs. threshold = 50%
    While technically correct, this is a very minor style issue. The file is still perfectly readable and functional without the trailing newline. Most modern editors and git will handle this gracefully. This feels like the kind of nitpicky comment that adds noise without providing much value.
    The missing newline could cause issues with some tools or make git diffs slightly messier. It is a widely accepted convention to end files with newlines.
    While true, this is still an extremely minor issue that doesn't affect functionality. If it becomes a problem, automated tools like pre-commit hooks or editors can fix it automatically.
    This comment should be removed as it's too minor of a style issue to warrant manual intervention. It violates the rule about not making obvious or unimportant comments.

Workflow ID: wflow_2Qr8P1f410vhnyQQ


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

Copy link

codecov bot commented Feb 24, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.23%. Comparing base (a4b1afe) to head (327bcce).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1634   +/-   ##
=======================================
  Coverage   89.23%   89.23%           
=======================================
  Files          71       71           
  Lines        2695     2695           
=======================================
  Hits         2405     2405           
  Misses        290      290           
Flag Coverage Δ
unittests 89.23% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@ellipsis-dev ellipsis-dev bot left a comment

Choose a reason for hiding this comment

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

👍 Looks good to me! Incremental review on 327bcce in 34 seconds

More details
  • Looked at 12 lines of code in 1 files
  • Skipped 0 files when reviewing.
  • Skipped posting 5 drafted comments based on config settings.
1. pyproject.toml:3
  • Draft comment:
    Version bumped to beta.13. Ensure release notes and changelog reflect this update.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 0% <= threshold 50%
    This comment is asking the PR author to ensure that release notes and changelog reflect the version update. This falls under the rule of not asking the author to ensure or verify things. Additionally, it relates to dependency changes, which should not be commented on.
2. pyproject.toml:4
  • Draft comment:
    Consider using consistent branding (e.g., 'pandasai' vs 'PandaAI') in the description.
  • Reason this comment was not posted:
    Comment did not seem useful. Confidence is useful = 40% <= threshold 50%
    The comment suggests using consistent branding, which is a valid point for maintaining consistency in code and documentation. However, it doesn't directly relate to the code changes or functionality. It seems more like a suggestion for documentation or naming conventions, which is not strictly necessary for code review unless it impacts the code's functionality or readability.
3. pyproject.toml:7
  • Draft comment:
    Ensure the README.md file referenced exists and is kept updated.
  • Reason this comment was not posted:
    Confidence changes required: 50% <= threshold 50%
    None
4. pyproject.toml:8
  • Draft comment:
    Verify 'packages' inclusion is correct and covers all necessary modules.
  • Reason this comment was not posted:
    Confidence changes required: 50% <= threshold 50%
    None
5. pyproject.toml:3
  • Draft comment:
    Version bumped from beta.12 to beta.13. Ensure that this update is accompanied by corresponding release notes and unit tests that verify the PyPI license display fix for the ee extensions if applicable.
  • Reason this comment was not posted:
    Confidence changes required: 33% <= threshold 50%
    None

Workflow ID: wflow_z7DcA5nwx9ZUoDKR


You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.

@gventuri gventuri merged commit 7c4fb5d into main Feb 24, 2025
15 checks passed
scaliseraoul added a commit to scaliseraoul/pandas-ai that referenced this pull request Feb 25, 2025
… into fix/SIN-327

* 'fix/SIN-327' of /~https://github.com/scaliseraoul/pandas-ai:
  fix(cache): removes cache (sinaptik-ai#1635)
  fix(license): pypi license not displayed for the ee extensions (sinaptik-ai#1634)
  Release v3.0.0-beta.12
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.

2 participants