Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
Erin
mopidy
Commits
8d51087d
Commit
8d51087d
authored
Oct 03, 2018
by
Eliot Berriot
Browse files
Merge branch 'documentation' into 'master'
Better documentation See merge request
funkwhale/mopidy!2
parents
8cd646e0
22c62fe4
Changes
5
Hide whitespace changes
Inline
Side-by-side
.gitlab-ci.yml
View file @
8d51087d
...
...
@@ -5,6 +5,8 @@ test:
stage
:
test
image
:
python:2
before_script
:
-
apt-get update
-
apt-get install libgirepository1.0-dev -y
-
pip install .[test]
script
:
-
pytest
...
...
MANIFEST.in
View file @
8d51087d
...
...
@@ -2,6 +2,7 @@ include CONTRIBUTING.rst
include HISTORY.rst
include LICENSE
include README.rst
include mopidy_funkwhale/ext.conf
recursive-include tests *
recursive-exclude * __pycache__
...
...
README.rst
View file @
8d51087d
...
...
@@ -2,36 +2,62 @@
mopidy-funkwhale
================
A small `Mopidy`_ backend extension to stream music from a Funkwhale server.
.. image:: https://img.shields.io/pypi/v/mopidy_funkwhale.svg
:target: https://pypi.python.org/pypi/mopidy_funkwhale
.. image:: https://img.shields.io/travis/eliotberriot/mopidy_funkwhale.svg
:target: https://travis-ci.org/eliotberriot/mopidy_funkwhale
Status
------
.. image:: https://readthedocs.org/projects/mopidy-funkwhale/badge/?version=latest
:target: https://mopidy-funkwhale.readthedocs.io/en/latest/?badge=latest
:alt: Documentation Status
This project is still pretty young and is not feature complete. It has been
tested with the latest version of Mopidy and the `Iris`_ and `ncmpcpp`_ clients.
Features
--------
* Searching for tracks, albums and artists available in your Funkwhale instance
* Simple configuration
Installation
------------
A backend extension for mopidy to stream music from a Funkwhale server
We assume you have a Mopidy server available.
We don't have any package for this extension yet, so you may install
from the repository:
* Free software: GNU General Public License v3
* Documentation: https://mopidy-funkwhale.readthedocs.io.
.. code-block:: shell
pip install git+https://code.eliotberriot.com/funkwhale/mopidy.git
Features
--------
.. note::
Depending on your setup, you may want to run this comand with ``sudo`` or ``--user``
Configuration
-------------
To enable the extension, add the following to your ``mopidy.conf`` file::
[funkwhale]
enabled = true
# URL of your funkwhale instance
url = https://demo.funkwhale.audio
# Username to use when authenticating (leave empty fo anonymous access)
username = demo
# Password to use when authenticating (leave empty fo anonymous access)
password = demo
Of course, replace the demo values with your actual info (but you can
try using the demo server).
* TODO
After that, reload your mopidy daemon, and you should be good!
Todo
----
Credits
-------
- Browse Funkwhale library and playlists
This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
.. _Cookiecutter: https://github.com/audreyr/cookiecutter
.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
.. _Mopidy: https://www.mopidy.com/
.. _ncmpcpp: https://wiki.archlinux.org/index.php/ncmpcpp
.. _iris: https://github.com/jaedb/iris
mopidy_funkwhale/ext.conf
View file @
8d51087d
[
funkwhale
]
enabled
=
true
# URL of your funkwhale instance
url
=
https
://
demo
.
funkwhale
.
audio
# Username to use when authenticating (leave empty fo anonymous access)
username
=
demo
# Password to use when authenticating (leave empty fo anonymous access)
password
=
demo
setup.cfg
View file @
8d51087d
...
...
@@ -21,6 +21,8 @@ packages = find:
install_requires =
mopidy
requests
pygobject
vext
[options.entry_points]
...
...
@@ -35,7 +37,6 @@ test =
pytest-mock
dev =
pygobject
ipython
ipdb
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment