<ScriptName>.py - [Concise one-line summary title]
[Detailed description of what the script does, its purpose,
and any key functionalities or context.]
python <ScriptName>.py [options] [arguments]
[Provide typical command-line usage examples]
python -W ignore <ScriptName>.py
[Optional: If applicable, show how to run ignoring specific warnings]
[Explain how to run the script, what to expect, how to stop it.]
[List any user-configurable variables defined in the script itself]
- <FLAG_NAME> (type): [Purpose of the flag, e.g., DEBUG (bool): Enables verbose output]
[Describe all input files, if applicable]
- Location: [e.g., Same directory, specified path]
- Format: [e.g., CSV, JSON, Plain Text]
- Content/Structure: [Describe rows, columns, keys, sections, etc.]
1. "[FieldName1]" (type): [Description]
2. "[FieldName2]" (type): [Description]
[Provide a small, clear example]
- Python [Version, e.g., 3.9+]
- [Library Name 2] ([Optional: brief note on purpose])
pip install [Library Name 1] [Library Name 2] ...
[Or: pip install -r requirements.txt]
[Optional: Briefly mention key libraries or technologies employed,
especially if they represent a significant architectural choice.
e.g., Uses APScheduler for scheduling, PySimpleGUI for UI, etc.]
- YYYYMMDD: [Description of change <n>].
- YYYYMMDD: [Description of change <n-1>].
[List any known bugs, limitations, or planned future enhancements.]
Talbot Stevens, with as much AI help as possible