beets README

The project's README from github.com/beetbox/beets. As one markdown file: README.md.

.. image:: https://img.shields.io/pypi/v/beets.svg :target: https://pypi.python.org/pypi/beets

.. image:: https://img.shields.io/codecov/c/github/beetbox/beets.svg :target: https://app.codecov.io/github/beetbox/beets

.. image:: https://img.shields.io/github/actions/workflow/status/beetbox/beets/ci.yaml :target: https://github.com/beetbox/beets/actions

.. image:: https://repology.org/badge/tiny-repos/beets.svg :target: https://repology.org/project/beets/versions

beets

Beets is the media library management system for obsessive music geeks.

The purpose of beets is to get your music collection right once and for all. It catalogs your collection, automatically improving its metadata as it goes. It then provides a suite of tools for manipulating and accessing your music.

Here's an example of beets' brainy tag corrector doing its thing:

$ beet import ~/music/ladytron
Tagging:
    Ladytron - Witching Hour
(Similarity: 98.4%)
 * Last One Standing      -> The Last One Standing
 * Beauty                 -> Beauty*2
 * White Light Generation -> Whitelightgenerator
 * All the Way            -> All the Way...

Because beets is designed as a library, it can do almost anything you can imagine for your music collection. Via plugins_, beets becomes a panacea:

Fetch or calculate all the metadata you could possibly need: album art, lyrics, genres_, tempos_, ReplayGain_ levels, or acoustic fingerprints_.
Get metadata from MusicBrainz_, Discogs_, and Beatport_. Or guess metadata using songs' filenames or their acoustic fingerprints.
Transcode audio_ to any format you like.
Check your library for duplicate tracks and albums_ or for albums that are missing tracks_.
Clean up crufty tags left behind by other, less-awesome tools.
Embed and extract album art from files' metadata.
Browse your music library graphically through a Web browser and play it in any browser that supports HTML5 Audio_.
Analyze music files' metadata from the command line.
Listen to your library with a music player that speaks the MPD_ protocol and works with a staggering variety of interfaces.

If beets doesn't do what you want yet, writing your own plugin_ is shockingly simple if you know a little Python.

.. _acoustic fingerprints: https://beets.readthedocs.org/page/plugins/chroma.html

.. _album art: https://beets.readthedocs.org/page/plugins/fetchart.html

.. _albums that are missing tracks: https://beets.readthedocs.org/page/plugins/missing.html

.. _beatport: https://www.beatport.com

.. _discogs: https://www.discogs.com/

.. _duplicate tracks and albums: https://beets.readthedocs.org/page/plugins/duplicates.html

.. _genres: https://beets.readthedocs.org/page/plugins/lastgenre.html

.. _html5 audio: https://html.spec.whatwg.org/multipage/media.html#the-audio-element

.. _lyrics: https://beets.readthedocs.org/page/plugins/lyrics.html

.. _mpd: https://www.musicpd.org/

.. _musicbrainz: https://musicbrainz.org/

.. _musicbrainz music collection: https://musicbrainz.org/doc/Collections/

.. _plugins: https://beets.readthedocs.org/page/plugins/

.. _replaygain: https://beets.readthedocs.org/page/plugins/replaygain.html

.. _tempos: https://beets.readthedocs.org/page/plugins/acousticbrainz.html

.. _transcode audio: https://beets.readthedocs.org/page/plugins/convert.html

.. _writing your own plugin: https://beets.readthedocs.org/page/dev/plugins/index.html

Install

You can install beets by typing pip install beets or directly from Github (see details here_). Beets has also been packaged in the software repositories_ of several distributions. Check out the Getting Started_ guide for more information.

.. _getting started: https://beets.readthedocs.org/page/guides/main.html

.. _here: https://beets.readthedocs.io/en/latest/faq.html#run-the-latest-source-version-of-beets

.. _software repositories: https://repology.org/project/beets/versions

Contribute

Thank you for considering contributing to beets! Whether you're a programmer or not, you should be able to find all the info you need at CONTRIBUTING.rst_.

.. _contributing.rst: https://github.com/beetbox/beets/blob/master/CONTRIBUTING.rst

Learn more about beets at its Web site. Follow @b33ts on Mastodon for news and updates.

.. _@b33ts: https://fosstodon.org/@beets

.. _its web site: https://beets.io/

Contact

Encountered a bug you'd like to report? Check out our issue tracker_!
- If your issue hasn't already been reported, please open a new ticket_ and we'll be in touch with you shortly.
- If you'd like to vote on a feature/bug, simply give a :+1: on issues you'd like to see prioritized over others.
- Need help/support, would like to start a discussion, have an idea for a new feature, or would just like to introduce yourself to the team? Check out GitHub Discussions_!

.. _github discussions: https://github.com/beetbox/beets/discussions

.. _issue tracker: https://github.com/beetbox/beets/issues

.. _open a new ticket: https://github.com/beetbox/beets/issues/new/choose

Authors

Beets is by Adrian Sampson_ with a supporting cast of thousands.

.. _adrian sampson: https://www.cs.cornell.edu/~asampson/

15.8K ·GitHub

Beets

What is this?

Beets is the media library management system for obsessive music geeks: it catalogs your music collection, automatically improving its metadata as it goes, and then gives you a suite of tools for manipulating and accessing your music.

Is this a graphical app or something you drive from the command line?

It's a command-line tool at its core - you work through the 'beet' command - but it's designed as a Python library, and plugins can add things like a web-based library browser.

How do I get it installed?

Run 'pip install beets'. It can also be installed directly from GitHub and is packaged in the software repositories of several Linux distributions.

Is the automatic tagging always right?

It pulls metadata from MusicBrainz, Discogs, and Beatport; when those sources come up empty it can guess from song filenames or their acoustic fingerprints.

Will it catch duplicate tracks or albums with missing songs?

Yes - beets can check your library for duplicate tracks and albums, or for albums that are missing tracks.

Can it convert my music files to other formats?

Yes - it can transcode audio to any format you like.

Is beets free?

Yes - it's MIT-licensed open source, so it costs nothing to use.

What are similar projects?

AutoEq, noai-watermark, onthespot, spotify-tui, spleeter, Levyra-deepsound, pytube, soundcraft

Which topics is it in?

metadata, pypi, catalog, music, audio, command-line, hacktoberfest, plugin, free, automation, tool, library

Creator: beetbox
Size: 36.3 MB
Stars: 15.8K
Updated: CommitOct 09 Releasev2.14.1Sep 17
Age: 16y
Commits · 90 Days