From a084105898f6be5c87f0e6716df8300f4edb3d17 Mon Sep 17 00:00:00 2001
From: Stein Magnus Jodal <stein.magnus@jodal.no>
Date: Sat, 15 Dec 2012 23:07:29 +0100
Subject: [PATCH] docs: Use requirement files as single source of dependencies

---
 mopidy/audio/mixers/nad.py          | 8 ++++----
 mopidy/backends/spotify/__init__.py | 3 +--
 mopidy/frontends/http/__init__.py   | 4 +---
 mopidy/frontends/lastfm.py          | 2 +-
 requirements/README.rst             | 4 ++--
 requirements/core.txt               | 1 +
 requirements/external_mixers.txt    | 1 +
 requirements/http.txt               | 3 +++
 requirements/lastfm.txt             | 2 ++
 requirements/spotify.txt            | 7 +++++++
 10 files changed, 23 insertions(+), 12 deletions(-)

diff --git a/mopidy/audio/mixers/nad.py b/mopidy/audio/mixers/nad.py
index b5cb522d..52ab4757 100644
--- a/mopidy/audio/mixers/nad.py
+++ b/mopidy/audio/mixers/nad.py
@@ -1,11 +1,11 @@
 """Mixer that controls volume using a NAD amplifier.
 
+The NAD amplifier must be connected to the machine running Mopidy using a
+serial cable.
+
 **Dependencies:**
 
-- pyserial (python-serial in Debian/Ubuntu)
-
-- The NAD amplifier must be connected to the machine running Mopidy using a
-  serial cable.
+.. literalinclude:: ../../../../requirements/external_mixers.txt
 
 **Settings:**
 
diff --git a/mopidy/backends/spotify/__init__.py b/mopidy/backends/spotify/__init__.py
index a8e9ffda..507511f4 100644
--- a/mopidy/backends/spotify/__init__.py
+++ b/mopidy/backends/spotify/__init__.py
@@ -20,8 +20,7 @@ https://github.com/mopidy/mopidy/issues?labels=Spotify+backend
 
 **Dependencies:**
 
-- libspotify >= 12, < 13 (libspotify12 package from apt.mopidy.com)
-- pyspotify >= 1.9, < 1.11 (python-spotify package from apt.mopidy.com)
+.. literalinclude:: ../../../requirements/spotify.txt
 
 **Settings:**
 
diff --git a/mopidy/frontends/http/__init__.py b/mopidy/frontends/http/__init__.py
index 32edde0f..94b8e58e 100644
--- a/mopidy/frontends/http/__init__.py
+++ b/mopidy/frontends/http/__init__.py
@@ -4,9 +4,7 @@ from a web based client.
 
 **Dependencies**
 
-- ``cherrypy``
-
-- ``ws4py``
+.. literalinclude:: ../../../requirements/http.txt
 
 **Settings**
 
diff --git a/mopidy/frontends/lastfm.py b/mopidy/frontends/lastfm.py
index 7f367262..565e5041 100644
--- a/mopidy/frontends/lastfm.py
+++ b/mopidy/frontends/lastfm.py
@@ -8,7 +8,7 @@ Frontend which scrobbles the music you play to your `Last.fm
 
 **Dependencies:**
 
-- `pylast <http://code.google.com/p/pylast/>`_ >= 0.5.7
+.. literalinclude:: ../../../requirements/lastfm.txt
 
 **Settings:**
 
diff --git a/requirements/README.rst b/requirements/README.rst
index cc061a7b..e1a6d757 100644
--- a/requirements/README.rst
+++ b/requirements/README.rst
@@ -3,8 +3,8 @@ pip requirement files
 *********************
 
 The files found here are `requirement files
-<http://pip.openplans.org/requirement-format.html>`_ that may be used with `pip
-<http://pip.openplans.org/>`_.
+<http://www.pip-installer.org/en/latest/requirements.html>`_ that may be used
+with `pip <http://www.pip-installer.org/>`_.
 
 To install the dependencies found in one of these files, simply run e.g.::
 
diff --git a/requirements/core.txt b/requirements/core.txt
index 7f83e251..7a28564f 100644
--- a/requirements/core.txt
+++ b/requirements/core.txt
@@ -1 +1,2 @@
 Pykka >= 1.0
+# Available as python-pykka from apt.mopidy.com
diff --git a/requirements/external_mixers.txt b/requirements/external_mixers.txt
index f6c1a1f5..20cb7864 100644
--- a/requirements/external_mixers.txt
+++ b/requirements/external_mixers.txt
@@ -1 +1,2 @@
 pyserial
+# Available as python-serial in Debian/Ubuntu
diff --git a/requirements/http.txt b/requirements/http.txt
index d8757e29..aea7c1a8 100644
--- a/requirements/http.txt
+++ b/requirements/http.txt
@@ -1,2 +1,5 @@
 cherrypy >= 3.2.2
+# Available as python-cherrypy3 in Debian/Ubuntu
+
 ws4py >= 0.2.3
+# Available as python-ws4py from apt.mopidy.com
diff --git a/requirements/lastfm.txt b/requirements/lastfm.txt
index 314c4223..c52256c3 100644
--- a/requirements/lastfm.txt
+++ b/requirements/lastfm.txt
@@ -1 +1,3 @@
 pylast >= 0.5.7
+# Available as python-pylast in newer Debian/Ubuntu and from apt.mopidy.com for
+# older releases of Debian/Ubuntu
diff --git a/requirements/spotify.txt b/requirements/spotify.txt
index b501e63e..333e55c8 100644
--- a/requirements/spotify.txt
+++ b/requirements/spotify.txt
@@ -1 +1,8 @@
 pyspotify >= 1.9, < 1.11
+# The libspotify Python wrapper
+# Available as the python-spotify package from apt.mopidy.com
+
+# libspotify >= 12, < 13
+# The libspotify C library from
+# https://developer.spotify.com/technologies/libspotify/
+# Available as the libspotify12 package from apt.mopidy.com