From 2bfc7723fa3e8bf6fea57e68f24de5673b0dd633 Mon Sep 17 00:00:00 2001 From: Susanna Maria Date: Sun, 23 Jun 2019 18:01:21 +0200 Subject: [PATCH] Fix findings from travis-ci --- docs/plugins/absubmit.rst | 38 ++++++++++++++++++++++++-------------- 1 file changed, 24 insertions(+), 14 deletions(-) diff --git a/docs/plugins/absubmit.rst b/docs/plugins/absubmit.rst index f6e561b35..a9cf651ce 100644 --- a/docs/plugins/absubmit.rst +++ b/docs/plugins/absubmit.rst @@ -7,13 +7,18 @@ The ``absubmit`` plugin lets you submit acoustic analysis results to the Installation ------------ -The ``absubmit`` plugin requires the `streaming_extractor_music`_ program to run. Its source can be found on `GitHub`_, and while it is possible to compile the extractor from source, AcousticBrainz would prefer if you used their binary (see the AcousticBrainz `FAQ`_). +The ``absubmit`` plugin requires the `streaming_extractor_music`_ program +to run. Its source can be found on `GitHub`_, and while it is possible to +compile the extractor from source, AcousticBrainz would prefer if you used +their binary (see the AcousticBrainz `FAQ`_). -The ``absubmit`` plugin also requires `requests`_, which you can install using `pip`_ by typing:: +The ``absubmit`` plugin also requires `requests`_, which you can install +using `pip`_ by typing:: pip install requests -After installing both the extractor binary and requests you can enable the plugin ``absubmit`` in your configuration (see :ref:`using-plugins`). +After installing both the extractor binary and requests you can enable +the plugin ``absubmit`` in your configuration (see :ref:`using-plugins`). Submitting Data --------------- @@ -22,10 +27,12 @@ Type:: beet absubmit [-f] [-d] [QUERY] -to run the analysis program and upload its results. By default, the command will only look for AcousticBrainz data when the tracks -doesn't already have it; the ``-f`` or ``--force`` switch makes it refetch data even -when it already exists. You can use the ``-d`` or ``--dry``swtich to check which files will be -analyzed, before you start a longer period of processing. +To run the analysis program and upload its results. By default, the +command will only look for AcousticBrainz data when the tracks +doesn't already have it; the ``-f`` or ``--force`` switch makes it refetch +data even when it already exists. You can use the ``-d`` or ``--dry`` swtich +to check which files will be analyzed, before you start a longer period +of processing. The plugin works on music with a MusicBrainz track ID attached. The plugin will also skip music that the analysis tool doesn't support. @@ -37,17 +44,20 @@ will also skip music that the analysis tool doesn't support. Configuration ------------- -To configure the plugin, make a ``absubmit:`` section in your configuration file. The available options are: +To configure the plugin, make a ``absubmit:`` section in your configuration +file. The available options are: -- **auto**: Analyze every file on import. Otherwise, you need to use the ``beet absubmit`` command explicitly. +- **auto**: Analyze every file on import. Otherwise, you need to use the + ``beet absubmit`` command explicitly. Default: ``no`` - **extractor**: The absolute path to the `streaming_extractor_music`_ binary. Default: search for the program in your ``$PATH`` -- **force**: Analyze items and submit of AcousticBrainz data even for tracks that already have - it. - Default: ``no``. -- **dry**: No analyze and submit of AcousticBrainz data but print out the items which would be processed - Default: ``no``. +- **force**: Analyze items and submit of AcousticBrainz data even for tracks + that already have it. + Default: ``no``. +- **dry**: No analyze and submit of AcousticBrainz data but print out the + items which would be processed + Default: ``no``. .. _streaming_extractor_music: https://acousticbrainz.org/download .. _FAQ: https://acousticbrainz.org/faq