Skip to content

Commit

Permalink
Uninstall robotpy note (#2530)
Browse files Browse the repository at this point in the history
* Warn users they should uninstall robotpy first

* Add note about potential robotpy command error
  • Loading branch information
virtuald committed Jan 15, 2024
1 parent d3a96bf commit 56fafd9
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
4 changes: 4 additions & 0 deletions source/docs/software/python/subcommands/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ If you execute the command from the command line, it will show the various subco
python3 -m robotpy
.. note:: If you don't see a list of commands but either see a RobotPy logo or an error saying ``No module named robotpy.__main__; 'robotpy' is a package and cannot be directly executed``, you should uninstall the ``robotpy`` module and then reinstall it via pip.

This only affects users who upgraded from pre-2024 or the 2024 beta.

You can pass the ``--help`` argument to see more information about the subcommand. For example, to see help for the ``sim`` command you can do the following:

.. tab-set::
Expand Down
6 changes: 6 additions & 0 deletions source/docs/zero-to-robot/step-2/python-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ Once you have installed Python, you can use pip to install RobotPy on your devel
.. tab-item:: Windows
:sync: windows

.. note:: If you previously installed a pre-2024 or 2024 beta version of RobotPy, you should first uninstall RobotPy via ``py -m pip uninstall robotpy`` before upgrading.

.. warning:: On Windows, the `Visual Studio 2019 redistributable <https:// support.microsoft.com/en-us/help/2977003/ the-latest-supported-visual-c-downloads>`_ package is required to be installed.

Run the following command from cmd or Powershell to install the core RobotPy packages:
Expand All @@ -51,6 +53,8 @@ Once you have installed Python, you can use pip to install RobotPy on your devel
.. tab-item:: macOS
:sync: macos

.. note:: If you previously installed a pre-2024 or 2024 beta version of RobotPy, you should first uninstall RobotPy via ``python3 -m pip uninstall robotpy`` before upgrading.

On a macOS system that has pip installed, just run the following command from the Terminal application (may require admin rights):

.. code-block:: sh
Expand All @@ -72,6 +76,8 @@ Once you have installed Python, you can use pip to install RobotPy on your devel
.. tab-item:: Linux
:sync: linux

.. note:: If you previously installed a pre-2024 or 2024 beta version of RobotPy, you should first uninstall RobotPy via ``python3 -m pip uninstall robotpy`` before upgrading.

RobotPy distributes manylinux binary wheels on PyPI. However, installing these requires a distro that has glibc 2.35 or newer, and an installer that implements :pep:`600`, such as pip 20.3 or newer. You can check your version of pip with the following command:

.. code-block:: sh
Expand Down

0 comments on commit 56fafd9

Please sign in to comment.