Switch to pyproject.toml

[mvdwetering]

Summary by CodeRabbit

• New Features

  • Introduced a pyproject.toml file for improved build management and project definition.
  • Streamlined dependency installation processes to enhance package setup.

• Bug Fixes

  • Minor adjustments made to URL string formatting for clarity and simplicity in various methods.

• Chores

  • Removed unused imports to enhance code readability and maintainability across several files.

[coderabbitai]

Walkthrough

The recent changes streamline the dependency management and packaging processes for the Python package aiohuesyncbox. The updates include enhanced type annotations for better clarity, removal of unused imports, and an introduction of a pyproject.toml file that defines project metadata and dependencies. These modifications reflect a shift towards modern Python packaging practices, improving both maintainability and efficiency.

Changes

File	Change Summary
.github/workflows/python-package.yml	Simplified dependency installation by removing pytest and using pip install .[test] for the current package's testing dependencies.
.github/workflows/python-publish.yml	Transitioned from setuptools and wheel to using the build package, simplifying the package build process with python -m build.
aiohuesyncbox/device.py	Updated type annotation for _wifi to explicitly allow None. Simplified URL string in set_led_mode method.
aiohuesyncbox/hdmi.py	Removed unused List import from typing, indicating a simplification in data structures.
aiohuesyncbox/hue.py	Removed Optional from imports and simplified URL string formatting in set_bridge function.
aiohuesyncbox/huesyncbox.py	Cleaned up imports by removing ipaddress and socket, enhancing code readability.
pyproject.toml	Introduced a configuration file defining build system, project metadata, and dependencies, ensuring modern package management practices.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PackageManager
    participant BuildSystem
    participant Repository

    User->>PackageManager: Initiate package installation
    PackageManager->>BuildSystem: Requests build package
    BuildSystem->>PackageManager: Returns built package
    PackageManager->>User: Package installed successfully

Loading

🐰 In a world where code does hop,
Changes bring joy, no need to stop!
Dependencies light, like soft bunny fur,
With each little tweak, we happily stir.
A pyproject.toml to guide our way,
Let's code and play, hip-hip-hooray! ✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 298f42c and 980635c.

Files selected for processing (7)

• .github/workflows/python-package.yml (1 hunks)
• .github/workflows/python-publish.yml (1 hunks)
• aiohuesyncbox/device.py (2 hunks)
• aiohuesyncbox/hdmi.py (1 hunks)
• aiohuesyncbox/hue.py (2 hunks)
• aiohuesyncbox/huesyncbox.py (1 hunks)
• pyproject.toml (1 hunks)

Files skipped from review due to trivial changes (4)

• aiohuesyncbox/hdmi.py
• aiohuesyncbox/hue.py
• aiohuesyncbox/huesyncbox.py
• pyproject.toml

Additional comments not posted (5)

.github/workflows/python-publish.yml (2)

24-24: Approve the installation of the build package.

The change to install the build package is a good practice and aligns with modern Python packaging standards.

---

30-30: Approve the update to the build command.

Updating the build command to use python -m build is a modern and standardized approach.

.github/workflows/python-package.yml (1)

30-30: Approve the update to the dependency installation command.

The change to use pip install . .[test] simplifies the dependency management process and aligns with using the package's own testing setup.

aiohuesyncbox/device.py (2)

29-29: Approve the type annotation for _wifi.

The type annotation improves type safety and clarity regarding the expected state of the _wifi attribute.

---

91-91: Approve the simplified string formatting.

The change to use a direct string for the URL simplifies the code and reduces unnecessary complexity.