Course Setup

In order to use class time effectively, please do the following before the course starts:

Create a Github Account

Go to Github’s website and click sign up on the top right. Of course, if you already have a github account you can skip this step.

Setup Git

Here we will make sure your git installation is working and configured properly to push to github. If you know git is already installed on your machine and you have recently pushed content to a github repo you can skip this section.

  1. Make sure you have git installed.
  2. Create a personal repo called “git_test”
  3. Clone your repo

with https

git clone https://github.com/{your_user_name}/git_test

or with ssh

git clone git@github.com:{your_user_name}/git_test
  1. Configure your username/email address
git config --global user.name "FIRST_NAME LAST_NAME"
git config --global user.email "MY_EMAIL@example.com"
Tip

If you don’t want to include your email but still want github to give you credit for your commits, you can use: MY_GITHUB_NAME@users.noreply.github.com

  1. Make a small change

Simply add a file called README.txt to the local branch of the repository (where you git cloned the repo) and write some text in there such as “this is a test”

  1. Stage the change
git add -A
  1. Commit the change
git commit -m "test message"
  1. Push to origin
git push origin main

or if master is the name of the default branch

git push origin master

If this works you are good to go. If not, see the following note.

Note

If you haven’t done so yet, you may need to either: 1) Setup a personal access token to use https or 2) Setup ssh keys to use ssh.

Setup Python Environment

There are several ways to setup python but we recommend using conda. You may also want to create a virtual environment for the course.

All the packages you will need for the assignments can be installed with the following command:

python -m pip install -r https://raw.githubusercontent.com/opensourcecourse/utils/main/requirements.txt