beets/docs/plugins/autobpm.rst
Šarūnas Nejus 03cf567a90
autobpm: Add autobpm extra and update the docs
Given that librosa has been introducing breaking changes like there's no
tomorrow, use '^' version specifier to only allow updating the patch
version.
2024-08-19 22:44:16 +01:00

32 lines
917 B
ReStructuredText

AutoBPM Plugin
==============
The `autobpm` plugin uses the `Librosa`_ library to calculate the BPM
of a track from its audio data and store it in the `bpm` field of your
database. It does so automatically when importing music or through
the ``beet autobpm [QUERY]`` command.
Install
-------
To use the ``autobpm`` plugin, first enable it in your configuration (see
:ref:`using-plugins`). Then, install ``beets`` with ``autobpm`` extra
.. code-block:: bash
pip install "beets[autobpm]"
Configuration
-------------
To configure the plugin, make a ``autobpm:`` section in your
configuration file. The available options are:
- **auto**: Analyze every file on import.
Otherwise, you need to use the ``beet autobpm`` command explicitly.
Default: ``yes``
- **overwrite**: Calculate a BPM even for files that already have a
`bpm` value.
Default: ``no``.
.. _Librosa: https://github.com/librosa/librosa/