Skip to content

chore: separate dev dependencies from prod dependencies for pip#57

Closed
AlexButeau wants to merge 2 commits intomainfrom
alex/sdk-21-separate-dev-dependencies
Closed

chore: separate dev dependencies from prod dependencies for pip#57
AlexButeau wants to merge 2 commits intomainfrom
alex/sdk-21-separate-dev-dependencies

Conversation

@AlexButeau
Copy link
Copy Markdown
Contributor

@AlexButeau AlexButeau commented Mar 10, 2025

Summary by CodeRabbit

  • Documentation
    • Updated instructions for setting up the development environment to clearly distinguish between production and development dependencies.
  • Chores
    • Introduced a dedicated setup for development tools, enhancing support for testing and code formatting.
    • Refined the project’s dependency management to streamline the development workflow.
    • Simplified imports in the module for improved clarity.

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Mar 10, 2025

Walkthrough

The pull request updates the development dependency setup. The installation command in the documentation has been changed to point to a dedicated development requirements file. A new file for development dependencies has been added, which builds on production dependencies and includes additional tools for testing and code formatting. The project’s setup configuration has been adjusted to remove testing packages from the core installation and to offer them as an optional extras group.

Changes

File(s) Change Summary
CONTRIBUTING.md Updated the dependency installation command from pip install -r requirements.txt to pip install -r requirements_dev.txt for the local development setup.
requirements_dev.txt, setup.py Introduced development-specific dependencies. Created requirements_dev.txt (referencing production dependencies and adding pytest and black), and updated setup.py by removing pytest from install_requires and adding an extras_require entry for dev dependencies.
tofupilot/init.py Removed import statements for numeric_step, string_step, and conf from the .plugin module, simplifying the imports in the tofupilot/__init__.py file.

Poem

Hop, hop, I twitch my nose in cheer,
A new dev path now is clear.
Commands refined and tools in play,
With pytest and black to brighten the day.
Code hops along in a dance so dear!


📜 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 26c6eb8 and 5e72799.

📒 Files selected for processing (2)
  • setup.py (1 hunks)
  • tofupilot/__init__.py (0 hunks)
💤 Files with no reviewable changes (1)
  • tofupilot/init.py
🚧 Files skipped from review as they are similar to previous changes (1)
  • setup.py
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: test (windows-latest)
  • GitHub Check: test (ubuntu-latest)

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

2. Install dependencies
```bash
pip install -r requirements.txt
pip install -r requirements_dev.txt
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

I haven't used pip install -e .'[dev]' in test-current-version.yml because from what I understand, pytest is not necessary in those tests and I wanted to stay as close as possible to "real" conditions, where the client installs tofupilot without the dev dependencies.
However it only works because we wanted to disable the pytest plugin for now. If we want to include it again, we'll have to change the dependencies VS dev dependencies.

@AlexButeau
Copy link
Copy Markdown
Contributor Author

Also linked to issue #55 SDK-55

@AlexButeau AlexButeau requested a review from FefBerthier March 10, 2025 11:17
@Sporarum
Copy link
Copy Markdown
Contributor

Sporarum commented Aug 8, 2025

Probably outdated, feel free to reopen if not

@Sporarum Sporarum closed this Aug 8, 2025
@upview upview deleted the alex/sdk-21-separate-dev-dependencies branch August 11, 2025 15:07
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