Metadata-Version: 1.1
Name: dopplerr
Version: 0.2.9
Summary: Subtitle Download Web Service for Sonarr
Home-page: https://github.com/Stibbons/dopplerr
Author: Gaetan Semet
Author-email: gaetan@xeberon.net
License: UNKNOWN
Description-Content-Type: UNKNOWN
Description: Subtitle Downloader Service
        ===========================
        
        |Build Status| |Docker Automated buil| |Pyup| |Coveralls| |Pypi package|
        |PyPI| |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. Python 2 is tested by Travis but local installation is not
           provided.
        -  Docker image based on Alpine Linux and S6-Overlay is provided (based
           on Linuxserver's images)
        
        Usage
        -----
        
        The best usage is through the docker image.
        
        Use with Docker
        ~~~~~~~~~~~~~~~
        
        Use my docker image:
        
        ::
        
            docker create \
                --name dopplerr \
                -p 8000:8000 \
                -e PUID=<UID> \
                -e PGID=<GID> \
                -v <path/to/animes>:/animes \
                -v <path/to/movies>:/movies \
                -v <path/to/tvseries>:/tv \
                stibbons31/dopplerr
        
        Mount your media directory in ``/media``. This directory exists in the
        docker image, so if you have several media directory (``/series``,
        ``/tv``, ``/animes``), mount them all in ``/media`` and set the
        following environment variable: ``SUBDLSRC_BASEDIR=/media``.
        
        It is a good practive to run Sonarr and Radarr in their own container,
        so they also "see" their media in path such as ``/series``, ``/tv``,
        ``/animes``. Mount these volume with the same name in the dopplerr
        container. They will all communicate with the same path.
        
        Base directory (``SUBDLSRC_BASEDIR`` environment variable) can be used
        to put all these folder in same directory. If ``SUBDLSRC_BASEDIR`` is
        not defined, dopplerr will assume the path communicated by Sonarr or
        Radarr also exists locally. So mouth your series folder to ``/series``,
        TV show folder to ``/tv``, and animes to ``/animes`` and so on.
        
        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 http://192.168.x.x:8080 would show you what's
        running INSIDE the container on port 80.
        
        -  ``-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/tv:/tv`` - location of TV library on disk
        -  ``-e PGID=1000`` - for for GroupID. See below for explanation
        -  ``-e PUID=100`` - for for UserID. See below for explanation
        -  ``-e SUBDLSRC_LANGUAGES=fra,eng`` - set wanted subtitles languages
           (mandatory)
        -  ``-e SUBDLSRC_BASEDIR=/app`` - set media base directory (optional)
        -  ``-e SUBDLSRC_VERBOSE=1`` - set verbosity. 1=verbose, 0=silent
           (optional)
        
        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:
        
        ::
        
            SUBDLSRC_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.
        
        Local installation:
        ~~~~~~~~~~~~~~~~~~~
        
        Create a dedicated virtual environment and install it properly with the
        following commands:
        
        ::
        
            sudo ./bootstrap-system.sh
            make install-local
        
        This will install dopplerr in a local virtual environment will all its
        dependencies without messing with your system's Python environment.
        
        Installing in your system
        ~~~~~~~~~~~~~~~~~~~~~~~~~
        
        Do NOT install a Python application in your system. Always use a
        Virtualenv. Or let it be handled by your distribution's maintainer.
        
        This method is used when building the docker image (and the travis
        build):
        
        ::
        
            sudo ./bootstrap-system.sh
            sudo make install-system
        
        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/notify``
        -  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
        ------------
        
        Bootstrap your system with
        
        ::
        
            sudo ./bootstrap-system.sh
        
        System dependencies:
        
        -  ``git``
        -  ``make``
        -  ``pandoc``
        -  ``pip``
        -  ``pipenv``
        
        Setup your 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 to Pypi
        ------------------
        
        (This part should be automatically done by Travis on successful tag
        build)
        
        Build Wheel package:
        
        ::
        
            make wheels
        
        Register and publish your package to Pypi:
        
        ::
        
            make pypi-publish
        
        Create a release: create a tag with a semver syntax. Optionally you can
        tag code locally and push to GitHub.
        
        ::
        
            git tag 1.2.3
            git push --tags
        
        On successful travis build on the Tag branch, your Pypi package will be
        automatically updated.
        
        .. |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/
        .. |Pyup| image:: https://pyup.io/repos/github/Stibbons/dopplerr/shield.svg
           :target: https://pyup.io/repos/github/Stibbons/dopplerr/
        .. |Coveralls| image:: https://coveralls.io/repos/github/Stibbons/dopplerr/badge.svg
           :target: https://coveralls.io/github/Stibbons/dopplerr
        .. |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/
        .. |MIT licensed| image:: https://img.shields.io/badge/license-MIT-blue.svg
           :target: ./LICENSE
        
        
Platform: UNKNOWN
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Multimedia :: Video
