Backup_Repos/beets
1
0
Fork 0
mirror of https://github.com/beetbox/beets.git synced 2025-12-30 12:32:33 +01:00
Code Issues Projects Releases Wiki Activity

Improve absumbit docs (c.f. #2364)

Browse source
This commit is contained in:
Adrian Sampson 2017-01-02 13:41:48 -05:00
parent 2d6ad4c5bd
commit b95c01fbea
1 changed files with 14 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
docs/plugins/absubmit.rst
View file

@ -1,19 +1,30 @@
AcousticBrainz Submit Plugin
============================
The `absubmit` plugin uses the `streaming_extractor_music`_ program to analyze an audio file and calculate different acoustic properties of the audio. The plugin then uploads this metadata to the AcousticBrainz server. The plugin does this when calling the ``beet absumbit [QUERY]`` command or on importing if the `auto` configuration option is set to ``yes``.
The `absubmit` plugin lets you submit acoustic analysis results to the
`AcousticBrainz`_ server.
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` also plugin requires `requests`_, which you can install using `pip_` by typing:
The `absubmit` also plugin 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`).
Submitting Data
---------------
Type::
beet absubmit [QUERY]
to run the analysis program and upload its results. This will work on any
music with a MusicBrainz track ID attached.
Configuration
-------------
@ -24,12 +35,9 @@ To configure the plugin, make a ``absubmit:`` section in your configuration file
- **extractor**: The absolute path to the `streaming_extractor_music`_ binary.
Default: search for the program in your ``$PATH``
Notes
-----
MusicBrainz track id is needed to use AcousticBrainz. Check the `streaming_extractor_music`_ download page for more information.
.. _streaming_extractor_music: http://acousticbrainz.org/download
.. _FAQ: http://acousticbrainz.org/faq
.. _pip: http://www.pip-installer.org/
.. _requests: http://docs.python-requests.org/en/master/
.. _github: https://github.com/MTG/essentia
.. _AcousticBrainz: https://acousticbrainz.org