lab_03.md

Lab 3

Goals

Students:

• Get their Project repository set up
• Practice working collaboratively in a repository

---

Preliminaries: Terminal in VSCode

• Open the integrated terminal
  • Select the shell (Git Bash or other)
• Python interpreter selection

---

Project team repository setup

1. Confirm that you have write access to your team's project repository.
2. Clone your project repository.
3. Open your local repository folder in VSCode.
4. Create a README that contains your Proposal (at a minimum).
5. Choose a license for your repository.

---

Adding a .gitignore

• In general, we don't want Git to commit every single file in our local repository. Examples:
  • .DS_Store files in macOS
  • Thumbs.db files in Windows
  • Python environment files .env and .venv (more on this below)
• We can tell Git which files and folders to ignore using a .gitignore file
• Set one up for Python and Mac or Windows
• Save a .gitignore file in your repository's root directory

---

Setting up a Virtual Environment

• In the repository folder, create a virtual environment running the command python -m venv .venv

• Add a requirements.txt listing the packages that you expect to use in your project. Write each package on its own line, for example:

  pandas
  jupyter==1.*
  plotly
  

• Activate the virtual environment

• Install the dependencies:

  pip install -r requirements.txt

• Select the Python interpreter under .venv/ as the kernel.

---

Checking that .gitignore works

1. Check the list of changes in the Source Control panel of VSCode.
2. Go to the .gitignore file, comment the .venv/ line and save.
3. Check the list of changes again. Can you see the problem?
4. Uncomment the .venv/ line and save.
5. Create a new branch, commit and push.
6. By group, merge one of the pull requests.

---

Pull request practice

1. Make sure your repository is up-to-date: checkout to the main branch and pull
2. Each student will create a new branch to add a new feature:
   1. Student A: add the notebook from Part 1
      • Ensure the notebook runs from VSCode.
      • The notebook may not (fully) render on GitHub, due to having interactivity. Try accessing the GitHub URL via nbviewer/Colab.
   2. Student B: add a README.md.
      • Add project title and a short description
      • Setup/usage instructions - these will change over time
   3. Student A or B: add an Open in Colab button
3. Review each other's pull requests

---

Adding TODOs

Each Project team will:

1. Re-review the Project goals and think back to the brainstorming.
2. Think through what it will take to achieve that.
   • What are the known unknowns?
3. Create at least eight issues.
   • Add objectives / acceptance criteria for each.
   • These can change later.

---

Examples

Get data

- [ ] The get data function should collect all data from source XX
- [ ] The data should be stored as a DataFrame with columns X, Y, Z,...
- [ ] The get data function should print the number of rows

Make Visualization X

- [ ] Add a visualize button
- [ ] Produce an interactive graph showing X vs Y
- [ ] Add a filter by YY option
- [ ] Add a group by ZZ option

---

Submit via CourseWorks.

---

Lab Slides