Add initial project files for Jellyfin-Plex Library Checker
- Create .editorconfig for consistent coding styles. - Add .envrc for direnv integration. - Include .gitignore to exclude environment and build files. - Implement compare_movies.py and analyze_movies.py for movie library comparison and analysis. - Implement compare_series.py and analyze_series.py for TV series library comparison and analysis. - Add configuration example in config.example.txt. - Create README.md with project overview, setup instructions, and usage examples. - Add LICENSE file for MIT License. - Include flake.nix and flake.lock for Nix-based development environment. - Add USAGE.md for quick start guide and common commands.
This commit is contained in:
67
USAGE.md
Normal file
67
USAGE.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Quick Start Guide
|
||||
|
||||
## First Time Setup
|
||||
|
||||
1. **Configure your environment:**
|
||||
```bash
|
||||
cp config.example.txt .env
|
||||
# Edit .env with your actual credentials and paths
|
||||
```
|
||||
|
||||
2. **Enter development environment (Nix users):**
|
||||
```bash
|
||||
nix develop
|
||||
```
|
||||
|
||||
**Or install dependencies (pip users):**
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
## Quick Commands
|
||||
|
||||
### Movies
|
||||
```bash
|
||||
# Compare movie libraries
|
||||
python compare_movies.py
|
||||
|
||||
# Analyze what's missing
|
||||
python analyze_movies.py
|
||||
```
|
||||
|
||||
### TV Series
|
||||
```bash
|
||||
# Compare series libraries
|
||||
python compare_series.py
|
||||
|
||||
# Analyze what's missing
|
||||
python analyze_series.py
|
||||
```
|
||||
|
||||
## With Nix Flakes
|
||||
```bash
|
||||
nix run .#compare-movies
|
||||
nix run .#analyze-movies
|
||||
nix run .#compare-series
|
||||
nix run .#analyze-series
|
||||
```
|
||||
|
||||
## Output Files
|
||||
|
||||
- `movies_comparison_report.json` - Detailed movie data
|
||||
- `series_comparison_report.json` - Detailed series data
|
||||
|
||||
## First Steps After Running
|
||||
|
||||
1. Check for `.plexignore` files (the scripts will warn you)
|
||||
2. Review the analysis output for patterns
|
||||
3. Force a Plex library scan if needed
|
||||
4. Check Plex logs for scanner errors
|
||||
|
||||
## Common Fixes
|
||||
|
||||
- **Movies in `.plexignore`** → Remove entries, rescan Plex
|
||||
- **Empty series directories** → Plex correctly ignores these
|
||||
- **Old codecs (mpeg4, mpeg2)** → Re-encode or replace files
|
||||
- **Low resolution** → Replace with HD versions
|
||||
- **Title mismatches** → These are actually in Plex, just different names
|
||||
Reference in New Issue
Block a user