Skip to content

Commit

Permalink
docs: Move most of README and install docs to an introduction page
Browse files Browse the repository at this point in the history
  • Loading branch information
jodal committed May 31, 2011
1 parent b90ce84 commit c05a848
Show file tree
Hide file tree
Showing 4 changed files with 101 additions and 105 deletions.
70 changes: 7 additions & 63 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,67 +1,11 @@
=========
pyspotify
=========

pyspotify is the Python bindings for libspotify.

This is not the original version of pyspotify, as made by `winjer
<http://github.com/winjer/>`_, but an updated version
for use with `Mopidy <http://www.mopidy.com/>`_.

Please see the Mopidy web site for further information on pyspotify.


Upstream notes
==============

Introduction
------------

This package provides a Python interface to Spotify's online music streaming
service.

To use this package you will also need libspotify, availably from Spotify here:

http://developer.spotify.com/en/libspotify/overview/

You will need a Spotify Premium account. You will also need to apply for, and
receive an API key from spotify.

Completion status
-----------------

Pyspotify is very usable, and implements most of the Spotify API. The table
below shows what is done and what is left to be done.



================================== ==================================
Subsystem Status
================================== ==================================
Error handling Fully implemented
Session handling Fully implemented
Link subsystem Fully implemented
Track subsystem Fully implemented
Album subsystem Fully implemented
Artist subsystem Fully implemented
Album browsing Fully implemented
Artist browsing Fully implemented
Image handling Partially implemented
Search subsystem Fully implemented
Playlist subsystem Partially implemented
User handling Not implemented
Toplist handling Not implemented
Inbox subsystem Not implemented
================================== ==================================


Building the software
---------------------

See docs/installation.rst

Trying it out
-------------
pyspotify provides a Python interface to `Spotify's <http://www.spotify.com/>`_
online music streaming service.

Included with this is a simple program, jukebox.py. Run this with your
credentials and access to an API key, and it will let you browse and play from
your playlists, conduct searches and play from spotify URIs.
To use this package you will also need `libspotify
<http://developer.spotify.com/en/libspotify/overview/>`_, which is available
from Spotify. You will need a Spotify Premium account. You will also need to
apply for, and receive an API key from Spotify.
5 changes: 3 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
.. include:: ../README.rst

Contents
========
Table of contents
=================

.. toctree::
:maxdepth: 2

introduction
installation
managers/index
api/index
Expand Down
40 changes: 0 additions & 40 deletions docs/installation.rst

This file was deleted.

91 changes: 91 additions & 0 deletions docs/introduction.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
************
Introduction
************

pyspotify provides a Python interface to `Spotify's <http://www.spotify.com/>`_
online music streaming service.


Completion status
=================

pyspotify is very usable, and implements most of the libspotify 0.0.7 API. The
table below shows what is done and what is left to be done.

================================== ==================================
Subsystem Status
================================== ==================================
Error handling Fully implemented
Session handling Fully implemented
Link subsystem Fully implemented
Track subsystem Fully implemented
Album subsystem Fully implemented
Artist subsystem Fully implemented
Album browsing Fully implemented
Artist browsing Fully implemented
Image handling Partially implemented
Search subsystem Fully implemented
Playlist subsystem Partially implemented
User handling Not implemented
Toplist handling Not implemented
Inbox subsystem Not implemented
================================== ==================================


Requirements
============

To use this package you will also need `libspotify
<http://developer.spotify.com/en/libspotify/overview/>`_, which is available
from Spotify.

You will need a Spotify Premium account. You will also need to apply for, and
receive an API key from Spotify.


Installation
============

Debian package
--------------

For Ubuntu and Debian users, *pyspotify* can be found in the ``python-spotify``
package of the `Mopidy APT archive <http://apt.mopidy.com/>`_.

Arch Linux package
------------------

Install the ``pyspotify-git`` package from the AUR.

Using Pip
---------

The ``pip`` program for installing Python packages is usually found is the
``python-pip`` package of your linux distribution.

To install ``pyspotify``, run as root::

pip install -U pyspotify

To update an existing installation, simply use the same command.

Using setuptools (latest git version)
-------------------------------------

You will have first to clone the `git repository <http://github.com/mopidy/pyspotify>`_.

On Ubuntu or other Debian-based distributions::

python setup.py install --install-layout=deb

On other::

python setup.py install


Trying it out
=============

Included with pyspotify is a simple program, `examples/jukebox.py`. Run this
with your credentials and access to an API key, and it will let you browse and
play from your playlists, conduct searches and play from Spotify URIs.

0 comments on commit c05a848

Please sign in to comment.