dopplerr 0.6.4
Subtitle Download Web Service for Sonarr

Dopplerr Subtitle Downloader
============================

|Build Status| |Docker Automated buil| |Pypi package| |PyPI| |Coverage
Status| |Discord| |Feature Requests| |MIT licensed|

Subtitle Download Web Service for Sonarr or Radarr. It uses
`Subliminal <https://github.com/Diaoul/subliminal>`__ to search
automatically for missing subtitles on download notification.

-  Free software: MIT
-  Source: https://github.com/Stibbons/dopplerr
-  Python 3.
-  Docker image based on Alpine Linux and S6-Overlay (based on
   `Linuxserver <https://www.linuxserver.io/>`__'s images)

Limitations
===========

-  only Sonarr Download notification
-  video filename should not have been renamed (which helps finding the
   right subtitle)
-  all series should be on the same root directory
-  series folder should be as ``Series Name (1900)``

Support and Feature Requests
============================

Do NOT open issue for feature requests, please vote on
`FeatHub <http://feathub.com/Stibbons/dopplerr>`__.

For support, please use our
`Discord <https://discordapp.com/channels/378849537520959510/378849838751678465>`__.

Usage
=====

The best usage is through the docker image.

Installation with Docker
------------------------

Use my docker image:

::

    docker create \
        --name dopplerr \
        -p 8086:8086 \
        -e PUID=<UID> \
        -e PGID=<GID> \
        -e TZ=<timezone> \
        -v /etc/localtime:/etc/localtime:ro \
        -v <path/to/animes>:/animes \
        -v <path/to/movies>:/movies \
        -v <path/to/series>:/tv \
        -e DOPPLERR_SUBLIMINAL_LANGUAGES="fra,eng" \
        -e DOPPLERR_MAPPING="tv=tv,movies=movies,animes=animes" \
        stibbons31/dopplerr

Mount your media directories in ``/``. Typically, ``/animes`` and
``/tv`` are from Sonarr, and ``/movies`` from Radarr.

It is a good practice to run Sonarr and Radarr in their own container,
so they also "see" their media in path such as ``/tv``, ``/movies``,
``/animes``. Mount these volume with the same name in the ``dopplerr``
container.

``DOPPLERR_MAPPING`` is used to list all interesting folders in media
base directory (which is ``/`` by default if
``DOPPLERR_GENERAL_BASEDIR`` is not set), so please define it even if
all directory mappings are trivial:
``tv=tv,movies=movies,animes=animes``.

``DOPPLERR_MAPPING`` can allows developers to run dopplerr directly from
their PC and allow a different naming conventions (for instance,
``/path/to/Movies`` is where the movies are stored, but in all
containers (Radarr, Dopplerr) they are mounted as ``/movies``).

Parameters
~~~~~~~~~~

The parameters are split into two halves, separated by a colon, the left
hand side representing the host and the right the container side. For
example with a port -p external:internal - what this shows is the port
mapping from internal to external of the container. So, ``-p 8080:80``
would expose port 80 from inside the container to be accessible from the
host's IP on port 8080 (Ex: ``http://192.168.x.x:8080``).

Example of starting command line arguments:

-  ``-p 8086:8086`` - the port webinterface
-  ``-v /path/to/anime:/anime`` - location of Anime library on disk
-  ``-v /path/to/movies:/movies`` - location of Movies library on disk
-  ``-v /path/to/series:/tv`` - location of TV library on disk
-  ``-e PGID=1000`` - for GroupID. See below for explanation
-  ``-e PUID=100`` - for UserID. See below for explanation
-  ``-v /etc/localtime`` - for timezone information - see Localtime for
   important information
-  ``-e TZ``- for timezone information, Europe/London - see Localtime
   for important information
-  ``-e DOPPLERR_SUBLIMINAL_LANGUAGES=fra,eng`` - set wanted subtitles
   languages (mandatory)
-  ``-e DOPPLERR_GENERAL_VERBOSE=1`` - set verbosity. 1=verbose,
   0=silent (optional)

Developers might also use:

-  ``-e DOPPLERR_GENERAL_BASEDIR=/media`` - set media base directory
   (optional) (needs something like ``-v /path/to/anime:/media/anime``
   and so on)

Localtime
~~~~~~~~~

It is important that you either set
``-v /etc/localtime:/etc/localtime:ro`` or the TZ variable to enable
scheduled tasks.

Example:

::

    -e TZ=Europe/Paris

User / Group Identifiers
~~~~~~~~~~~~~~~~~~~~~~~~

Sometimes when using data volumes (-v flags) permissions issues can
arise between the host OS and the container. We avoid this issue by
allowing you to specify the user PUID and group PGID. Ensure the data
volume directory on the host is owned by the same user you specify and
it will "just work" (TM).

In this instance PUID=1001 and PGID=1001. To find yours use id user as
below:

::

    $ id <dockeruser>
    uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)

Wanted subtitle languages
~~~~~~~~~~~~~~~~~~~~~~~~~

Use a comma-separated list of 3-letter language descriptors you want
Subliminal to try to download them.

Example:

::

    DOPPLERR_SUBLIMINAL_LANGUAGES=fra,eng

Descriptors are ISO-639-3 names of the language. See the `official
Babelfish
table <https://github.com/Diaoul/babelfish/blob/f403000dd63092cfaaae80be9f309fd85c7f20c9/babelfish/data/iso-639-3.tab>`__
to find your prefered languages.

Pipy Installation
-----------------

Create a dedicated virtual environment and install it properly with the
following commands:

::

    $ pip3 install dopplerr

**Note:** One should NEVER install a Python application directly in your
system using ``sudo pip3 install ...``. You do not want to mess your
startup scripts or any other python application that came well packaged
by the maintainers of your distribution.

Always use a Virtualenv. To install an application system-wide, use your
distribution's packet manager (``apt`` / ``yum`` / ...).

If you do not have this option, install a Python package user-wide
(``pip3 install --user``).

**Other Note**: while using ``pip``/``pip3`` to install from pre-built
packages ("distribution packages") from Pypi is the official method,
please note this project uses ``pipenv`` for development, and uses a
``Pipfile`` as primary source of dependencies definition.
``requirements.txt`` file is automatically generated on change so
installing through ``pip3`` from the GitHub source should work even if
it not the official installation method:

::

    pip3 install --user git+http://github.com/Stibbons/dopplerr#egg=dopplerr

Be aware with this command you retrieve the latest code, which may be
broken.

Radarr/Sonarr Configuration
===========================

Go in Settings to configure a "Connect" WebHook:

-  Settings > Connect > add WebHook notification
-  Select **On Download** and **On Upgrade**
-  URL: ``http://<ip address>:8086/api/v1/notify/sonarr``

   or

   URL: ``http://<ip address>:8086/api/v1/notify/radarr``
-  Method: POST

Two READMEs ?
=============

There is a little trick to know about READMEs:

-  Docker Hub does not render README written in restructuredText
   correctly
-  Pypi does not render README written in Markdown correctly

So, a restructuredText version of the README is created from
``README.md`` on upload to Pypi. Simple. So, when updating
``README.md``, do not forget to regenerate ``README.rst`` using
``make readme``.

Contributing
============

Check out the source code

::

    git clone

Install requirement system-level dependencies with (or adapt
accordingly):

::

    $ sudo ./bootstrap-system.sh

System dependencies:

-  ``git``
-  ``make``
-  ``pandoc``
-  ``pip``
-  ``pipenv``

This project uses ``pipenv`` to jump seamlessly into a virtualenv.

Setup your development environment with:

::

    $ make dev

Unit Tests with:

::

    $ make test-unit

or run it live with

::

    $ make run-local

Activate the environment (to start your editor from, for example):

::

    $ make shell

Publishing new version
======================

Please note that much part is automatized, for example the publication
to Pypi is done automatically by Travis on successful tag build)

Test building Wheel package with:

::

    $ make release wheels

Create a release: create a tag with a Semver syntax.

::

    $ # ensure everything is committed
    $ git tag 1.2.3
    $ make release
    $ git push --tags

Optionally you can tag code locally and push to GitHub. ``make release``
is also executed during the Travis build, so if there is any files
changed during the build (ex: ``README.rst``), it will be automatically
done and so the Pypi package will be coherent. Do not retag if the
README has been updated on GitHub, it has been properly done in the
Wheel/Source Packages on Pypi. So, no stress.

On successful travis build on the Tag, your Pypi package will be
automatically updated.

Same, on Tag, a Docker tag is also automatically created.

Note:

    According to PBR, alpha versions are to be noted ``x.y.z.a1``

.. |Build Status| image:: https://travis-ci.org/Stibbons/dopplerr.svg?branch=master
   :target: https://travis-ci.org/Stibbons/dopplerr
.. |Docker Automated buil| image:: https://img.shields.io/docker/build/stibbons31/dopplerr.svg
   :target: https://hub.docker.com/r/stibbons31/dopplerr/builds/
.. |Pypi package| image:: https://badge.fury.io/py/dopplerr.svg
   :target: https://pypi.python.org/pypi/dopplerr/
.. |PyPI| image:: https://img.shields.io/pypi/pyversions/dopplerr.svg
   :target: https://pypi.python.org/pypi/dopplerr/
.. |Coverage Status| image:: https://coveralls.io/repos/github/Stibbons/dopplerr/badge.svg?branch=master
   :target: https://coveralls.io/github/Stibbons/dopplerr?branch=master
.. |Discord| image:: https://img.shields.io/discord/378849537520959510.svg
   :target: https://discordapp.com/channels/378849537520959510/378849838751678465
.. |Feature Requests| image:: http://feathub.com/Stibbons/dopplerr?format=svg
   :target: http://feathub.com/Stibbons/dopplerr
.. |MIT licensed| image:: https://img.shields.io/badge/license-MIT-blue.svg
   :target: ./LICENSE