Git is a powerful version control system that Autonomy uses to organize many members contributing to the same codebase. Think of it as undo/redo, copying and renaming files to save an older version, and branching all rolled into one.

GitHub is a source code hosting and sharing website owned by Microsoft.

If you have already setup Git, you do not need to set it up again.

1. If you haven’t already, download and install Git: https://git-scm.com/

   1. Git should already be installed on Linux and MacOS.

2. Windows (Linux and MacOS users skip step): Set line endings.

   1. Check: git config --get core.autocrlf

      1. If it is true or input , you do not need to set anything.

   2. Set: git config --global core.autocrlf [setting] .

      1. --global is optional, and replace [setting] with either true or input

      2. When in doubt, use input

   3. Additional information here: https://www.git-scm.com/book/en/v2/Customizing-Git-Git-Configuration#_core_autocrlf

3. Configure Git with your name and email: https://linuxize.com/post/how-to-configure-git-username-and-email/

   • --global if you want to use it as the default, otherwise it will just be for the current repository.

   • You can use your anonymous GitHub no-reply email.

1. Click on the green Code button.

2. In the dropdown, you can copy either the HTTPS or SSH link.

   1. Windows and MacOS: Copy the HTTPS link (although you can copy the SSH link if you desire).

   2. Linux: Copy the SSH link.

      1. If you really want to use HTTPS on Linux, you have to install the Git Credential Manager or create a Personal Access Token on GitHub. How to do this is left as an exercise for you.

3. If you’re using the SSH link (HTTPS link users skip this):

   1. If you haven’t already, create a new SSH key and add it to your GitHub account:

      1. https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent

      2. If you add a password to your SSH key, you will have to type it in every time you use Git to interact with GitHub (e.g. cloning, pulling, pushing). You can always delete and create a new SSH key if you change your mind later.

      3. https://docs.github.com/en/authentication/connecting-to-github-with-ssh/adding-a-new-ssh-key-to-your-github-account

4. Pick a parent directory to clone (download the code) into.

   1. Example: Cloning in C:\Users\Username\ will create a folder and then populate it: C:\Users\Username\computer-vision-python\[files]

5. Open the console in the parent directory.

   1. Windows: Command prompt or Powershell.

   2. Linux and MacOS: Terminal.

6. Clone the repository: git clone [link you copied] , where [link you copied] is the link you copied in step 2.

   1. HTTPS link users: You will be prompted to log into your GitHub account. Do so.

7. Update the repository submodules: Run the project setup scripts (If provided)

   1. Windows: .\setup_project.ps1

   2. Linux/Mac: source ./setup_project.sh

8. Done!

A Python virtual environment is a self contained environment with a specific Python version and package versions. Different virtual environments can be used for different projects to maintain consistency.

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

   1. If you have a different version of Python installed:

      1. Python 3.9 or lower: You must install Python 3.11 (you do not need to uninstall the other version(s)). This is because of a language feature dependency (specifically, match statements introduced in Python 3.10 : https://docs.python.org/3.10/tutorial/controlflow.html#match-statements ).

      2. Python 3.10: You’re probably fine. Probably. Use at your own risk.

      3. Python 3.12 or higher: You’re probably fine. Probably. Use 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 --system-site-packages ./venv , where [python] is Python 3.11 (e.g. python , python311 ).

   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.

      1. If you have to change the Python version of your virtual environment, delete it and repeat this step with the new Python version.

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

1. If you haven’t already, 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

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

3. Confirm the virtual environment uses Python 3.11: python --version

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

   2. Example output: Python 3.11.9

4. When you’re done developing, make sure to either close the terminal or run:

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

   2. Everything else: deactivate

   3. This is important to avoid going to a different project and then accidentally polluting your current project’s virtual environment.