setup-project

Bootstraps the fluidpy project environment with venv, PDF splitting, tests, and git initialization.

Updated Sep 13, 2026
One-click install
npx skills add https://github.com/shammun/fluidpy --skill setup-project-shammun
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: setup-project
Source: https://github.com/shammun/fluidpy/tree/main/.claude/skills/setup-project
Command: npx skills add https://github.com/shammun/fluidpy --skill setup-project-shammun

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires plotly, playwright, imageio-ffmpeg, ipykernel, pytest, nbconvert.

What problem does it solve? Setting up the fluidpy learning-package project requires many one-time steps—verifying the textbook PDF, creating a Python virtual environment, registering a Jupyter kernel, splitting the book into chapters, and initializing git—and doing them manually is error-prone and easy to get out of order. ## Core Features & Use Cases - Idempotent bootstrap: Every step checks current state before acting, so the skill can be re-run safely without breaking an existing setup. - Environment provisioning: Creates the .venv with all dependencies (plotly, playwright, imageio-ffmpeg), registers the fluidpy-venv Jupyter kernel, and configures Playwright to use the installed Edge or Chrome browser. - Book preparation and verification: Validates book.yaml chapter page ranges against the PDF outline, splits the book into per-chapter PDF/text files, and runs machinery self-tests (pytest, viz checks, screenshot pipeline). - Use Case: After cloning the fluidpy repository onto a new machine, run the skill once to get a fully working environment with a printed pass/fail checklist, ready to start chapter work. ## Quick Start Run /setup-project to verify the book PDF, build the Python environment, split the chapters, run the self-tests, and print a setup checklist.

Frequently Asked Questions about setup-project

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I set up the fluidpy project environment?

Run the /setup-project skill from the project root. It verifies the book PDF against book.yaml, creates the .venv with all requirements, registers the fluidpy-venv Jupyter kernel, splits the book into chapters, runs self-tests, and prints a checklist.

How do I split a textbook PDF into per-chapter files with Python?

The skill runs tools/split_pdf.py with the project venv, using page ranges from book.yaml derived from the PDF's own outline. It produces chapters/chNN.pdf and chNN.txt files plus a page map, and spot-checks that chapter boundaries are correct.

Can I re-run the setup script without breaking my environment?

Yes, the setup is idempotent: every step checks the current state before acting, so an existing .venv, kernel registration, or git repository is detected and repaired rather than recreated.

Does Playwright need to download a browser for HTML audits?

No, the tooling uses the already installed Microsoft Edge or Google Chrome through Playwright's channel feature. Only if neither browser exists does it fall back to installing Chromium via playwright install.

Why does the setup check fail on the book PDF?

The check fails when chapter page ranges in book.yaml do not match the PDF's own outline, meaning a chapter does not start on its expected opener page. The skill stops and shows the mismatch so you can fix book.yaml before continuing.