Update robotpy_extras to components in documentation#3141
Open
jasondaming wants to merge 4 commits intowpilibsuite:mainfrom
Open
Update robotpy_extras to components in documentation#3141jasondaming wants to merge 4 commits intowpilibsuite:mainfrom
jasondaming wants to merge 4 commits intowpilibsuite:mainfrom
Conversation
virtuald
suggested changes
Oct 9, 2025
Member
virtuald
left a comment
virtuald
left a comment
There was a problem hiding this comment.
The big change with robotpy_extras -> components is that components only install/select packages built by mostwpilib (so, only core wpilib packages). Vendor packages must be installed via requires now.
The project requirements are determined by reading pyproject.toml. An
example pyproject.toml is:
[tool.robotpy]
# Version of robotpy this project depends on
robotpy_version = "{robotpy_version}"
# Which optional RobotPy components should be installed?
# -> equivalent to `pip install robotpy[component1, ...]
components = []
# Other pip packages to install, such as vendor packages (each element
# is equivalent to a line in requirements.txt)
requires = []
If no pyproject.toml exists, a default is created using the current robotpy
package version.
| | PhotonVision | Vendor | photonvision | photonlibpy | | ||
| +---------------------+-----------+-------------------+---------------------------+ | ||
| +---------------------+-----------+-------------+---------------------------+ | ||
| | | Origin | components | requires | |
Member
There was a problem hiding this comment.
You can no longer install vendor deps via components.
- components is only for core WPILib packages - Vendor packages must use requires - Removed components column from vendor packages table - Updated documentation text to clarify the distinction
virtuald
reviewed
Oct 10, 2025
| ``robotpy_version`` is the version of the ``robotpy`` PyPI package that this robot code depends on. | ||
|
|
||
| ``robotpy_extras`` defines extra RobotPy components that can be installed, as only the core RobotPy libraries are installed by default. | ||
| ``components`` defines which optional core WPILib packages should be installed (equivalent to ``pip install robotpy[component1, ...]``). Only core WPILib packages built by mostrobotics can be specified here; vendor packages must be listed in ``requires``. |
Member
There was a problem hiding this comment.
Remove "built by mostrobotics", thats an internal detail that users don't need to know. And the name is wrong.
Per review feedback, users don't need to know this internal detail
sciencewhiz
reviewed
Oct 14, 2025
Collaborator
There was a problem hiding this comment.
This shouldn't be commited
| ``robotpy_version`` is the version of the ``robotpy`` PyPI package that this robot code depends on. | ||
|
|
||
| ``robotpy_extras`` defines extra RobotPy components that can be installed, as only the core RobotPy libraries are installed by default. | ||
| ``components`` defines which optional core WPILib packages should be installed (equivalent to ``pip install robotpy[component1, ...]``). Only core WPILib packages can be specified here; vendor packages must be listed in ``requires``. |
Collaborator
There was a problem hiding this comment.
optional core sounds wierd, I think here just optional WPILib packages is ok.
Per review feedback, updated documentation to make it clear that: - 'components' is ONLY for core WPILib packages built by WPILib - ALL vendor packages must be specified in 'requires' Changes: - Added important note emphasizing the distinction - Removed 'components' column from WPILib components table - Updated vendor packages table header to clarify these use 'requires' - Updated pyproject.toml example to show vendor packages in 'requires' only - Removed vendor packages from components list in example 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates all references to
robotpy_extrasto use the newcomponentskey name in pyproject.toml, following the change made in robotpy-installer.Changes
componentsinstead ofrobotpy_extrascomponentsFixes #3119