Skip to content

Conversation

@cdce8p
Copy link
Contributor

@cdce8p cdce8p commented Apr 11, 2025

  • Remove wheel from build dependencies. Setuptools started vendoring / using it's own version a while ago, so this isn't needed anymore.
  • Remove platforms = ["any"]. It's basically unused / redundant at this point. The metadata also includes a better classifier with Operating System :: OS Independent.
  • Remove setup.cfg + setup.py. Editable installs with only pyproject.toml configs have been supported for some time now.
  • Remove metadata.url. The url is already present as project.urls."Source code".

Summary by CodeRabbit

  • Chores
    • Streamlined build and packaging configuration by removing redundant dependencies and legacy settings.
    • Updated dependency reference markers to reflect current project standards.
    • Removed outdated configuration metadata and installation routines to enhance maintainability.

@cdce8p cdce8p requested a review from a team as a code owner April 11, 2025 00:08
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Apr 11, 2025

Walkthrough

The pull request modifies several configuration files to streamline project packaging and dependency management. In pyproject.toml, the wheel dependency and the platforms field have been removed, simplifying the build requirements. Both requirements_commit.txt and requirements_test.txt now refer to project.dependencies in their comments instead of setup.py. Additionally, setup.cfg has been cleaned up by eliminating metadata and commentary related to setuptools limitations, and the setup.py file has been entirely removed.

Changes

File(s) Change Summary
pyproject.toml Removed wheel from the [build-system] requires field and eliminated the platforms field under [tool.setuptools].
requirements_commit.txt, requirements_test.txt Updated the comment from # Import from setup.py to # Import from project.dependencies (no change in functionality).
setup.cfg Removed metadata (including URL) and several comments regarding setuptools limitations and temporary configuration.
setup.py Entire file removed, which affects the module’s packaging and installation configuration.

Poem

Hoppin' through the code with glee,
Config changes dance so merrily.
Wheels have rolled away, bids adieu,
Comments now sing a fresher tune.
I, a joyful bunny, celebrate the change soon!
🐇✨


📜 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 cea888f and d9920c5.

📒 Files selected for processing (5)
  • pyproject.toml (1 hunks)
  • requirements_commit.txt (1 hunks)
  • requirements_test.txt (1 hunks)
  • setup.cfg (0 hunks)
  • setup.py (0 hunks)
💤 Files with no reviewable changes (2)
  • setup.py
  • setup.cfg
🔇 Additional comments (4)
requirements_commit.txt (1)

1-1: Consistent Dependency Source Comment
The header comment has been updated from “# Import from setup.py” to “# Import from project.dependencies.” This enhances clarity and aligns with the overall packaging changes.

pyproject.toml (2)

1-4: Simplified Build System Dependencies
The [build-system] section now requires only setuptools (using setuptools~=78.1), thereby eliminating the unnecessary wheel dependency. This aligns with the objective of leveraging Setuptools’ built-in capabilities.


40-42: Removal of Platforms Field
The removal of the platforms field from the [tool.setuptools] section is appropriate since the project classifiers already specify “Operating System :: OS Independent.” This change reduces redundancy in the metadata.

requirements_test.txt (1)

1-1: Updated Dependency Import Source Comment
The header comment now correctly reflects “# Import from project.dependencies,” which is consistent with the changes made in requirements_commit.txt and the overall packaging refactor.


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.
    • 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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 or @coderabbitai title 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.

@sonarqubecloud
Copy link

Copy link
Contributor

@bouwew bouwew left a comment

Choose a reason for hiding this comment

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

LGTM!

@CoMPaTech
Copy link
Member

Tnx @cdce8p

@bouwew bouwew merged commit 706c493 into plugwise:main Apr 11, 2025
4 checks passed
@cdce8p cdce8p deleted the cleanup-packaging branch April 11, 2025 16:58
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.

3 participants