diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 377d541..d40c6b7 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -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 diff --git a/MANIFEST.in b/MANIFEST.in index 292d6dd..9402047 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -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__ diff --git a/README.rst b/README.rst index 44c78c5..63141f8 100644 --- a/README.rst +++ b/README.rst @@ -2,36 +2,62 @@ mopidy-funkwhale ================ - -.. 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 - -.. image:: https://readthedocs.org/projects/mopidy-funkwhale/badge/?version=latest - :target: https://mopidy-funkwhale.readthedocs.io/en/latest/?badge=latest - :alt: Documentation Status +A small `Mopidy`_ backend extension to stream music from a Funkwhale server. +Status +------ - -A backend extension for mopidy to stream music from a Funkwhale server - - -* Free software: GNU General Public License v3 -* Documentation: https://mopidy-funkwhale.readthedocs.io. - +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 -------- -* TODO +* Searching for tracks, albums and artists available in your Funkwhale instance +* Simple configuration -Credits -------- +Installation +------------ -This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template. +We assume you have a Mopidy server available. -.. _Cookiecutter: https://github.com/audreyr/cookiecutter -.. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage +We don't have any package for this extension yet, so you may install +from the repository: + +.. code-block:: shell + + pip install git+https://code.eliotberriot.com/funkwhale/mopidy.git + +.. 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). + +After that, reload your mopidy daemon, and you should be good! +Todo +---- + +- Browse Funkwhale library and playlists + + +.. _Mopidy: https://www.mopidy.com/ +.. _ncmpcpp: https://wiki.archlinux.org/index.php/ncmpcpp +.. _iris: https://github.com/jaedb/iris diff --git a/mopidy_funkwhale/ext.conf b/mopidy_funkwhale/ext.conf index 0f49252..6ed219a 100644 --- a/mopidy_funkwhale/ext.conf +++ b/mopidy_funkwhale/ext.conf @@ -1,5 +1,8 @@ [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 diff --git a/setup.cfg b/setup.cfg index 9b84548..e7e56a1 100644 --- a/setup.cfg +++ b/setup.cfg @@ -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