wpilibsuite / frc-docs

Official FRC Documentation powered by Read the Docs
https://docs.wpilib.org
Other
151 stars 265 forks source link

Python: Document pinning dependency versions #2765

Open daltzctr opened 1 month ago

daltzctr commented 1 month ago

Instead of robotpy_extras, pinned versions can be declared in the requires block in pyproject.toml

#
# Use this configuration file to control what RobotPy packages are installed
# on your RoboRIO
#

[tool.robotpy]

# Version of robotpy this project depends on
robotpy_version = "2024.2.1.0"

# Which extra RobotPy components should be installed
# -> equivalent to `pip install robotpy[extra1, ...]
robotpy_extras = [
    # "all"
    # "apriltag"
    # "commands2"
    # "cscore"
    # "navx"
    # "pathplannerlib"
    # "phoenix5"
    # "playingwithfusion"
    # "rev"
    # "romi"
    # "sim"
]

requires = [
   "phoenix6==24.3.0",
]
virtuald commented 1 month ago

It would make sense to add that to source/docs/software/vscode-overview/3rd-party-libraries.rst per-vendor.

I'm thinking to get rid of extras this year too, we'll see.

TheTripleV commented 1 month ago

We should get rid of extras and just keep robotpy[all].