110 lines
3.1 KiB
ReStructuredText
110 lines
3.1 KiB
ReStructuredText
***********
|
|
Development
|
|
***********
|
|
|
|
Development of Mopidy is coordinated through the IRC channel ``#mopidy`` at
|
|
``irc.freenode.net`` and through `GitHub <http://github.com/>`_.
|
|
|
|
|
|
API documentation
|
|
=================
|
|
|
|
.. toctree::
|
|
:glob:
|
|
|
|
api/*
|
|
|
|
|
|
Scope
|
|
=====
|
|
|
|
To limit scope, we will start by implementing an MPD server which only
|
|
supports Spotify, and not playback of files from disk. We will make Mopidy
|
|
modular, so we can extend it with other backends in the future, like file
|
|
playback and other online music services such as Last.fm.
|
|
|
|
|
|
Code style
|
|
==========
|
|
|
|
We generally follow the `PEP-8 <http://www.python.org/dev/peps/pep-0008/>`_
|
|
style guidelines, with a couple of notable exceptions:
|
|
|
|
- We only indent continuation lines with an addition four spaces relative to
|
|
the previous line.
|
|
- An exception to the previous exception: When continuing control flow
|
|
statements like ``if``, ``for`` and ``while``, indent the continuation lines
|
|
with eight spaces, so that it is indented an additional level compared to the
|
|
following block of code.
|
|
|
|
|
|
Running tests
|
|
=============
|
|
|
|
To run tests, you need a couple of dependencies. Some can be installed through
|
|
Debian/Ubuntu package management::
|
|
|
|
sudo aptitude install python-coverage
|
|
|
|
The rest can be installed using pip::
|
|
|
|
sudo aptitude install python-pip python-setuptools bzr
|
|
sudo pip install -r test-requirements.txt
|
|
|
|
Then, to run all tests::
|
|
|
|
python tests
|
|
|
|
|
|
Music Player Daemon (MPD)
|
|
=========================
|
|
|
|
The `MPD protocol documentation <http://www.musicpd.org/doc/protocol/>`_ is a
|
|
useful resource. It is rather incomplete with regards to data formats, both for
|
|
requests and responses. Thus we have to talk a great deal with the the original
|
|
`MPD server <http://mpd.wikia.com/>`_ using telnet to get the details we need
|
|
to implement our own MPD server which is compatible with the numerous existing
|
|
`MPD clients <http://mpd.wikia.com/wiki/Clients>`_.
|
|
|
|
|
|
spytify
|
|
=======
|
|
|
|
`spytify <http://despotify.svn.sourceforge.net/viewvc/despotify/src/bindings/python/>`_
|
|
is the Python bindings for the open source `despotify <http://despotify.se/>`_
|
|
library. It got no documentation to speak of, but a couple of examples are
|
|
available.
|
|
|
|
Issues
|
|
------
|
|
|
|
A list of the issues we currently experience with spytify, both bugs and
|
|
features we wished was there.
|
|
|
|
* r483: Sometimes segfaults when traversing stored playlists, their tracks,
|
|
artists, and albums. As it is not predictable, it may be a concurrency issue.
|
|
|
|
* r503: Segfaults when looking up playlists, both your own lists and other
|
|
peoples shared lists. To reproduce::
|
|
|
|
>>> import spytify
|
|
>>> s = spytify.Spytify('alice', 'secret')
|
|
>>> s.lookup('spotify:user:klette:playlist:5rOGYPwwKqbAcVX8bW4k5V')
|
|
Segmentation fault
|
|
|
|
|
|
pyspotify
|
|
=========
|
|
|
|
`pyspotify <http://github.com/winjer/pyspotify/>`_ is the Python bindings for
|
|
the official Spotify library, libspotify. It got no documentation to speak of,
|
|
but multiple examples are available.
|
|
|
|
Issues
|
|
------
|
|
|
|
A list of the issues we currently experience with pyspotify, both bugs and
|
|
features we wished was there.
|
|
|
|
* None at the moment.
|