Skip to content

Docs feedback Improve documentation clarity and align spec with configuration #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bobmanuel-duabo wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Docs feedback Improve documentation clarity and align spec with configuration #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
32014d8
add learning outcomes + dataset note + setup troubleshooting
bobmanuel-duabo Mar 3, 2026
61307d9
spec: align Python version and dependencies with pyproject
bobmanuel-duabo Mar 3, 2026
4e4f8d2
spec: fully align dependencies and Python version with pyproject
bobmanuel-duabo Mar 3, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,16 +7,20 @@
**Duration**: ~3 hours

---

## 🎯 What You'll Learn

By the end of this course, you'll be able to:

- Write Python code for data analysis
- Load and manipulate data with Polars
- Create interactive visualizations with Plotly
- Use AI tools (GitHub Copilot) to help you code

## What you'll learn (by the end of this class)
- Load and explore a dataset with Python
- Perform basic data cleaning and transformations with Polars
- Create simple visualizations with Plotly
- Use GitHub Copilot responsibly to speed up learning

## Dataset note
The datasets in this repository are provided for learning purposes.

## Common setup issues (quick fixes)
- **`uv` command not found**: close and reopen your terminal after installing UV (or restart VS Code).
- **Install/Sync fails**: run `uv sync` again from the project folder (where `pyproject.toml` is).
- **Marimo won't start / port in use**: stop other running notebooks/apps, then rerun the start command.
- **Permission issues on Windows**: try running PowerShell as Administrator.
---

## 🚀 Quick Start (5 Minutes)
Expand Down
10 changes: 5 additions & 5 deletions spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -92,15 +92,15 @@ IntroDataScience/
**Contains**:

- Project metadata (name, version, description)
- Python version requirement (3.11+)
- Dependencies: `marimo`, `polars`, `plotly`, `jupyter` (for compatibility)
- Dev dependencies: `ruff` (linting), `pytest` (testing)
- Python version requirement (3.12+)
- Dependencies: `marimo`, `polars`, `plotly
- Dev dependencies: none currently defined
- UV-specific configuration settings

#### `.python-version`

**Purpose**: Specify Python version for UV
**Content**: `3.11` or `3.12`
**Content**: `3.12`
Note: This project requires Python 3.12 or higher as defined in `pyproject.toml`

#### `.gitignore`

Expand Down