Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. If you haven’t already, download and install Python 3.8: https://www.python.org/

    1. If you already have Python 3.7 or below installed, you must install Python 3.8 (you do not need to uninstall the other version(s)). This is because of a package dependency which requires Python 3.8 or greater.

      1. Python 3.8.10 or later is recommended, otherwise you will have pip issues.

    2. If you have Python 3.9 or above installed, you’re probably fine. Probably. Autonomy code is designed and tested on Python 3.8 so use a different version at your own risk.

  2. Open the console in the repository root.

    1. Example: C:\Users\Username\computer-vision-python

  3. Create a virtual environment called venv by running: [python] -m venv venv/ , where [python] is Python 3.8 (e.g. python , python38 ).

    1. You can check which version of Python it is by running [python] --version

    2. If you move the repository to a different path after creating a virtual environment, you will have to delete the venv directory and repeat this step. Additionally, if your virtual environment breaks for any reason, you can always delete the venv directory and repeat this step for a fresh environment.

    3. Do not use any name other than venv . Otherwise the linters and formatters will break.

  4. Activate the virtual environment:

    1. Windows command prompt: venv\Scripts\activate.bat

    2. Windows Powershell: .\venv\Scripts\Activate.ps1

      1. If you get an error with: running scripts is disabled on this system

      2. Run: Set-ExecutionPolicy Unrestricted

      3. This allows you to run any Powershell scripts at will. For more detail: https://learn.microsoft.com/en-us/powershell/module/microsoft.powershell.core/about/about_execution_policies?view=powershell-7.3

    3. Linux and MacOS: source venv/bin/activate

  5. You should now see (venv) in the prompt line.

  6. Confirm the virtual environment uses Python 3.8: python --version

    1. Literally use python , none of the fancy stuff above.

    2. Example output: Python 3.8.10