How mesteriis/g060525-e-pt works
Project Type and Purpose
• This is an open-source, content-centric repository hosting course presentations, code samples and supporting materials.
• Its primary function is to store slide decks (PPTX/DOCX), code examples (Python, shell), and auto-generate the README with up-to-date metadata (slide counts, modification dates, table of contents).
High-Level Architectural Components
a. Content Store
• “Модуль X…” directories: contain PPTX, DOCX, PDFs, .py/.sh examples/homeworks.
• Docs.md, CONTRIBUTORS.md, Makefile, pyproject.toml, uv.lock at top level.
b. Automation Scripts
• .github/scripts/bash/*.sh: common.sh, config.sh, logger.sh, process_presentations.sh
• .github/scripts/*.py: get_presentation_metadata.py, get_presentation_toc.py, update_progress.py
c. CI/CD Workflows
• .github/workflows/update-readme.yml: triggers on push, calls scripts to rebuild README.md
• .github/workflows/update-progress.yml: updates per-lesson progress, invokes update_progress.py
d. Repository and Version Control
• GitHub as VCS & hosting, .gitignore for exclusions
• Branch protection, action logs in .github/logs/action.log
e. Generated Artifacts
• README.md (auto-updated TOC + metadata)
• Progress indicators or badges (if any)
• Logs in .github/logs/
Relationships and Data Flow
1. Developer pushes new/updated slide or code file →
2. GitHub workflow (update-readme.yml) fires →
3. Bash wrapper (.github/scripts/bash/process_presentations.sh) orchestrates:
• Calls Python scripts (get_presentation_metadata.py, get_presentation_toc.py) to scan module directories → extract slide counts, update dates, generate markdown snippets.
• Uses common.sh/config.sh for environment variables and logging.
4. Assembled output replaces README.md and is committed back or used in GitHub Pages.
5. update-progress.yml may run periodically or on demand to recalculate completion metrics via update_progress.py.
Architectural Patterns and Principles
• Separation of Concerns: content vs processing logic vs orchestration vs CI config.
• Scripted pipeline: small focussed scripts (one responsibility each) called by a shell orchestrator.
• Declarative CI: workflows define triggers and high-level steps, use scripts for implementation.
• Idempotency: scripts read file tree and metadata and regenerate docs deterministically.