Skip to content

gpsaggese/helpers / .claude/skills/notebook.fix_packages

notebook.fix_packages

Verified

Keep the Docker container aligned with the template and install Python packages directly in the notebook

FileKindSize
SKILL.mdskill md3.6 KB
---
description: Keep the Docker container aligned with the template and install Python packages directly in the notebook
model: haiku
---

# Goal

- When creating Docker images for projects and tutorials, we want to
  - Always use the same Docker template image from `class_project` to avoid
    replicating Docker containers
  - Install the needed packages in the notebooks to customize the container

## Inputs

- The user passes:
  - A target dir `<TARGET_DIR>` (e.g.,
    `msml610/tutorials/L03_knowledge_representation`) cloned from
    `class_project/project_template`
  - (Optional) pointers to Jupyter notebooks

# Workflow

## Use the Docker Container From the Project Teamplate

- In the project dir (e.g., `msml610/tutorials/L03_knowledge_representation`),
  use the same `Dockerfile` and `requirements.txt` as the matching files in
  `class_project/project_template`, so the project container matches the class
  project template
- If the image needs something that `pip` cannot install, add it to `Dockerfile`
  with a clear comment on why it is needed

## Discover All Packages Needed by the Notebook

- A notebook's own `import` lines are not the full picture. Each notebook pairs with
  a `*_utils.py` file (e.g., `L03_06_logic_solvers.ipynb` ->
  `L03_06_logic_solvers_utils.py`), imported with a line like:

  ```
  import L03_06_logic_solvers_utils as utils
  ```

- Read the `*_utils.py` file and any local module it imports (transitively). Collect
  every third-party `import` / `from ... import` statement, not just those in the
  notebook
- Map import names to pip names where they differ (e.g., `cv2` -> `opencv-python`,
  `sklearn` -> `scikit-learn`, `PIL` -> `Pillow`, `yaml` -> `PyYAML`)
- Diff this full list against `requirements.txt` and `Dockerfile`. A package used by
  the notebook or its utils that is missing from both is a bug, even if it is
  already installed in the container used to author the notebook
- Add every missing package to `requirements.txt`, and to `Dockerfile` only if it
  cannot be installed with `pip` (per `## Use the Docker Container from the Project
  Teamplate` above)

## Add Packages to Notebooks

- Add a `pip install` cell for the packages needed in each notebook, including every
  package from `## Discover All Packages Needed by the Notebook` above. Install and
  pin the versions
- For each notebook, add after the first call with

  ```
  %load_ext autoreload
  %autoreload 2

  import logging
  ```

  a cell with content like:

  ```
  !pip install -q python-sat==1.9.dev15 sympy==1.14.0 z3-solver==5.1.0.0

  import pysat
  print("pysat version: ", pysat.__version__)
  import sympy
  print("sympy version: ", sympy.__version__)
  import z3
  print("z3 version: ", z3.get_version_string())
  ```

## Sync Notebook

- At the end, sync the paired `.py` file with Jupytext following the conventions in
  `# Code Architecture and Responsibility` ->
  `## Utilities vs. Notebook Responsibilities` in `.claude/skills/notebook.rules.md`

# Verification

- [ ] Every third-party import in the notebook and its paired `*_utils.py` file
      has a matching entry in `requirements.txt` and in the notebook's
      `pip install` cell
- [ ] Build the docker container with `docker_build.sh` inside the target dir
      `<TARGET_DIR>`
- [ ] Make sure the container builds correctly and it's the same as the Docker
      container for the project, if possible
- [ ] Run each notebook inside the docker container with `docker_cmd.sh` and
      `nbconvert` to make sure they run correctly end-to-end

# Conventions

- Always follow the conventions and guidelines in `.claude/skills/notebook.rules.md`
writing-skillsobra/superpowersUse when creating new skills, editing existing skills, or verifying skills work before deploymentStars: 322kUpdated Claude CodeCodexVerifiedInstall
xlsxanthropics/skillsUse this skill any time a spreadsheet file is the primary input or output. This means any task where the user wants to: open, read, edit, or fix an existing .xlsx, .xlsm, .xltx, .csv, or .tsv file (e.g., adding columns, computing formulas, formatting, charting, cleaning messy data); create a new spreadsheet from scratch or from other data sources; or convert between tabular file formats. Trigger especially when the user references a spreadsheet file by name or path — even casually (like "the xlsx in my downloads") — and wants something done to it or produced from it. Also trigger for cleaning or restructuring messy tabular data files (malformed rows, misplaced headers, junk data) into proper spreadsheets. The deliverable must be a spreadsheet file. Do NOT trigger when the primary deliverable is a Word document, HTML report, standalone Python script, database pipeline, or Google Sheets API integration, even if tabular data is involved.Stars: 198kUpdated Claude CodeCodexVerifiedInstall
shipping-and-launchaddyosmani/agent-skillsPrepares production launches. Use when preparing to deploy to production, or when asking what needs to be in place before shipping. Use when you need a pre-launch checklist, when setting up monitoring, when planning a staged rollout, or when you need a rollback strategy.Stars: 119kUpdated Claude CodeCodexVerifiedInstall
childhoodthedotmack/claude-memBabysit a shipped release after merge, publication, or deployment. Verify published packages, production behavior, installed plugins, and late CI or user reports until the observation window is clean; use babysit for PR readiness before release.Stars: 118kUpdated Claude CodeCodexVerifiedInstall