Scripts and Tools

Scripts and Tools

Complete documentation for all StreamTV utility scripts and tools.

Scripts

Utility scripts for managing StreamTV.

create_channel.sh (Zsh Script)

A zsh shell script that creates channels via the StreamTV API. This is the recommended method if the API server is running.

Prerequisites

• StreamTV API server must be running (start with python3 -m streamtv.main)
• curl command available
• zsh shell

Usage

Create all default channels (1980, 1984, 1988)

./scripts/create_channel.sh

Create a channel for a specific year

./scripts/create_channel.sh --year 1980
./scripts/create_channel.sh --year 1984
./scripts/create_channel.sh --year 1988

Create a custom channel

./scripts/create_channel.sh --number "1" --name "My Channel" --group "Entertainment"

Interactive mode

./scripts/create_channel.sh --interactive

Options

• --year YEAR: Create channel for specific Olympic year (1980, 1984, or 1988)
• --number NUMBER: Channel number (e.g., '1', '1980')
• --name NAME: Channel name
• --group GROUP: Channel group (default: 'StreamTV')
• --logo PATH: Path to channel logo image
• --disabled: Create channel as disabled (not enabled)
• --interactive, -i: Interactive mode for guided channel creation
• --api-url URL: API base URL (default: http://localhost:8410)
• --token TOKEN: Access token for authenticated API
• --help, -h: Show help message

Environment Variables

• STREAMTV_API_URL: API base URL (overrides --api-url)
• STREAMTV_ACCESS_TOKEN: Access token (overrides --token)

Examples

# Create all default channels
./scripts/create_channel.sh

# Create just the 1980 channel
./scripts/create_channel.sh --year 1980

# Create a custom channel
./scripts/create_channel.sh --number "10" --name "Classic Sports" --group "Sports"

# Use custom API URL
./scripts/create_channel.sh --api-url http://192.168.1.100:8410

# Interactive mode
./scripts/create_channel.sh -i

Notes

• The script checks if the API server is running before attempting to create channels
• If the API server is not available, the script will fall back to the Python script method
• Channels are created via the REST API (requires running server)
• The script provides colored output for better readability

---

create_channel.py (Python Script)

Creates channels for StreamTV. This script can create custom channels or channels for specific content.

Prerequisites

Make sure you have installed the project dependencies:

pip install -r requirements.txt

Usage

Create all default channels (1980, 1984, 1988)

python3 scripts/create_channel.py

This will create channels based on the configuration. Channels can be customized with names and groups.

Create a channel for a specific year

python3 scripts/create_channel.py --year 1980
python3 scripts/create_channel.py --year 1984
python3 scripts/create_channel.py --year 1988

Create a custom channel

python3 scripts/create_channel.py --number "1" --name "My Channel" --group "Entertainment"

Options

• --year YEAR: Create channel for specific Olympic year (1980, 1984, or 1988)
• --number NUMBER: Channel number (e.g., '1', '1980')
• --name NAME: Channel name
• --group GROUP: Channel group (default: 'StreamTV')
• --logo PATH: Path to channel logo image
• --disabled: Create channel as disabled (not enabled)

Examples

# Create all default channels
python3 scripts/create_channel.py

# Create just the 1980 channel
python3 scripts/create_channel.py --year 1980

# Create a custom channel
python3 scripts/create_channel.py --number "10" --name "Classic Sports" --group "Sports"

# Create a disabled channel
python3 scripts/create_channel.py --number "99" --name "Test Channel" --disabled

Notes

• The script will check if a channel with the same number already exists and skip creation if found
• Channels are created directly in the database (no API server required)
• The database will be initialized automatically if it doesn't exist

Available Scripts

Shell Scripts

Installation & Setup

• install_macos.sh - macOS installation
• start_server.sh - Start StreamTV server
• verify-installation.sh - Verify installation

Channel Management

• create_channel.sh - Create channels via API
• create_schedule.sh - Create schedule files

Archive.org Parser

• archive_collection_parser_dialog.sh - Interactive GUI parser

Troubleshooting

• view-logs.sh - View application logs
• troubleshoot_streamtv.sh - StreamTV diagnostics
• troubleshoot_plex.sh - Plex integration diagnostics
• stop_server.sh - Stop running server

GitHub & Distribution

• upload-to-github.sh - Upload distributions to GitHub
• create-wiki.sh - Create GitHub wiki
• fix-unrelated-histories.sh - Fix git history issues
• push-distributions.sh - Push distributions to GitHub

Python Scripts

Channel Management

• create_channel.py - Create channels programmatically
• import_channels.py - Import channels from YAML
• import_collections.py - Import collections
• rename_channels.py - Rename existing channels
• remove_tpt_channels.py - Remove specific channels

Archive.org Integration

• archive_collection_parser.py - Parse Archive.org collections
• create_sesame_street_channel.py - Create Sesame Street channel
• create_mister_rogers_channel.py - Create Mister Rogers channel

Channel Rebuilding

• rebuild_1980_channel.py - Rebuild 1980 channel
• recreate_1980_channel.py - Recreate 1980 channel
• recreate_1992_channel.py - Recreate 1992 channel
• full_rebuild_1980.py - Full rebuild of 1980 channel
• complete_rebuild_1980.py - Complete rebuild of 1980 channel

Metadata & Data

• enrich_metadata.py - Enrich media metadata
• update_metadata.py - Update existing metadata
• import_olympics_data.py - Import Olympics data
• cleanup_placeholders.py - Clean up placeholder entries

Plex Integration

• discover_plex.py - Discover Plex servers
• get_plex_token.py - Get Plex authentication token
• test_plex_connection.py - Test Plex connectivity

Utilities

• health_check.py - System health check
• hardware_detection.py - Detect hardware capabilities
• test_logging.py - Test logging system
• test_connectivity.py - Test network connectivity
• auto_heal.py - Auto-healing system
• add_playout_mode_migration.py - Database migration

Usage Examples

Create a Channel

# Using shell script (requires API server)
./scripts/create_channel.sh --year 1980

# Using Python script (direct database)
python3 scripts/create_channel.py --year 1980

Parse Archive.org Collection

# Interactive GUI (recommended)
./scripts/archive_collection_parser_dialog.sh

# Command-line
python3 scripts/archive_collection_parser.py "https://archive.org/details/..."

View Logs

# Live view
./scripts/view-logs.sh

# Search for errors
./scripts/view-logs.sh search ERROR

Import Channels

python3 scripts/import_channels.py data/channels.yaml

Related Pages

• Home
• Archive Parser
• Logging
• Plex Integration