Skip to main content

Lab 1: Introduction to Git, GitHub.com, and Python

Lab Objectives

  • Set up a development environment for the course
  • Using the "git clone" command to clone a repository into a new directory
  • Set up account on github.com for creating, tracking, and managing a repository
  • Configure and explore the Python interpreter

Overview

  • In this lab, you will create Linux virtual machine to complete your course work. Additionally you will create an account on Github to explore the basic workflow of using version control. The essential operations provided by Github includes

    • cloning a new repository,
    • making changes to files,
    • creating a commit, and
    • pushing your changes.
  • Finally, study, create and execute simple Python scripts.

Reference

Glossary

  • git - a distributed revision control system with rich command set that provides both high-level operations and full access to git's internals.
  • github.com - a code hosting platform for version control and collaboration that lets people work together on software projects from anywhere.

Investigation 1 - Set Up A Development Environment

In order to proceed in the course you're going to need a Linux-based development environment. The requirements for this development environment are:

  • it has a version of Python 3 installed,
  • it has a version of git installed,
  • it has a web browser installed, and
  • it has a text editor with modern development tools installed. (syntax highlighting, linting, etc.)

You have options in how you set this up. If the computer you will be using for this course is powerful and has at least 16 GB of RAM, you will probably want to set up a Virtual Machine. Otherwise, skip this step and proceed to Use WSL below.

Option 1: Create a Linux Virtual Machine

We will demonstrate the steps for setting up a Linux Mint Virtual Machine with Visual Studio Code installed. A short video is available to walk you through the process.

  • Find the VirtualBox Website and follow the instructions to install VirtualBox for your specific operating system.
  • Download the Linux Mint ISO file from Linux Mint Website.
  • Create a new virtual machine from this ISO file. Your virtual machine should have at least 8GB of memory and 20GB of hard drive space, and you can leave all other hardware specs as default.
  • Start up your virtual machine, and at the graphical start menu select 'Install on your computer.'
  • Your installer will now be displayed. Set language, timezone, and accept defaults for drive partitioning. Enter your username and password.
  • Allow the installation to complete, and then reboot your machine.
  • When the Virtual Machine has rebooted, you should see a welcome screen along with some more configuration options.
  • Enter your name, and a password. Don't forget this password, as you will need it to become root.

Verify Python

Linux Mint should have the required software (with the exception of VS Code) already installed. We will verify this before moving on.

  • Open a terminal by clicking on the start button in the bottom-left corner.
  • Enter the command python3 --version and verify that the installed version is at least python 3.11. If no version of Python is installed, run sudo apt install python3.
  • Enter the command git --version and verify that the installed version is at least git 1.2. If no version of Python is installed, run sudo apt install git.
  • Run sudo apt update && sudo apt upgrade to update the system software.

Install Visual Studio Code and Extensions

Visual Studio Code has an excellent Debugger for Python, and so it is the recommended editor for this course. However, you may use a different editor at your discretion. Pycharm Community also has a very good debugger, works on Linux Mint, and is free for students.

  • We will need to add the Microsoft Repository to our list of accepted repositories. These instructions are on The Microsoft page.
  • Launch Visual Studio Code. Click the Start button and type 'code', you should see the launcher for Visual Studio Code appear.
  • Now install the Python extension. Press Control+Shift+x to open Extensions in the sidebar. (Or click on the Extensions icon on left side of the window).
  • Type 'Python' into the search bar, and click 'Install' when you find the extension created by Microsoft. You may wish to explore other extensions to customize your workspace.

Option 2: Use WSL

If your computer has less than 16 GB of RAM and has problems running a full virtual machine, you may choose to use Windows Subsystem for Linux (WSL) instead. This will provide a minimal Linux environment. A short video is available to view.

  • Open "Windows Store".
  • Search for "Ubuntu" and install the app that is published by Canonical.
  • Launch Ubuntu from the Start Menu. You will have a terminal-based Linux interface only. To access your Windows files, type cd /mnt/c. This will get you to the top of your Windows C drive.

Verify Python on Ubuntu

Ubuntu should have the required software (with the exception of VS Code) already installed. We will verify this before moving on.

  • Enter the command python3 --version and verify that the installed version is at least python 3.4. If no version of Python is installed, run sudo apt install python3.
  • Enter the command git --version and verify that the installed version is at least git 1.2. If no version of Python is installed, run sudo apt install git.
  • Run sudo apt update && sudo apt upgrade to update the system software.

Verify Python on Windows

  • Open your Windows command prompt and type python --version. If no version of Python is installed, it should give you instructions in how to install it, or go to the Python Homepage.

Install VS Code

  • Follow the instructions to install VS Code on Windows. Now you will be able to complete most tasks on Windows, and switch to a minimal Linux environment when needed.

Task: Verify The Python Interpreter

A few background information about the Python programming language

  • The Python Interpreter understanding the Python language and this is why we are going to learn this programming language in this course.
  • The Python Language supports both object-oriented programming and procedural programming paradigms.
  • The Python programming environment consists of a few basic components: language keywords, symbols, modules, and data objects.
  • The Python Interpreter supports two mode of operations: script mode and interactive mode.
  • In interactive mode, the Python interpreter allows us to run python code one statement at a time. Currently, there are two major versions of the Python interpreter available: version 2 and version3.
  • To start an interactive Python version 2 shell, type "python" at the command prompt. Python 2 is deprecated and should not be used for any new projects.
  • To start an interactive Python version 3 shell, type "python3" at the command prompt.
  • To exit from the interactive Python shell, press Ctrl+d.

Task: Create directory structure for Labs and Assignments

Create directory structure using BASH commands

  • Lets setup and reserve the following directories for storing and organizing files for labs and assignments. Execute the following commands at the command prompt:
mkdir ~/ops445
mkdir ~/ops445/lab1
mkdir ~/ops445/lab2
mkdir ~/ops445/lab3
mkdir ~/ops445/lab4
mkdir ~/ops445/lab5
mkdir ~/ops445/lab6
mkdir ~/ops445/lab7
mkdir ~/ops445/lab8
mkdir ~/ops445/a1
mkdir ~/ops445/a2

Investigation 2 - Git and GitHub

Task 1: Create a Github.com account

  • Start your web browser and go to github.com and use your own email to sign up for a new github account if you don't already have one. [Note: Please be aware that Seneca's spam filter block email from github.com by default, if you use your Seneca email to sign up for an account on github.com, you might have to re-configure your email spam filter to allow confirmation email from github.com to reach your inbox.]

Task 2: Configure Git On Your Development Machine

Please note that git and GitHub are independent of one another, so you will also need to set up some things locally with git.

  • If it isn't still running, start the VM you just created for the course, and open a terminal. Enter the following commands:
git config --global user.name "Firstname Lastname"
git config --global user.email "mysenecaid@myseneca.ca"
git config --global pull.rebase false

Please note you must use your valid myseneca email address in this configuration, otherwise you may not get credit for some of your work. You will need to configure this for each machine you are using for lab work.

Task 3: Add your public key to Github

Follow the Github guide here to add your public key to your profile:

  • Add one public key for each computer/VM you will be using for the course.
  • Run ls -la ~/.ssh and look for a public key file such as id_ed25519.pub. If no file exists, generate a new keypair using ssh-keygen.
  • Use cat <public key filename> to display the contents of the public key, and then select and copy the text.
  • Open Github in your web browser. Log in, select Settings -> SSH and GPG Keys. Create new key, and paste your public key contents into the text box.

You will now have permission to clone repositories using SSH.

Task 4: Clone a Github.com repository into a new directory on a Linux system

If your professor is asking you to submit labs on GitHub, follow their instructions now to clone the lab1 repository.

Otherwise, download the sample.py script from https://github.com/ahadalioglu/ops445-lab1 repository to ~/ops445/lab1 directory

  • Study and Explore the sample.py python script and identify the following sections:
    • the shebang line
    • the script level docstring
    • the import section to import functions from the standard library module
    • the function definition section
    • the main script section
  • Also identify the following items appear in the sample.py script:
    • the Python keywords
    • the decision code segment
    • the looping code segment
    • the run time error (exception) handling code segment
  • Run the sample script with the following given command line options and study its output:
python3 sample.py
python3 sample.py test
python3 sample.py 2>/dev/null
python3 sample.py test 2>/dev/null

Investigation 3 - Exploring and Using Python's Built-in Functions

Part 1 - Interactive (learning) mode: using the Python Interactive Shell

  • In this mode, you can instruct the Python Interpreter to execute python statement or python expression one at a time, call a function, or display the representation of a python data object.
  • To start the Python version 3 Interactive shell, type the command
[eric.brauer@mtrx-node05pd lab1]$ python3

at the Linux command prompt.

  • You should get a startup message similar to the following:
[eric.brauer@mtrx-node05pd lab1]$ python3
Python 3.6.8 (default, Apr 2 2020, 13:34:55)
[GCC 4.8.5 20150623 (Red Hat 4.8.5-39)] on Linux
Type "help", "copyright", "credits" or "license" for more information.
>>>
  • Note that when you see the >>> Python interactive shell prompt, which indicates that the Python Interpreter is listening and waiting to carry out your instruction written in the Python language. Try the following commands at the python command prompt, and record their outputs for future reference:

    • >>> copyright
    • >>> credits
    • >>> license
    • >>> help
  • The output of the last command should tell you how to enter the interactive help, or how to get help on a Python Object. You should see the following message when entering the interactive help utility:

Welcome to Python 3.6's help utility!

If this is your first time using Python, you should definitely check out
the tutorial on the Internet at https://docs.python.org/3.6/tutorial/.

Enter the name of any module, keyword, or topic to get help on writing
Python programs and using Python modules. To quit this help utility and
return to the interpreter, just type "quit".

To get a list of available modules, keywords, symbols, or topics, type
"modules", "keywords", "symbols", or "topics". Each module also comes
with a one-line summary of what it does; to list the modules whose name
or summary contain a given string such as "spam", type "modules spam".

help>
  • Please note that the prompt changed from >>> to help>. Try the suggestion and feel free to explore the interactive help utility. Simple press the Enter key to get out of the interactive help utility.
  • At the >>> prompt, type dir() to call the built-in function named dir without passing any function argument to it. The dir() function will return a list of data object names known to the Python interpreter at that moment. You should get a list of items similar to the following:
>>> dir()
['__annotations__', '__builtins__', '__doc__', '__loader__', '__name__', '__package__', '__spec__', 'x']
>>>
  • We are interested in the object named __builtins__ at this moment. We can ask the Python interpreter to tell us more about the __builtins__ object by passing its name __builtins__ as the function argument to the dir() function:
>>> dir(__builtins__)
['ArithmeticError', 'AssertionError', 'AttributeError', 'BaseException', 'BlockingIOError',
...
ValueError', 'Warning', 'ZeroDivisionError', '_', '__build_class__', '__debug__', '__doc__',
'__import__', '__loader__', '__name__', '__package__', '__spec__', 'abs', 'all', 'any',
'ascii', 'bin', 'bool', 'bytearray', 'bytes', 'callable', 'chr', 'classmethod', 'compile',
'complex', 'copyright', 'credits', 'delattr', 'dict', 'dir', 'divmod', 'enumerate', 'eval',
'exec', 'exit', 'filter', 'float', 'format', 'frozenset', 'getattr', 'globals', 'hasattr',
'hash', 'help', 'hex', 'id', 'input', 'int', 'isinstance', 'issubclass', 'iter', 'len',
'license', 'list', 'locals', 'map', 'max', 'memoryview', 'min', 'next', 'object', 'oct',
'open', 'ord', 'pow', 'print', 'property', 'quit', 'range', 'repr', 'reversed', 'round',
'set', 'setattr', 'slice', 'sorted', 'staticmethod', 'str', 'sum', 'super', 'tuple',
'type', 'vars', 'zip']
  • The above output shows a list of the so-called built-in run-time error codes and built-in function names. We are going to learn how to use them effectively in order to save our coding effort when writing Python programs/scripts.
  • Let starts with the following built-in functions:
    • print()
    • help()
    • type()
  • We can learn more about the above built-in functions within the Python interactive shell. Study the output of the following command at the >>> prompt and keep a record of them for future reference:
>>> help(help)
>>> help(print)
>>> help(type)
>>> type(type)
>>> type(help)
>>> type(print)

Unit Feedback Script : CheckLabX.py

Unit Feedback Scripts

Each Part (within an 'Investigation) is referred to as a Unit. Each Unit will require that the student download and run a Unit Feedback Script, which provides the OPS445 student "real-time feedback" of their completed work.

This feedback is not considered to be perfect or fool-proof; however, it may provide feedback (hints) in case a student gets stuck or experiences an error when performing administration tasks or when creating their Python scripts. These unit feedback scripts can also be used to confirm that the student's Python script is on the right track, and provide a consistent record of their Python scripting progress throughout their labs.

Part 2 - Script (execution) mode: creating Python script

  • In this part we will start writing our very first python script. The scripts we are going to try will be very basic and it is use to help us practice the language syntax and explore the foundational coding skills, such as:
    • sending text to the screen,
    • storing value in an data object

Task 1 - Python script using builtin Functions

Creating the "Hello World" Python Script

You will learn to create a simple python script in this section. This python script will just call the Python builtin function print() to send the text "hello world" to the screen. The "hello world" is an old traditional first program students usually are taught to create, which is based on the first programming example from the first C programming text co-written by Dennis Ritchie, the creator of the C programming language and Brian Kernighan. You will learn how to run the Python script in the Python3 shell as well as to learn how to run the Python script from the bash shell.

Perform the following steps:

  1. Create a new Python file in your ~/ops445/lab1 directory. Call it lab1a.py. The first Python code we will write is going to call the print() function. A function is code that has been defined somewhere. Functions can take arguments, use these arguments in some way, and then usually, but not always, return a result. The first function we will use is the "print()" functions, it's sole purpose is to send data to the screen.
  2. Add the following line into your source code file:
print()
  • And run it from the command-line:
python3 ./lab1a.py
  • You will notice that nothing is printed even though we called the "print()" function. This is because we didn't pass any arguments to it, lets try again.
  1. Modify your call to print() to include an argument ('hello world'):
print('hello world')
  • This time we should now see that the python function "print()" has sent something to the screen - the words 'hello world'. In Python a word or a bunch of characters like 'hello world' is called a 'string'. In the above example, a string was passed as an argument to the print function. These words are important for understanding and talking about different aspects of code.
  1. Note that there are similarities between the Python print() function and the Bash echo command, but Python is more picky than bash (which is a good thing). Try to run print without the brackets or without the quotes to see what happens.

Reading errors

One of the things that makes a good programmer is debugging skills. The first and most important debugging technique is reading and understanding error messages. Try to understand what the errors are saying even if you think you already know what the problem is and already have some idea about how to fix it.

  1. Write the following code into our Python file. Note the she-bang line at the top of the file to run this script in the python3 environment. You will need to add this she-bang line for all python scripts you create for this course.
#!/usr/bin/env python3
'''Description: This program will output "hello world" to the screen.'''

# Any line that starts with a "#" is also known as a comment,
# these lines are ignored by the python interpreter even if
# they contain code. The very first line is called a Shebang line,
# it is used to tell the system which interpreter to
# use(python2, python3, bash, etc).

print('Hello world')
  1. Another way of running a Python program is executing it directly, e.g.:
./lab1a.py
  • Note that the file will need execute permissions even though you ran it just fine earlier. Why is that?

Submitting Your Lab Work Through GitHub

If you cloned your lab through GitHub, perform the following now:

cd ~/ops445/lab1/
pwd #confirm that you are in the right directory
ls lab1a.py #confirm that you have the lab1a.py script in your directory
python3 ./CheckLab1.py -f -v lab1a

Before moving on to the next step make sure you identify any and all errors in "lab1a.py". When the check script tells you everything is "ok", you may commit your changes.

git add lab1a.py
git commit -m "Added lab1a"
git push

Your first script is now submitted. The process for each part of the lab will be similar.

Submitting Your Lab Work Through Blackboard

If you did not clone your lab through GitHub, you may download the check script by following these steps:

Download the check script and check your work. Enter the following commands from the bash shell.

cd ~/ops445/lab1/
pwd #confirm that you are in the right directory
ls lab1a.py #confirm that you have the lab1a.py script in your directory
ls CheckLab1.py || wget 'https://github.com/senecaops445/lab1-template/blob/main/CheckLab1.py?raw=true' -O CheckLab1.py
python3 ./CheckLab1.py -f -v lab1a

Before moving on to the next step make sure you identify any and all errors in "lab1a.py". When the check script tells you everything is "ok", you may proceed to the next step.

Investigation 4 - Exploring Python's Built-in Data Objects

In Python, a data object is used to store data for use later in the program. This data can be a string, integer, decimal number, characters, etc. We will only be covering string and integer objects in this lab. You will learn and use other Python built-in data object types in future labs.

String Objects

String objects contain text to be used in your program. Examples of strings could be user-names, full-names, item descriptions, etc. We will now demonstrate how to assign a string to an object and how to display contents stored in a string object.

Perform the following steps:

  1. Create a python script (called lab1b.py) and first - start with a few simple things to try:
  2. Let's make a new object containing a value:
name =  'Thomas'
  1. Print the value to the screen:
print(name)
  1. Think about why this does something different:
print('name')
  1. Now lets try something new, we are going to print out the string and concatenate/combine it with another string. The plus sign can be used to join two strings together. However, make sure that the name of your object is always outside the quotes, or it will not resolve to a value.
print('I have a friend named ' + name)
  1. To gain practice, complete your Python script with the following content and details:
    • The script should have a Shebang line like you did for your lab1a.py python script
    • The script should use a single object called "name"
    • The value of the "name" object should be "Isaac"
    • The script, when executed, should print out "How old are you Isaac?"
    • Sample run:
cd ~/ops445/lab1/
./lab1b.py

How old are you Isaac?
  • Try the checking script as you are working through a script to sometimes get hints.
  1. Download and run the checking script. Enter the following commands from the bash shell:
cd ~/ops445/lab1/
pwd #confirm that you are in the right directory
ls CheckLab1.py || wget 'https://github.com/senecaops445/lab1-template/blob/main/CheckLab1.py?raw=true' -O CheckLab1.py
python3 ./CheckLab1.py -f -v lab1b
  1. Before proceeding, make certain that you identify any and all errors in "lab1b.py". When the check script tells you everything is "ok", you may proceed to the next step.
  2. If using GitHub, repeat the steps to commit your lab1b.py file.

Integer Objects

In Python, integer objects are used to store an integer numbers that can be used for mathematical operations (discussed in the next section). Integers do NOT contain decimals, and they can be signed (+ or -) or unsigned. Here we will store integers in a object, perform math operations, and display the results.

Perform the following steps:

  1. Create a python script (called lab1c.py) and first - start with a few simple things to try:
  2. Lets create two new objects, num1 and num2, to play with.
num1 = 5
num2 = 10
  1. You can print the values in those integer objects:
print(num1)
print(num2)
  1. Now we will make a new object called "sum", and try some math:
sum = num1 + num2
  • This will add the values contained in the integer objects together and assign the result to the object named "sum". However you will note that there is no data show up on the screen. Let's inspect the contents of the new object named "sum":
print(sum)
  • Does this value look right? Are you sure?
  1. Now lets try printing this sum out with a string:
print('The sum is: ' + sum)
  • What happened? Did you receive an error? This may have been the first time you've seen this error, but it won't be the last. What we tried to do is combine a string with a number, and this won't work.
  • In order concatenate a sting and an integer object, we will have to use another builtin function called "str()" to convert an integer object to a string first. The "str()" function will return a string of your number and provide it as a argument to "print()". This function will not change the value of your object, your object is still an integer object.
  1. Issue the following:
print('The sum is: ' + str(sum))
  • What did you notice this time?
  1. To gain practice, complete your python script with the following features:

    • The script should have a Shebang line.
    • The script should have an object called name
    • The script should have an object called age
    • The value of the name object should be Isaac
    • The object age should contain a integer
    • The value of the age object should be 72
    • The script, when executed, should print out "Isaac is 72 years old!"
    • Example run:
cd ~/ops445/lab1/
./lab1c.py
Isaac is 72 years old!
  • Try the check script as you are working through a script to sometimes get hints.
  1. Download and run the checking script. Enter the following commands from the bash shell:
cd ~/ops445/lab1/
pwd #confirm that you are in the right directory
ls CheckLab1.py || wget 'https://github.com/senecaops445/lab1-template/blob/main/CheckLab1.py?raw=true' -O CheckLab1.py
python3 ./CheckLab1.py -f -v lab1c
  1. Before moving on to the next step make sure you identify any and all errors in "lab1c.py". When the check script tells you everything is "ok", you may proceed to the next step. Add lab1c.py to the repo and commit the change.

Investigation 5 - Exploring on How to Get Python to do Math

In the previous section, you performed a couple of simple mathematical operations. In this section, you will learn some additional mathematical operations.

Perform the following steps:

  1. Try some of the following to see what happens in Python:
print(10 + 5)    # addition
print(10 - 5) # subtraction
print(10 * 5) # multiplication
print(10 / 5) # division
print(10 ** 5) # exponents
  • NOTE: You must be careful when combining more complex math operators together. Python uses PEMDAS (Parentheses, Exponents, Multiplication and Division, Addition and Subtraction) to resolve math.

    1. Go over the below examples and see if you understand each situation:
print(10 + 5 * 2)       # multiplication happens before addition
print((10 + 5) * 2) # parentheses happen before multiplication
print(10 + 5 * 2 - 10 ** 2) # first exponents, then multiplication, then addition and subtraction from left-to-right
print(15 / 3 * 4) # division and multiplication happen from left-to-right
print(100 / ((5 + 5) * 2)) # the inner most parentheses are first performing addition, then parentheses again with multiplication, finally the division
  1. To gain practice, complete your script with the following content and details:

    • The script should have a Shebang line.
    • The object x should contain a integer with the value 10
    • The object y should contain a integer with the value 2
    • The object z should contain a integer with the value 5
    • The script, when executed, should print out "10 + 2 * 5 = 20" (the printout should change if the values in the objects change)
  • Example run:
cd ~/ops445/lab1/
./lab1d.py
10 + 2 * 5 = 20
  • Try the checking script as you are working through a script to sometimes get hints.
  1. Download and run the checking script. Enter the following commands from the bash shell:
cd ~/ops445/lab1/
pwd #confirm that you are in the right directory
ls CheckLab1.py || wget 'https://github.com/senecaops445/lab1-template/blob/main/CheckLab1.py?raw=true' -O CheckLab1.py
python3 ./CheckLab1.py -f -v lab1d
  • Before moving on to the next step make sure you identify any and all errors in "lab1d.py".
  1. When the check script tells you everything is "ok", you may proceed to the next step. Add your file to the repo, and make a commit.

Lab 1 Sign-Off

Again, you will be asked to submit the lab in one of two ways:

Upload the following files individually to Blackboard

Run the CheckLab1.py script and capture the result

python3 ./CheckLab1.py -f -v &> laboutput.txt

Submit the following files individually to Blackboard:

  • lab1output.txt
  • lab1a.py, lab1b.py, lab1c.py, and lab1d.py

Complete the GitHub Submission

Run the CheckLab1.py script and capture the result

python3 ./CheckLab1.py -f -v &> laboutput.txt
git add laboutput.txt
git commit -m "completed lab"
git push

Lab Review

  1. What is a git repository?

  2. What kinds of data can be stored in a git repository?

  3. What is a git branch?

  4. What is the name of the definitive branch in a git repository?

  5. What is a "pull request" related to a branch in a git repository?

  6. Write Python code that when run, will perform the following tasks:

    1. Contain a she-bang line
    2. Display a greetings message to the user
    3. display an empty line (hint: use the special character \n to print the a new-line character)
    4. Display text, "Your current directory is:" (You are NOT required to display quotation marks)
    5. Display the current working directory pathname (using an appropriate command)
    6. Display another empty line
  7. How do you execute a Python script when you are within the interactive python3 shell? (Hint: make use of a function provided by the os python module.)

  8. How do you execute a Python script when you are in the Bash Shell (i.e. NOT within the python3 shell)?

  9. Write the pipeline command to check if the CheckLab1.py checking script exists, and download it from the location: https://ict.senecacollege.ca/~eric.brauer/ops445/labs/LabCheckScripts/CheckLab1.py