Professional Python Project Explainer

A Marimo app that explains common files and folders in current public GitHub repositories.

Open the App

• Professional Python Project Explainer

How It Works

• Repository choices are loaded from src/public/repos.toml.
• The selected repository tree is fetched live from GitHub.
• Common files and folders are explained using src/public/explainer-catalog.toml.
• The repository tree is not stored and reflects the current repository shape.

Run

uv sync
uv run marimo run src/app.py

Edit

uv run marimo edit src/app.py

Developer Command Reference

Show command reference

In a machine terminal

Open a machine terminal where you want the project:

git clone https://github.com/pup-pack/professional-python-project-explainer

cd professional-python-project-explainer
code .

In a VS Code terminal

uv self update
uv python pin 3.14
uv python install
uv lock --upgrade
uv sync

uv run pre-commit install
uv run pre-commit autoupdate

git add -A
uv run pre-commit run --all-files
# repeat if changes were made
uv run pre-commit run --all-files

# run locally to test
uv run marimo run src/app.py

# check types and run tests
uv run ty check
uv run python -m pytest

# save progress
git add -A
git commit -m "update"
git push -u origin main

Explainer Catalog

Explainer Catalog

Annotations

Annotations

Citation

CITATION.cff)

License

MIT