addic7ed-cli

============
addic7ed-cli
============

This is a little command-line utility to fetch subtitles from addic7ed.

.. image:: https://travis-ci.org/BenoitZugmeyer/addic7ed-cli.svg?branch=master
    :target: https://travis-ci.org/BenoitZugmeyer/addic7ed-cli

Install
=======

From pypi
---------

Install latest stable version with::

    $ pip install addic7ed-cli

Use :code:`--upgrade` to upgrade.

Latest
------

Install latest development version with::

    $ pip install https://github.com/BenoitZugmeyer/addic7ed-cli/archive/master.zip

ArchLinux
---------

An `AUR package`_ is waiting for you.

Nix/NixOS
---------

addic7ed-cli is available from nixpkgs unstable channel::

    $ nix-env -iA nixpkgs.pythonPackages.addic7ed-cli

Usage
=====

Example, if you speak french and english::

    $ addic7ed -l french -l english The.Serie.S02E23.MDR.mkv


Help::

    $ addic7ed --help


Authentification
================

You can login with your addic7ed.com identifiers to increase your daily
download quota:

* Anonymous users are limited to 15 downloads per 24 hours on their IP
  address

* Registered users are limited to 40

* VIPs get 80 downloads (please consider donating)

Configuration file
==================

You can store frequently used options in a configuration file. Create a
file at :code:`~/.config/addic7ed` (Linux, OSX) or
:code:`%APPDATA%/Addic7ed Configuration.txt` (Windows), and it will be
parsed using the Python ConfigParser (see example below). Hint: use the
:code:`--verbose` argument to print the full path of the configuration
file when running a command. It can contain three sections:

* [flags], to set a flag (verbose, hearing-impaired, overwrite, ignore,
  batch or brute-batch, see :code:`addic7ed search --help` for
  informations about those flags)

* [languages], to list prefered languages

* [session], the session to use for authentification (this is automatically
  populated when using :code:`addic7ed login`)

Example::

    [flags]
    hearing-impaired = no
    batch

    [languages]
    french
    english

    [session]
    abcdef

Video organizer
===============

video-organizer_ format is supported. If a "filelist" file is next to an
episode, it will use it to extract its real name and forge the good
query.

.. _aur package: https://aur.archlinux.org/packages/addic7ed-cli
.. _video-organizer: https://github.com/JoelSjogren/video-organizer