Welcome to subliminal!
**********************

Subliminal is a python 2.7+ library to search and download subtitles.
It comes with an easy to use yet powerful CLI (command-line interface)
suitable for direct use or cron jobs.


Documentation
=============

* Usage

  * CLI

  * Nautilus/Nemo integration

  * High level API

* How it works

  * Providers

  * Scoring

  * Libraries

* CLI

  * subliminal

  * subliminal download

  * subliminal cache

* Provider Guide

  * Requirements

  * Video Validation

  * Configuration

  * Initialization / Termination

  * Caching policy

  * Language

  * Querying

  * Subtitle

  * Score computation

  * Unittesting


API Documentation
=================

If you are looking for information on a specific function, class or
method, this part of the documentation is for you.

* Core

* Video

* Subtitle

* Providers

* Refiners

* Extensions

* Score

* Utils

* Cache

* CLI

* Exceptions


License
=======

MIT


Indices and tables
******************

* Index

* Module Index

* Search Page
