-
Couldn't load subscription status.
- Fork 285
Update robotpy_extras to components in documentation #3141
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
Open
jasondaming
wants to merge
4
commits into
wpilibsuite:main
Choose a base branch
from
jasondaming:issue-3119-robotpy-extras-to-components
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
a38e874
Update robotpy_extras to components in documentation
jasondaming a68e83a
Address review feedback: clarify components vs requires usage
jasondaming 20414ed
Remove internal implementation detail about mostrobotics
jasondaming d451c6c
Clarify that components is only for core WPILib packages
jasondaming File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| - never work on an issue that already has a PR fixing it |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,31 +16,34 @@ The ``pyproject.toml`` file looks something like this: | |
| [tool.robotpy] | ||
| # Version of robotpy this project depends on | ||
| robotpy_version = "2024.2.1.0" | ||
| # Which extra RobotPy components should be installed | ||
| # Which core WPILib components should be installed | ||
| # -> equivalent to `pip install robotpy[extra1, ...] | ||
| robotpy_extras = [ | ||
| components = [ | ||
| # "all" | ||
| # "apriltag" | ||
| # "commands2" | ||
| # "cscore" | ||
| # "navx" | ||
| # "pathplannerlib" | ||
| # "phoenix5" | ||
| # "phoenix6" | ||
| # "playingwithfusion" | ||
| # "rev" | ||
| # "romi" | ||
| # "sim" | ||
| # "xrp" | ||
| ] | ||
| # Other pip packages to install (including vendor packages) | ||
| requires = [ | ||
| # Vendor packages (examples): | ||
| # "robotpy-navx" | ||
| # "robotpy-pathplannerlib" | ||
| # "robotpy-ctre" # Phoenix 5 | ||
| # "phoenix6" | ||
| # "robotpy-playingwithfusion" | ||
| # "robotpy-rev" | ||
| ] | ||
| # Other pip packages to install | ||
| requires = [] | ||
| ``` | ||
|
|
||
| Each of the following will instruct the deploy process to install packages to the roboRIO: | ||
|
|
||
| ``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``. | ||
|
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. optional core sounds wierd, I think here just optional WPILib packages is ok. |
||
|
|
||
| ``requires`` is a list of strings, and each item is equivalent to a line of a [requirements.txt](https://pip.pypa.io/en/stable/reference/requirements-file-format/) file. You can install any pure python packages on the roboRIO and they will likely work, but any packages that have binary dependencies must be cross-compiled for the roboRIO. For example, if you needed to use ``numpy`` in your robot code: | ||
|
|
||
|
|
||
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This shouldn't be commited