diff --git a/docs/development.rst b/docs/development.rst index 1fd419d0..74436223 100644 --- a/docs/development.rst +++ b/docs/development.rst @@ -37,6 +37,50 @@ implemented, and you may add new wishlist issues if your ideas are not already represented. +.. _run-from-git: + +Run Mopidy from Git repo +======================== + +If you want to contribute to the development of Mopidy, you should run Mopidy +directly from the Git repo. + +#. First of all, install Mopidy in the recommended way for your OS and/or + distribution, like described at :ref:`installation`. You can have a + system-wide installation of the last Mopidy release in addition to the Git + repo which you run from when you code on Mopidy. + +#. Then install Git, if haven't already. For Ubuntu/Debian:: + + sudo apt-get install git-core + + On OS X using Homebrew:: + + sudo brew install git + +#. Clone the official Mopidy repository:: + + git clone git://github.com/mopidy/mopidy.git + + or your own fork of it:: + + git clone git@github.com:mygithubuser/mopidy.git + +#. You can then run Mopidy directly from the Git repository:: + + cd mopidy/ # Move into the Git repo dir + python mopidy # Run python on the mopidy source code dir + +How you update your clone depends on whether you cloned the official Mopidy +repository or your own fork, whether you have made any changes to the clone +or not, and whether you are currently working on a feature branch or not. In +other words, you'll need to learn Git. + +For an introduction to Git, please visit `git-scm.com `_. +Also, please read the rest of our developer documentation before you start +contributing. + + Code style ========== diff --git a/docs/installation/index.rst b/docs/installation/index.rst index c84dcf01..d134ae40 100644 --- a/docs/installation/index.rst +++ b/docs/installation/index.rst @@ -1,57 +1,21 @@ .. _installation: -************ -Installation -************ +******************* +Mopidy installation +******************* -There are several ways to install Mopidy. What way is best depends upon your -setup and whether you want to use stable releases or less stable development -versions. +There are several ways to install Mopidy. What way is best depends upon your OS +and/or distribution. If you want to contribute to the development of Mopidy, +you should first read this page, then have a look at :ref:`run-from-git`. -Requirements -============ - -If you install Mopidy from the APT archive, as described below, APT will take -care of all the dependencies for you. Otherwise, make sure you got the required -dependencies installed. - -- Hard dependencies: - - - Python >= 2.6, < 3 - - - Pykka >= 1.0:: - - sudo pip install -U pykka - - - GStreamer 0.10.x, with Python bindings. See :doc:`gstreamer`. - -- Optional dependencies: - - - For Spotify support, you need libspotify and pyspotify. See - :doc:`libspotify`. - - - To scrobble your played tracks to Last.fm, you need pylast:: - - sudo pip install -U pylast - - - To use MPRIS, e.g. for controlling Mopidy from the Ubuntu Sound Menu, you - need some additional requirements:: - - sudo apt-get install python-dbus python-indicate - - -Install latest stable release -============================= - - -From APT archive ----------------- +Debian/Ubuntu: Install from apt.mopidy.com +========================================== If you run a Debian based Linux distribution, like Ubuntu, the easiest way to -install Mopidy is from the Mopidy APT archive. When installing from the APT -archive, you will automatically get updates to Mopidy in the same way as you -get updates to the rest of your distribution. +install Mopidy is from the `Mopidy APT archive `_. When +installing from the APT archive, you will automatically get updates to Mopidy +in the same way as you get updates to the rest of your distribution. #. Add the archive's GPG key:: @@ -65,119 +29,32 @@ get updates to the rest of your distribution. deb http://apt.mopidy.com/ stable main contrib non-free deb-src http://apt.mopidy.com/ stable main contrib non-free + For the lazy, you can simply run the following command to create + ``/etc/apt/sources.list.d/mopidy.list``:: + + sudo wget -q -O /etc/apt/sources.list.d/mopidy.list http://apt.mopidy.com/mopidy.list + #. Install Mopidy and all dependencies:: sudo apt-get update sudo apt-get install mopidy -#. Next, you need to set a couple of :doc:`settings `, and then +#. Finally, you need to set a couple of :doc:`settings `, and then you're ready to :doc:`run Mopidy `. -When a new release is out, and you can't wait for you system to figure it out -for itself, run the following to force an upgrade:: +When a new release of Mopidy is out, and you can't wait for you system to +figure it out for itself, run the following to upgrade right away:: sudo apt-get update sudo apt-get dist-upgrade -From PyPI using Pip -------------------- +Arch Linux: Install from AUR +============================ -If you are on OS X or on Linux, but can't install from the APT archive, you can -install Mopidy from PyPI using Pip. - -#. When you install using Pip, you first need to ensure that all of Mopidy's - dependencies have been installed. See the section on dependencies above. - -#. Then, you need to install Pip:: - - sudo apt-get install python-setuptools python-pip # On Ubuntu/Debian - sudo easy_install pip # On OS X - -#. To install the currently latest stable release of Mopidy:: - - sudo pip install -U Mopidy - - To upgrade Mopidy to future releases, just rerun this command. - -#. Next, you need to set a couple of :doc:`settings `, and then - you're ready to :doc:`run Mopidy `. - - -Install development version -=========================== - -If you want to follow the development of Mopidy closer, you may install a -development version of Mopidy. These are not as stable as the releases, but -you'll get access to new features earlier and may help us by reporting issues. - - -From snapshot using Pip ------------------------ - -If you want to follow Mopidy development closer, you may install a snapshot of -Mopidy's ``develop`` branch. - -#. When you install using Pip, you first need to ensure that all of Mopidy's - dependencies have been installed. See the section on dependencies above. - -#. Then, you need to install Pip:: - - sudo apt-get install python-setuptools python-pip # On Ubuntu/Debian - sudo easy_install pip # On OS X - -#. To install the latest snapshot of Mopidy, run:: - - sudo pip install mopidy==dev - - To upgrade Mopidy to future releases, just rerun this command. - -#. Next, you need to set a couple of :doc:`settings `, and then - you're ready to :doc:`run Mopidy `. - - -From Git --------- - -If you want to contribute to Mopidy, you should install Mopidy using Git. - -#. When you install from Git, you first need to ensure that all of Mopidy's - dependencies have been installed. See the section on dependencies above. - -#. Then install Git, if haven't already:: - - sudo apt-get install git-core # On Ubuntu/Debian - sudo brew install git # On OS X using Homebrew - -#. Clone the official Mopidy repository, or your own fork of it:: - - git clone git://github.com/mopidy/mopidy.git - -#. Next, you need to set a couple of :doc:`settings `. - -#. You can then run Mopidy directly from the Git repository:: - - cd mopidy/ # Move into the Git repo dir - python mopidy # Run python on the mopidy source code dir - -#. Later, to get the latest changes to Mopidy:: - - cd mopidy/ - git pull - -For an introduction to ``git``, please visit `git-scm.com -`_. Also, please read our :doc:`developer documentation -`. - - -From AUR on ArchLinux ---------------------- - -If you are running ArchLinux, you can install a development snapshot of Mopidy -using the package found at http://aur.archlinux.org/packages.php?ID=44026. - -#. First, you should consider installing any optional dependencies not included - by the AUR package, like required for e.g. Last.fm scrobbling. +If you are running Arch Linux, you can install a development snapshot of Mopidy +using the `mopidy-git `_ +package found in AUR. #. To install Mopidy with GStreamer, libspotify and pyspotify, you can use ``packer``, ``yaourt``, or do it by hand like this:: @@ -189,5 +66,67 @@ using the package found at http://aur.archlinux.org/packages.php?ID=44026. To upgrade Mopidy to future releases, just rerun ``makepkg``. -#. Next, you need to set a couple of :doc:`settings `, and then +#. Optional: If you want to scrobble your played tracks to Last.fm, you need to + install `python2-pylast + `_ from AUR. + +#. Finally, you need to set a couple of :doc:`settings `, and then + you're ready to :doc:`run Mopidy `. + + +Otherwise: Install from source using Pip +======================================== + +If you are on OS X or on Linux, but can't install from the APT archive or from +AUR, you can install Mopidy from PyPI using Pip. + +#. First of all, you need Python >= 2.6, < 3. Check if you have Python and what + version by running:: + + python --version + +#. When you install using Pip, you need to make sure you have Pip. If you + don't, this is how you install it on Debian/Ubuntu:: + + sudo apt-get install python-setuptools python-pip + + Or on OS X:: + + sudo easy_install pip + +#. Then you'll need to install all of Mopidy's hard dependencies: + + - Pykka >= 1.0:: + + sudo pip install -U pykka + + - GStreamer 0.10.x, with Python bindings. See :doc:`gstreamer` for detailed + instructions. + +#. Optional: If you want Spotify support in Mopidy, you'll need to install + libspotify and the Python bindings, pyspotify. See :doc:`libspotify` for + detailed instructions. + +#. Optional: If you want to scrobble your played tracks to Last.fm, you need + pylast:: + + sudo pip install -U pylast + +#. Optional: To use MPRIS, e.g. for controlling Mopidy from the Ubuntu Sound + Menu, you need some additional requirements. On Debian/Ubuntu:: + + sudo apt-get install python-dbus python-indicate + +#. Then, to install the latest release of Mopidy:: + + sudo pip install -U mopidy + + To upgrade Mopidy to future releases, just rerun this command. + + Alternatively, if you want to follow Mopidy development closer, you may + install a snapshot of Mopidy's ``develop`` Git branch using Pip:: + + sudo pip install mopidy==dev + +#. Finally, you need to set a couple of :doc:`settings `, and then you're ready to :doc:`run Mopidy `.