Metadata-Version: 1.1
Name: pydora
Version: 1.6.3
Summary: Python wrapper for Pandora API
Home-page: https://github.com/mcrute/pydora
Author: Mike Crute
Author-email: mcrute@gmail.com
License: UNKNOWN
Description: ==================
        Pandora API Client
        ==================
        
        .. image:: https://img.shields.io/pypi/v/pydora.svg
            :target: https://pypi.python.org/pypi/pydora
        
        .. image:: https://img.shields.io/travis/mcrute/pydora.svg
            :target: https://travis-ci.org/mcrute/pydora
        
        .. image:: https://img.shields.io/pypi/dm/pydora.svg
            :target: https://pypi.python.org/pypi/pydora
        
        This code is licensed under the MIT license.
        
        This is a reasonably complete implementation of the Pandora API. It does not
        implement any of the undocumented features and does not implement most of the
        account management features as they were deemed not terribly useful.
        
        I don't provide any keys or passwords for Pandora in this repo, you'll have to
        go get those for yourself. Make something awesome with this library, don't
        abuse Pandora, that's not cool.
        
        Installing
        ==========
        Installing is as simple as using pip and running the built-in configuration
        command to create a ``~/.pydora.cfg`` file. If you already have a `PianoBar
        <http://6xq.net/projects/pianobar/>`_ config file pydora will automatically use
        that. ::
        
            $ pip install pydora
            $ pydora-configure
        
        On Ubuntu install `mpg123`::
        
            # apt-get install mpg123
        
        On Mac OS X with `homebrew <http://brew.sh/>`_ installed::
        
            # brew install mpg123
        
        Simple Player
        =============
        Included is ``pydora``, a simple Pandora stream player that runs at the command
        line. It requires that mpg123 be installed with HTTP support as well as a
        settings file (example below) located in ``~/.pydora.cfg``. Alternatively an
        environment variable ``PYDORA_CFG`` can point to the path of the config file.
        
        The player only supports basic functionality for now. It will display a station
        list, allow listening to any station, basic feeback and bookmarking are also
        supported. The player starts an mpg123 process in remote control mode and feeds
        commands to it. It does not download any music but rather streams them directly
        from Pandora.
        
        When playing the following keys work (press enter afterwards):
        
        * n - next song
        * p - pause or resume song
        * s - station list (stops song)
        * d - thumbs down track
        * u - thumbs up track
        * b - bookmark song
        * a - bookmark artist
        * S - sleep song
        * Q - quit program
        * ? - display help
        
        sample config::
        
            [api]
            api_host = hostname
            encryption_key = key
            decryption_key = key
            username = partner username
            password = partner password
            device = key
            default_audio_quality = mediumQuality
        
            [user]
            username = your username
            password = your password
        
        **default_audio_quality**
          Default audio quality to request from the API; can be one of `lowQuality`,
          `mediumQuality` (default), or `highQuality`. If the preferred audio quality
          is not available for the device specified, then the next-highest bitrate
          stream that Pandora supports for the chosen device will be used.
        
        Pandora API Spec and Partner Keys
        =================================
        The built-in ``pydora-configure`` script can be run to create a configuration
        file if you don't already have one. This will download the keys from the link
        below and pick a suitable one. If you're interested in the underlying API or
        need to download the keys yourself you can find them at the link below.
        
        * `API Spec <http://6xq.net/playground/pandora-apidoc/>`_
        * `Partner Keys <http://6xq.net/playground/pandora-apidoc/json/partners/#partners>`_
        
        Contributing
        ============
        If you would like to contribute to Pydora please visit the project's
        `GitHub page <https://github.com/mcrute/pydora>`_ and open a pull request with
        your changes. To have the best experience contributing, please:
        
        * Don't break backwards compatibility of public interfaces
        * Write tests for your new feature/bug fix
        * Ensure that existing tests pass
        * Update the readme/docstrings, if necessary
        * Follow the coding style of the current code-base
        * Ensure that your code is PEP8 compliant
        * Validate that your changes work with Python 2.7+ and 3.3+
        
        All code is reviewed before acceptance and changes may be requested to better
        follow the conventions of the existing API.
        
        The build system runs ``python setup.py validate`` on all supported Python
        versions. You can, and should, run this on your pull request before submitting.
        
        Contributors
        ============
        * Mike Crute (`mcrute <https://github.com/mcrute>`_)
        * John Cass (`jcass77 <https://github.com/jcass77>`_)
        * Thomas Weißschuh (`t-8c <https://github.com/t-8ch>`_)
        
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Multimedia :: Sound/Audio :: Players
