Skip to main content

Cross-platform AnimePahe assistant for search, browser download handoff, smart tracking, sorting, streaming, filters, and record management

Project description

PyPI version License Windows macOS Linux

AutoPahe

Search AnimePahe, prepare browser downloads, stream, and track episodes

Search AnimePahe, prepare browser-based episode downloads, stream where available, and manage records. Cross-platform (Windows, Mac, Linux).

🚀 Installation

With uv (recommended):

uv tool install autopahe
autopahe --setup

--setup writes the default config and installs Playwright's bundled Chromium engine in the same environment AutoPahe uses.

From source:

git clone https://github.com/haxsysgit/autopahe.git
cd autopahe
uv sync
uv run playwright install chromium
uv run autopahe --help

Update an existing install:

uv tool upgrade autopahe

For source installs, run:

git pull --ff-only
uv sync
uv run playwright install chromium

autopahe --update is also available as a convenience command. For source checkouts, it safely runs a fast-forward git update and refreshes dependencies. For uv tool installs, prefer uv tool upgrade autopahe.

With Docker:

git clone https://github.com/haxsysgit/autopahe.git
cd autopahe
docker build -t autopahe:latest .
docker run -it --rm \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/json_data:/app/json_data \
  -v $(pwd)/collection:/app/collection \
  autopahe:latest --help

See the docker/ directory for helper scripts and detailed documentation.

Or use the helper script:

Linux/Mac:

docker/docker-run.sh build
docker/docker-run.sh run --help

Windows PowerShell:

docker\docker-run.ps1 build
docker\docker-run.ps1 run --help

Windows Command Prompt:

docker\docker-run.bat build
docker\docker-run.bat run --help

📖 Usage

# Search for anime
autopahe -s "anime name"

# Prepare browser download for episode 1
autopahe -s "anime name" -i 0 -d 1

# Prepare browser downloads for episodes 1-12
autopahe -s "anime name" -i 0 -md 1-12

# Stream episode 1
autopahe -s "anime name" -i 0 -st 1

Core Command Examples

Search + Select

# Basic search
autopahe -s "one piece"

# Search with filters
autopahe -s "naruto" --year 2002 --status "Finished Airing"

# Exact match only (disable fuzzy search)
autopahe -s "jujutsu kaisen" --no-fuzzy

Browser Downloads

# Single episode: prints the browser link, then verifies the downloaded file
autopahe -s "demon slayer" -i 0 -d 1

# Range and list formats
autopahe -s "bleach" -i 0 -md 1-12
autopahe -s "bleach" -i 0 -md "1,3,5-7"

# Whole season shortcut (12 eps per season)
autopahe -s "attack on titan" -i 0 --season 1

Kwik requires a regular browser for downloads. -d and -md guide you through opening the generated link and only mark an episode downloaded after a local video file is verified. Use -l when you only want the link without record updates.

If a site asks for browser verification, you can complete it in AutoPahe's persistent browser profile:

autopahe --verify-browser https://kwik.cx

This does not bypass verification. It opens a normal browser session and saves the user-verified profile for later AutoPahe browser work when the site keeps that session valid.

Streaming

# Single episode
autopahe -s "spy x family" -i 0 -st 1

# Multi-episode streaming
autopahe -s "spy x family" -i 0 -st "1-5"

# Streaming quality and player
autopahe -s "spy x family" -i 0 -st 1 -p 1080 --player vlc

Sorting & Organizing

# Dry-run organize to see changes first
autopahe --sort organize --sort-dry-run

# Rename files in place
autopahe --sort rename

# Full sort (rename + organize) for a specific path
autopahe --sort all --sort-path "/path/to/Downloads"

More Options

# Different quality (360, 480, 720, 1080)
autopahe -s "anime name" -i 0 -d 1 -p 1080

# Parallel downloads
autopahe -s "anime name" -i 0 -md 1-12 --workers 3

# English dub (if available)
autopahe -s "anime name" -i 0 -d 1 --dub

# Stream with specific player
autopahe -s "anime name" -i 0 -st 1 --player vlc

# Cache management
autopahe --cache stats
autopahe --cache clear

# Resume interrupted downloads
autopahe --resume
autopahe --resume-stats

⚙️ Configuration

# Edit config
autopahe config edit

# Show config
autopahe config show

# Validate config
autopahe config validate

Config location:

  • Windows: %APPDATA%\autopahe\config.ini
  • Linux/Mac: ~/.config/autopahe/config.ini

🐳 Docker Usage

Quick Start

Linux/Mac:

# Build and run with helper script
docker/docker-run.sh build
docker/docker-run.sh run --help

# Search for anime (no need to escape quotes!)
docker/docker-run.sh run search one piece
docker/docker-run.sh run -s one piece -i 0 -d 1

# Download episodes
docker/docker-run.sh run -s "one piece" -i 0 -md 1-5

Windows PowerShell:

# Build and run with helper script
docker\docker-run.ps1 build
docker\docker-run.ps1 run --help

# Search for anime (no need to escape quotes!)
docker\docker-run.ps1 run search one piece
docker\docker-run.ps1 run -s one piece -i 0 -d 1

# Download episodes
docker\docker-run.ps1 run -s "one piece" -i 0 -md 1-5

Windows Command Prompt:

# Build and run with helper script
docker\docker-run.bat build
docker\docker-run.bat run --help

# Search for anime (use quotes for spaces)
docker\docker-run.bat run search "one piece"
docker\docker-run.bat run -s "one piece" -i 0 -d 1

# Download episodes
docker\docker-run.bat run -s "one piece" -i 0 -md 1-5

Docker Commands

Linux/Mac:

# Build image
docker build -t autopahe:latest .

# Run with volume mounts
docker run -it --rm \
  -v $(pwd)/data:/app/data \
  -v $(pwd)/json_data:/app/json_data \
  -v $(pwd)/collection:/app/collection \
  autopahe:latest [command]

# Use docker-compose
docker-compose run --rm autopahe --help

# Open shell in container
docker/docker-run.sh shell

Windows PowerShell:

# Build image
docker build -t autopahe:latest .

# Run with volume mounts
docker run -it --rm `
  -v "${pwd}\data:/app/data" `
  -v "${pwd}\json_data:/app/json_data" `
  -v "${pwd}\collection:/app/collection" `
  autopahe:latest [command]

# Use docker-compose
docker-compose run --rm autopahe --help

# Open shell in container
docker\docker-run.ps1 shell

Windows Command Prompt:

# Build image
docker build -t autopahe:latest .

# Run with volume mounts
docker run -it --rm ^
  -v "%cd%\data:/app/data" ^
  -v "%cd%\json_data:/app/json_data" ^
  -v "%cd%\collection:/app/collection" ^
  autopahe:latest [command]

# Use docker-compose
docker-compose run --rm autopahe --help

# Open shell in container
docker\docker-run.bat shell

Volume Mounts

  • ./data - Download storage
  • ./json_data - Cache and metadata
  • ./collection - Your anime collection

Additional Documentation

  • See docker/docker-test.md for testing guide
  • See docker/docker-test-windows.md for Windows-specific testing
  • See docker/README.md for helper script documentation
  • See docker/downloads-guide.md for complete downloads guide

Script Features

  • Input Sanitization: No need to manually escape quotes in most cases
  • Auto Directory Creation: Scripts create necessary data directories
  • Cross-Platform: Separate scripts for Linux/Mac, PowerShell, and CMD
  • Clean Command: Easy Docker resource cleanup with clean option

📚 Collection Management

# View collection stats
autopahe --collection stats

# Organize downloaded files
autopahe --collection organize

# Find duplicates
autopahe --collection duplicates

🎬 Supported Players

VLC, MPV, MPC-HC, MPC-BE (Windows), Iina (macOS), SMPlayer, Celluloid (Linux)

📜 License

MIT License - see LICENSE

🆘 Help

GitHub Issues | Discussions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

autopahe-3.6.1.tar.gz (83.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

autopahe-3.6.1-py3-none-any.whl (87.2 kB view details)

Uploaded Python 3

File details

Details for the file autopahe-3.6.1.tar.gz.

File metadata

  • Download URL: autopahe-3.6.1.tar.gz
  • Upload date:
  • Size: 83.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for autopahe-3.6.1.tar.gz
Algorithm Hash digest
SHA256 42df67a59f95096f7fc525f72446eed55251f57273bfcb58d8fbcb9fac87bdaa
MD5 652f3ba8331e9be5001993bea5247060
BLAKE2b-256 1b42ac68aacf2259bebbba6ab524e21c0ffde7787d055dd18fbc5c2c97f14c60

See more details on using hashes here.

File details

Details for the file autopahe-3.6.1-py3-none-any.whl.

File metadata

  • Download URL: autopahe-3.6.1-py3-none-any.whl
  • Upload date:
  • Size: 87.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.4

File hashes

Hashes for autopahe-3.6.1-py3-none-any.whl
Algorithm Hash digest
SHA256 d840de0545d35ba22872bf7867049d5de4e5087d40f225aad3e639b5ddc3856f
MD5 33d68bd4e33cba56583bb1184a13bba3
BLAKE2b-256 7ad7afa0015154e2d5f5b386b9faeae85120ff4fc1a5ae73efff147a26b96c11

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page