diff --git a/README.md b/README.md index 4e58b3c..4451a9a 100644 --- a/README.md +++ b/README.md @@ -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) diff --git a/spec.md b/spec.md index 357bd7c..f6c76f7 100644 --- a/spec.md +++ b/spec.md @@ -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`