Setup check

We your feedback and suggestions on this notebook!

---

In this exercise, you will run a series of checks to verify that your programming environment has been set up correctly. Note: The focus is not on setting up the environment (it is preinstalled in Codespaces). Instead, this exercise ensures everything is configured and functioning as expected.

Part 1: Git Configuration

Check your global Git configuration:

Verify that your Git name and email are correctly configured.

git config --global user.name
git config --global user.email

Part 2: Pre-commit Hook

Run all pre-commit hooks:

pre-commit run --all

Note any warnings or errors and resolve them if possible.

Part 3: SSH Connection

Test your SSH connection to GitHub:

ssh -T git@github.com

A successful message should look like:

Hi <username>! You've successfully authenticated, but GitHub does not provide shell access.

Part 4: Python Environment

Check the colrev package installation:

pip show colrev

Verify that the Location field points to the editable project location (e.g., /workspaces/). If not, the package might not be installed in editable mode.

Part 5: System Information

Check your system’s PATH:

echo $PATH

Confirm that /home/codespace/.local/bin is included in the PATH.

Print the current effective username:

whoami

Print system information (kernel and distro version):

uname -a

Part 6: Docker Verification

Run a Docker test container:

docker run hello-world

Confirm that Docker runs successfully and outputs the “Hello from Docker!” message.