Created Module Index (markdown)

Gramps
2025-07-23 20:49:37 -07:00
parent aeb67fdfa3
commit e2906dea16

61
Module-Index.md Normal file

@ -0,0 +1,61 @@
Great — here is the **Module Index** page draft:
---
# Module Index
This page lists all helper modules used by the Llama Chile Shop automation pipeline. Each module encapsulates a specific responsibility to keep the codebase maintainable and testable.
## `modules/config.py`
Centralized configuration constants, including:
* `NAS_MOUNT_ROOT` (e.g., `Z:\`)
* `DEBUG` mode flag
* Any other future global constants
## `modules/title_utils.py`
Functions for generating titles and output filenames:
* `generate_montage_title()`
* `generate_output_filename()`
## `modules/description_utils.py`
Handles dynamic video description generation using OpenAI:
* `generate_montage_description()`
* `generate_video_description(notes_path, ...)`
## `modules/social.py`
Legacy module originally handling social uploads. As of `v0.1.1`, superseded by:
* `yt_poster.py` (YouTube-specific)
* `pt_poster.py` (PeerTube-specific; coming in `v0.1.2`)
## `modules/yt_poster.py`
Primary logic for uploading videos to YouTube:
* Builds title and description
* Applies tags and category
* Manages OAuth2 credentials and upload logic
* Exports: `upload_video(...)`
## `modules/pt_poster.py` (Planned for `v0.1.2`)
PeerTube counterpart to `yt_poster.py`. Will implement:
* API upload logic to a specified PeerTube instance
* Reuses title and description generation pipeline
---
Next: [[OpenAI Integration](https://chatgpt.com/c/wiki_openai_integration.md)](wiki_openai_integration.md)
Back: [[Directory Layout](https://chatgpt.com/c/wiki_directory_layout.md)](wiki_directory_layout.md)
---
Let me know when you're ready to insert it or want edits.