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] Include requirements.txt and requirements-dev.txt in build for PiWheel #50

Merged
merged 1 commit into from
Aug 25, 2024

Conversation

nwithan8
Copy link
Owner

@nwithan8 nwithan8 commented Aug 25, 2024

Looking at the logs for PiWheel, which stopped uploading the tautulli package after v3.4.0, it seems that it can't find a "requirements.txt" file to read from for setup: https://www.piwheels.org/project/tautulli/

This does coincide with changes that were made between 3.4.0 and 3.4.1 regarding the setup process; namely, moving dependency listing to requirements.txt files. These files, however, weren't included in the final egg and therefore could not be found and read for the purposes of a wheel.

Thankfully, we've previously included files like API_VERSIONS, so this should be a simple fix now that we know how to do it.

Summary by CodeRabbit

  • New Features
    • Added requirements.txt and requirements-dev.txt to improve dependency management for production and development environments, ensuring users have all necessary libraries upon installation.

@nwithan8 nwithan8 merged commit de0039c into master Aug 25, 2024
1 check passed
Copy link

coderabbitai bot commented Aug 25, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

Walkthrough

The changes involve updating the MANIFEST.in file to include two new entries: requirements.txt and requirements-dev.txt. These entries indicate that the specified dependency files will be included in the package distribution, ensuring that necessary libraries are available for both production and development environments.

Changes

Files Change Summary
MANIFEST.in Added include requirements.txt and include requirements-dev.txt

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant PackageManager
    participant DependencyFiles

    User->>PackageManager: Request package installation
    PackageManager->>DependencyFiles: Check for requirements
    DependencyFiles-->>PackageManager: Provide dependencies
    PackageManager-->>User: Install package with dependencies
Loading

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

@nwithan8 nwithan8 deleted the wheel branch August 25, 2024 08:26
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