Skip to content

getting-started.md

Latest commit

 

History

History
36 lines (24 loc) · 1007 Bytes

getting-started.md

File metadata and controls

36 lines (24 loc) · 1007 Bytes
Raw

Getting started — starter-data-python

Prerequisites

  • Docker + Docker Compose 2.24+
  • (Optional, local dev) Python 3.12+, uv

First run

git clone git@github.com:skilluv-community/starter-data-python.git
cd starter-data-python
cp .env.example .env
docker compose up --build

Open http://localhost:8888. Warning: the container disables Jupyter's auth token for developer convenience. Never expose this port to the public internet without adding a token/password.

Running notebooks

The notebooks/ folder is mounted from your host, so any changes you make in Jupyter Lab are saved locally.

Testing utility code

uv sync
uv run pytest -q

Tests live under tests/; helpers under src/. Notebooks should stay thin — they orchestrate, they don't hold logic.

Working with real datasets

The shipped CSV is a small illustrative sample. See data/README.md for real sources (World Bank, UN, Africa Open Data, data.gouv.bj).