Skip to content

Commit 311d9be

Browse files
committed
chore: update the setup to use pyproject.toml
1 parent 37f38d3 commit 311d9be

6 files changed

Lines changed: 1412 additions & 301 deletions

File tree

.github/workflows/deploy.yml

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,11 +36,16 @@ jobs:
3636
python-version-file: '.python-version'
3737
cache: pip
3838

39+
- name: Install uv
40+
uses: astral-sh/setup-uv@v3
41+
with:
42+
enable-cache: true
43+
3944
- name: Install Python dependencies
40-
run: pip install -r requirements.txt
45+
run: uv sync
4146

4247
- name: Build HTML Assets
43-
run: jupyter book build --execute --html
48+
run: uv run jupyter book build --execute --html
4449

4550
- name: Upload artifact
4651
uses: actions/upload-pages-artifact@v3

AGENTS.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# AGENTS.md
2+
3+
## Project
4+
5+
Selbstlernkurs Python (MyST Markdown / Jupyter Book for HU Berlin LIS students "im Fernstudium").
6+
7+
## Structure
8+
9+
- `000-Einleitung/` to `999-Epilog/`: Sequential modules.
10+
- `solutions/`: Exercise solutions.
11+
- `assets/`: Images/logos.
12+
- `_build/`: Output (DO NOT EDIT).
13+
14+
## Dev
15+
16+
- **Env**: Python 3.14 (via `uv`). `uv sync`.
17+
- **Build**: `uv run jupyter book build --execute --all`
18+
- **Edit**: `uv run jupyter lab`
19+
- **Deps**: `jupyter-book>=2.0.0`, `jupyterlab`, `ipywidgets`, `jupyterquiz`
20+
21+
## Guidelines
22+
23+
- **Files**: `.ipynb` (code), `.md` (docs). Config: `myst.yml`, `toc.yml`.
24+
- **Adding content**: 1. Create numbered dir $\rightarrow$ 2. Update `toc.yml` $\rightarrow$ 3. Use YAML frontmatter (short_title, numbering) $\rightarrow$ 4. Start with "🎓 Lernziele".
25+
- **Language**: German + gender-neutral asterisks ("Lernende\*r"). English terms in parens: "Versionskontrolle (Version Control)".
26+
- **Scripts**: `#! /usr/bin/env python3`, `chmod +x`, PEP 8.

pyproject.toml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
[project]
2+
name = "selbstlernkurs-python"
3+
version = "0.1.0"
4+
description = "A self-learning Python course for library and information science students at Humboldt-Universität zu Berlin"
5+
readme = "README.md"
6+
requires-python = ">=3.14"
7+
dependencies = [
8+
"jupyter-book>=2.0.0",
9+
"jupyterlab",
10+
"ipywidgets",
11+
"jupyterquiz",
12+
]

requirements.in

Lines changed: 0 additions & 4 deletions
This file was deleted.

requirements.txt

Lines changed: 0 additions & 295 deletions
This file was deleted.

0 commit comments

Comments
 (0)