Metadata-Version: 2.4
Name: yt-scanner
Version: 0.1.3
Summary: Python script to scan YouTube channel playlists and detect unlisted videos
Author-email: Thomas Lamarche <thomas.lamarche17@gmail.com>
Maintainer-email: Thomas Lamarche <thomas.lamarche17@gmail.com>
License-Expression: MIT
Project-URL: Homepage, https://github.com/OloZ17/yt-channel-scanner
Project-URL: Repository, https://github.com/OloZ17/yt-channel-scanner
Project-URL: Issues, https://github.com/OloZ17/yt-channel-scanner/issues
Keywords: youtube,scanner,unlisted,videos,playlist,yt-dlp
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Multimedia :: Video
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: yt-dlp>=2023.0.0
Provides-Extra: dev
Requires-Dist: pytest>=7.0.0; extra == "dev"
Requires-Dist: pytest-cov>=4.0.0; extra == "dev"
Dynamic: license-file

# YouTube Channel Scanner

<p align="left">
  <img src="yt-scanner.png" alt="YT Scanner" width="120">
</p>

[![PyPI version](https://badge.fury.io/py/yt-scanner.svg)](https://badge.fury.io/py/yt-scanner)
[![Python Versions](https://img.shields.io/pypi/pyversions/yt-scanner.svg)](https://pypi.org/project/yt-scanner/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

Python script to scan YouTube channel playlists and detect **unlisted** videos.

## Description

This script analyzes a YouTube channel by:

1. Retrieving all public videos from the channel
2. Listing all public playlists
3. Extracting videos from each playlist
4. Comparing both lists to identify videos present in playlists but missing from public videos (= potentially unlisted)

## Installation

### Requirements

- Python 3.7+
- yt-dlp

### Installing yt-dlp

```bash
pip install yt-dlp
```

Or with pipx:

```bash
pipx install yt-dlp
```

## Usage

### Basic command

```bash
python youtube_scanner.py "https://www.youtube.com/@ChannelName"
```

### Available options

| Option             | Description                                                                              |
| ------------------ | ---------------------------------------------------------------------------------------- |
| `-o`, `--output`   | Output JSON filename (default: `youtube_scan_YYYY-MM-DD_HHMMSS.json`)                    |
| `--playlists-only` | Scan playlists only (faster). Identifies unlisted videos by their availability status    |
| `--detailed`       | Re-fetch metadata for potentially unlisted videos to ensure accuracy                     |

### Examples

**Full scan:**

```bash
python youtube_scanner.py "https://www.youtube.com/@IronKingLoL"
```

**Quick scan (playlists only):**

```bash
python youtube_scanner.py "https://www.youtube.com/@IronKingLoL" --playlists-only
```

**With accurate dates (slower):**

```bash
python youtube_scanner.py "@IronKingLoL" --detailed
```

**With custom filename:**

```bash
python youtube_scanner.py "https://www.youtube.com/@IronKingLoL" -o ironking_scan.json
```

### Supported URL formats

- `https://www.youtube.com/@username`
- `https://www.youtube.com/c/ChannelName`
- `https://www.youtube.com/channel/UCxxxxx`

## Output files

The script generates two files:

### 1. JSON file (`youtube_scan_YYYY-MM-DD_HHMMSS.json`)

Contains all structured data:

```json
{
  "channel_url": "https://www.youtube.com/@example",
  "scan_date": "2025-11-29T14:30:52.123456",
  "public_videos": [],
  "playlist_videos": [],
  "playlists": [],
  "potentially_unlisted": [
    {
      "id": "dQw4w9WgXcQ",
      "title": "Video title",
      "url": "https://www.youtube.com/watch?v=dQw4w9WgXcQ",
      "availability": "unlisted",
      "upload_date": "2024-03-15",
      "found_in_playlist": "Playlist name"
    }
  ]
}
```

### 2. Text file (`youtube_scan_YYYY-MM-DD_HHMMSS_links.txt`)

Simple list of links with dates:

```
# Potentially unlisted videos

[2025-03-16] https://www.youtube.com/watch?v=xxxxx - Video title
[2025-02-11] https://www.youtube.com/watch?v=yyyyy - Another video

# All playlist videos

[2025-03-16] https://www.youtube.com/watch?v=xxxxx - Video title
...
```

## How it works

**Unlisted** videos on YouTube:

- Are not visible on the channel page
- Are not indexed by YouTube search
- **But** can be added to public playlists

The script uses two detection methods:

1. **Full scan mode** (default): Compares videos in playlists with public channel videos. If a video is in a playlist but not in public videos, it's likely unlisted.

2. **Playlists-only mode** (`--playlists-only`): Identifies videos directly by their availability status (unlisted/private) reported by yt-dlp.

## Limitations

- **Private videos**: Cannot be played without permission, but can be detected in playlists if their status is visible
- **Private playlists**: Not scanned
- **Possible false positives**: A video can be in a playlist without belonging to the channel
- **Deleted videos**: Sometimes appear in playlists but are no longer accessible
- **Rate limiting**: YouTube may throttle requests if too frequent
- **Performance**: The script fetches full video metadata to provide accurate dates and availability. For very large channels with many playlists, this may take some time

## Troubleshooting

### "yt-dlp is not installed"

```bash
pip install yt-dlp
```

### Timeout on large channels

The script has a 5-minute timeout per command. For very large channels, use `--playlists-only` to reduce scan time.

### No unlisted videos found

This is normal if:

- The channel has no unlisted videos in its playlists
- All playlists are private
- The channel has no playlists

## Author

**Thomas Lamarche** - _Initial work_ - [OloZ17](https://github.com/OloZ17)

## License

MIT License - Free to use and modify.

## Contributing

Contributions are welcome! Feel free to open an issue or pull request.
