notebooks

Jupyter notebooks for courses hosted on https://jovian.com

Development Setup

Follow the following instructions to setup your system in order to work with this repository.

Prerequisites

It is expected that to contribute to this project you know git and basic set of system commands. Start by installing following software:

1. Vscode: Install Vscode from this page for your operating system.

   If your distribution is not debian or fedora based, then search vscode in your distribution's package registry or install from flathub.

2. Node: Install nodejs from this page. The recommended way of installing node is by nvm as mentioned in the download page. Make sure node and npm is installed by checking their versions through node -v and npm -v respectively.

3. uv: It is python's package and project manager which can be installed from this page. For Linux and MacOS, it is simply by running the installation script with the command curl -LsSf https://astral.sh/uv/install.sh | sh

4. Python: Ensure that python is installed in your system by command python --version. Otherwise, install it from here for your specific OS.

5. Git: Install git for your specific system from here.

Setting Up

1. Fork this project in your github profile and clone it locally with command git clone git@github.com:your_username/notebooks.git. Don't forget to replace your_username with your github's username.
2. Next up, move into the project with cd notebooks and install python dependencies with uv sync.
3. Let's now install codex with command npm install -g @openai/codex.
4. Run codex in your present working directory( i.e. notebooks) to start the AI agent. Running the command for the first time will ask you to authenticate by signing into Chatgpt.
5. Once, the authentication is complete, you can start by asking codex about the overview of the repository in the terminal itself.
6. Open vscode in this directory by code . command, further install Codex and Python extensions from the extensions tab in Vscode.

Making changes

1. Changes in this repository are accepted in PR format. So, create a new branch in your repository by opening the directory in terminal (or terminal pane in Vscode) and running git branch -u branch_name.
2. Activate python environment by source .venv/bin/activate.
3. Make your changes. Commit them in your branch and then pull a request in github to merge the changes. Always provide proper description of what you changed in commit messages and PR's description section.

How to add "Open in Colab" tags

1. Install dependencies:

uv sync

2. Run scripts/recursive_tag.py with course slug:

uv run scripts/recursive_tag.py -- data-analysis-with-python-zero-to-pandas

This will invoke scripts/capture_tag.py recursively for each notebook within the course and add the "Open in Colab" tag.

3. Start Jupyter Lab to view the notebooks with "Open in Colab".

uv run jupyter lab

Navigate to any notebook in the modified course to see and test the tag.