Metadata-Version: 2.4
Name: riplex
Version: 0.9.5
Summary: Automates the tedious manual work around MakeMKV: figuring out what to rip, which MKV files are actually what, and organizing everything into Plex-compatible folder structures.
License: MIT
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: certifi>=2024.2.2
Requires-Dist: httpx>=0.27
Requires-Dist: dvdcompare-scraper>=0.1.15
Requires-Dist: platformdirs>=4.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.23; extra == "dev"
Requires-Dist: respx>=0.21; extra == "dev"
Provides-Extra: gui
Requires-Dist: flet==0.85.1; extra == "gui"
Dynamic: license-file

# riplex

Automatically organizes MKV files from physical disc collections into Plex-compatible folder structures with the right names, the right folders, and no manual work.

riplex includes both a desktop app for guided ripping and a full CLI for terminal-first and automated workflows.

<p align="center">
	<img src="screenshots/0_Rip_Flow_BTTF.gif" alt="Rip flow demo" width="800">
</p>

## Why?

After using MakeMKV to back up a disc, you're left with a pile of generically-named files (`title_t00.mkv`, `title_t01.mkv`, ...) and no idea which is the main film, which are featurettes, which are duplicates, and which is the play-all compilation you didn't need. For a multi-disc TV series, you're looking at hours of manual effort: reading disc cases, Googling runtimes, renaming files one by one, and building the exact folder hierarchy Plex demands.

riplex solves this by pulling metadata from TMDb (canonical titles, years, episode info) and [dvdcompare.net](https://www.dvdcompare.net) (per-disc content breakdowns including featurettes, deleted scenes, runtimes), then automatically classifying, deduplicating, matching, renaming, and organizing everything into the correct Plex structure.

## Get started

Start with the [Getting Started guide](docs/getting-started/installation.md). It covers all three install paths:

- **Pre-built app**: fastest way to try riplex. Download links and platform-specific notes are in the [installation guide](docs/getting-started/installation.md#option-a-pre-built-executables).
- **pipx**: recommended if you have Python or do not mind installing it. See [Option B](docs/getting-started/installation.md#option-b-install-with-pipx-recommended).
- **From source**: for developers and unsupported binary platforms. See [Option C](docs/getting-started/installation.md#option-c-install-from-source).

If you just want the desktop app right now, the latest binaries are on the [Releases page](https://github.com/AnyCredit5518/riplex/releases/latest). For the guided desktop flow after install, see the [GUI Walkthrough](docs/gui-guide/gui-walkthrough.md).

If you prefer the command line, riplex also ships a full CLI with `lookup`, `rip`, `organize`, and `orchestrate` workflows. For the end-to-end terminal flow, see the [CLI Workflow guide](docs/cli-guide/workflow.md).

After installing:

1. Run setup. The GUI walks you through it on first launch, or you can use [`riplex setup`](docs/getting-started/installation.md#setup).
2. If you want to see the GUI step by step, read the [GUI Walkthrough](docs/gui-guide/gui-walkthrough.md).
3. Follow the [CLI Workflow guide](docs/cli-guide/workflow.md) for the end-to-end flow.
4. If you prefer the terminal, use the [CLI reference](docs/reference/cli.md) for command details.

## What it looks like

Instead of leaving you to sort through a wall of raw MakeMKV titles, riplex helps you understand what is actually on the disc and choose the titles worth ripping. It surfaces likely matches, highlights junk and duplicates, and helps you avoid play-all traps.

![Title selection](screenshots/5_Select_Title_to_RIP_BTTF.png)

More screenshots:
[welcome](screenshots/1_Welcome_Screen.png),
[disc detection](screenshots/2_Disc_Detection_BTTF.png),
[metadata lookup](screenshots/3_Metadata_Lookup_BTTF.png),
[release picker](screenshots/4_Disc_Release_BTTF.png),
[disc overview](screenshots/5_Multi_Disc_Overview_BTTF.png).

> [!NOTE]
> riplex currently handles one film (or one TV show) per session. Multi-film box sets that bundle separate films onto separate discs (e.g. a trilogy in one box) need to be ripped one film at a time.

## Requirements

riplex uses MakeMKV, ffmpeg, and MKVToolNix under the hood. The setup wizard installs them for you on Windows (winget), macOS (Homebrew), and Debian/Ubuntu Linux (apt). On other platforms see [the installation guide](docs/getting-started/installation.md).

You'll also need a free [TMDb API key](https://www.themoviedb.org/settings/api). The wizard prompts you for it.

## Data sources

- **[TMDb](https://www.themoviedb.org/)**: canonical movie and TV metadata (titles, years, episodes, runtimes)
- **[dvdcompare.net](https://www.dvdcompare.net)**: per-disc content breakdowns (featurettes, deleted scenes, play-all groupings, runtimes). An invaluable community resource.

## Related projects

- **[dvdcompare-scraper](https://github.com/AnyCredit5518/dvdcompare-scraper)**: Python client for dvdcompare.net. Powers riplex's disc lookup. Contributions welcome.

## Documentation

- [Getting started](docs/getting-started/installation.md): installation, configuration
- [GUI walkthrough](docs/gui-guide/gui-walkthrough.md): the main desktop flow, screen by screen
- [CLI workflow](docs/cli-guide/workflow.md): end-to-end terminal workflows
- [CLI reference](docs/reference/cli.md): every command and flag
- [Architecture](docs/architecture.md): design, data flow, project structure

## License

MIT
