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

Add setuptools dependency #179

Merged
merged 1 commit into from
Oct 8, 2024
Merged

Add setuptools dependency #179

merged 1 commit into from
Oct 8, 2024

Conversation

levitsky
Copy link
Contributor

@levitsky levitsky commented Oct 8, 2024

User description

Fixes #175.


PR Type

dependencies


Description

  • Added setuptools to the install_requires list in setup.py to ensure it is included as a dependency.

Changes walkthrough 📝

Relevant files
Dependencies
setup.py
Add setuptools to install_requires dependencies                   

setup.py

  • Added setuptools to the list of install_requires dependencies.
+1/-0     

💡 PR-Agent usage: Comment /help "your question" on any pull request to receive relevant information

Summary by CodeRabbit

  • New Features
    • The package now explicitly requires setuptools for installation, ensuring smoother setup for users.

Copy link

coderabbitai bot commented Oct 8, 2024

Walkthrough

The changes involve an update to the setup.py file for the sdrf-pipelines package, specifically adding "setuptools" to the install_requires list. This adjustment ensures that setuptools is explicitly required as a dependency for installation, addressing issues related to its absence in Python 3.12 environments.

Changes

File Change Summary
setup.py Added "setuptools" to the install_requires list

Assessment against linked issues

Objective Addressed Explanation
Add setuptools to dependencies to resolve ImportError (#175)

🐰 "In the garden, I hop with glee,
setuptools now there, as it should be!
No more errors, just joy in the air,
With each little change, we show that we care!" 🥕


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.
    • Generate unit testing code for this file.
    • 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 generate unit testing code for this file.
    • @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 generate unit testing code.
    • @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.

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 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.

Copy link

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Reviewer Guide 🔍

Here are some key observations to aid the review process:

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review

Dependency Order
The newly added 'setuptools' dependency is placed at the end of the list. Consider alphabetizing the list for better readability and maintenance.

Copy link

PR-Agent was enabled for this repository. To continue using it, please link your git user with your CodiumAI identity here.

PR Code Suggestions ✨

Explore these optional code suggestions:

CategorySuggestion                                                                                                                                    Score
Best practice
Specify a minimum version for the added dependency to ensure compatibility

Consider specifying a minimum version for the 'setuptools' dependency to ensure
compatibility and avoid potential issues with older versions.

setup.py [52]

-"setuptools"
+"setuptools>=45.0.0"
  • Apply this suggestion
Suggestion importance[1-10]: 8

Why: Specifying a minimum version for the 'setuptools' dependency is a good practice to ensure compatibility and prevent issues with older versions. This suggestion is relevant and enhances the robustness of the dependency management in the project.

8

💡 Need additional feedback ? start a PR chat

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
setup.py (1)

52-52: LGTM! This change addresses the ImportError issue.

The addition of "setuptools" to the install_requires list effectively resolves the ImportError for pkg_resources in Python 3.12 environments, as described in issue #175. This change ensures that the necessary dependencies are available across different Python versions, including 3.12 and potentially future versions.

Consider adding a comment explaining why setuptools is explicitly required, to provide context for future maintainers:

 install_requires=[
     "click",
     "pandas",
     "pandas_schema",
     "requests",
     "pytest",
     "pyyaml",
     "defusedxml",
     "pyarrow",
     "duckdb",
     "rdflib",
+    # Explicitly required for pkg_resources, especially in Python 3.12+
     "setuptools"
 ],
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 24151ed and d101b84.

📒 Files selected for processing (1)
  • setup.py (1 hunks)
🧰 Additional context used

@ypriverol ypriverol merged commit 39c4dcd into bigbio:main Oct 8, 2024
9 of 11 checks passed
Copy link

github-actions bot commented Oct 8, 2024

Python linting (black) is failing

To keep the code consistent with lots of contributors, we run automated code consistency checks.
To fix this CI test, please run:

  • Install black: pip install black
  • Fix formatting errors in your pipeline: black .
    Once you push these changes the test should pass, and you can hide this comment 👍
    We highly recommend setting up Black in your code editor so that this formatting is done automatically on save. Ask about it on Slack for help!
    Thanks again for your contribution!

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

Successfully merging this pull request may close these issues.

ImprtError on Python 3.12 due to missing pkg_resouces
2 participants