← Back to list

python-conventions
by JoernStoehler
⭐ 0🍴 0📅 Jan 21, 2026
SKILL.md
name: python-conventions description: Work on Python experiments in packages/python_viterbo. Use for layout conventions, stage entrypoints, lint/test commands, and asset/plot handling.
Python Conventions (python_viterbo)
Purpose and layout
- Experiments live in
src/viterbo/experiments/<experiment>/. - Stage entrypoints:
stage_<stage>.py. - Shared helpers:
src/viterbo/common/(avoid premature abstraction). - Configs:
configs/experiments/<consumer>/<variant>.json. - Data artifacts:
data/experiments/<producer>/<variant>/(Git LFS).
Commands
- Lint:
scripts/lint.sh(ruff format,ruff check --fix,pyright). - Smoke tests:
scripts/smoke-test.sh(pytest tests/smoke). - Targeted tests:
uv run pytest <args>.
Stage invocation
uv run python -m viterbo.experiments.<experiment>.stage_<stage> --config configs/experiments/<experiment>/<variant>.json
Conventions
- Follow best practices for ML/data‑science code.
- Docstrings include inputs/outputs, side effects, shapes/dtypes, and contract.
- Prefer pure functions where practical.
- Comments explain the why behind non‑obvious decisions.
Plots and assets
- LaTeX only includes assets; Python generates layout/style.
- Store outputs under
packages/latex_viterbo/assets/<experiment>/....
Score
Total Score
60/100
Based on repository quality metrics
✓SKILL.md
SKILL.mdファイルが含まれている
+20
✓LICENSE
ライセンスが設定されている
+10
○説明文
100文字以上の説明がある
0/10
○人気
GitHub Stars 100以上
0/15
○最近の活動
3ヶ月以内に更新がある
0/10
○フォーク
10回以上フォークされている
0/5
✓Issue管理
オープンIssueが50未満
+5
✓言語
プログラミング言語が設定されている
+5
○タグ
1つ以上のタグが設定されている
0/5
Reviews
💬
Reviews coming soon