youtube-cli/docs/structure.md
Jarian Cottingham 3c5b10466a chore: clean repo for public release
- Remove runtime artifacts (app.log, .DS_Store, committed home dir data)
- Remove AI session notes (prompt.md, agent.md, LOGGING_*.md)
- Move TUI.md, structure.md, docker-setup.md to docs/
- Normalize author metadata to Jarian Cottingham
- Fix hardcoded personal paths in gunicorn config and manual test script
- Pin textual <2.0 (8.x grid layout breaks TUI rendering)
- Fix stale tests: private attr access, missing screen push
- Add CI workflow (ruff + pytest, Python 3.10-3.12)
2026-08-20 21:03:50 +00:00

36 lines
1.7 KiB
Markdown

# YouTube CLI Project Structure
## Root Directory Files
- **.gitignore** - Git ignore file to exclude unnecessary files from version control
- **README.md** - Project documentation and usage instructions
- **requirements.txt** - Python dependencies required for the project
- **run.sh** - Shell script to run the application
- **setup.py** - Python package setup configuration
- **config.json** - Configuration file for the application settings
- **prompt.md** - Prompt template used for generating markdown content
## Package Directory: youtube_cli
- **youtube_cli/__init__.py** - Package initialization file
- **youtube_cli/__main__.py** - Main entry point for running the package as a module
- **youtube_cli/main.py** - Core application logic and main functions
## Package Cache Directory: youtube_cli/__pycache__
- **youtube_cli/__pycache__/__init__.cpython-314.pyc** - Compiled Python cache file for __init__.py
- **youtube_cli/__pycache__/__main__.cpython-314.pyc** - Compiled Python cache file for __main__.py
- **youtube_cli/__pycache__/main.cpython-314.pyc** - Compiled Python cache file for main.py
## Package Info Directory: youtube_cli.egg-info
- **youtube_cli.egg-info/dependency_links.txt** - Dependency links for the package
- **youtube_cli.egg-info/entry_points.txt** - Entry points for console scripts
- **youtube_cli.egg-info/PKG-INFO** - Package metadata information
- **youtube_cli.egg-info/requires.txt** - Required dependencies for the package
- **youtube_cli.egg-info/SOURCES.txt** - List of source files in the package
- **youtube_cli.egg-info/top_level.txt** - Top-level package names
## User Data Directory
- **~/Downloads/youtube/downloaded_videos.json** - JSON file storing information about downloaded videos (user-specific path)