Metadata-Version: 2.1
Name: beets-lidarr-fields
Version: 1.1.2
Summary: Beets plugin that defines some useful template fields to customize your path formats in a more lidarr way.
Home-page: https://github.com/rafaelparente/beets-lidarr-fields
Author: Rafael Parente
Author-email: rafaelp.dev@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Plugins
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Multimedia :: Sound/Audio
Requires-Python: >=3.4.0
Description-Content-Type: text/markdown
Requires-Dist: beets
Requires-Dist: musicbrainzngs


**Beets - Lidarr Fields**
=========================

This is a plugin for [Beets](https://github.com/beetbox/beets).
It provides some template fields to customize your path formats in
a more [Lidarr](https://github.com/lidarr/Lidarr) way.
It works faster than using the built-in inline plugin because it
evaluates those fields only once per album (same value for all tracks).
Currently, this plugin provides three template fields:

* releasegroupartist  
  It refers to the "Release Group Artist" (or the first one if multiple)
  which is whom Lidarr links a release to.

* lidarralbum  
  Original album name, but with illegal characters replaced
  the same way Lidarr does it.

* audiodisctotal  
  Similar to beet's 'disctotal' field, only it ignores video medias like
  Blu-ray, DVD, etc.

*Plugin only lightly tested by me. Use at your own risk!*


**Install**
===========

To install it, use pip:

    pip install beets-lidarr-fields

or

    git clone https://github.com/rafaelparente/beets-lidarr-fields.git
    cd beets-lidarr-fields
    python setup.py install


**Configuration**
=================

Enable the plugin in beets' config.yaml

    plugins: lidarrfields

How to use it
-------------

Use it to build your path formats in beet's config.yaml,
like it's explained in the [Beets Docs](https://beets.readthedocs.io/en/stable/reference/pathformat.html).
To make it look like Lidarr's default format, set it like:

    paths:
        default: $releasegroupartist/$lidarralbum ($year)/%if{$audiodisctotal,$disc - }${track}. $title

    per_disc_numbering: yes

Be aware that the ``aunique`` template function will
(most likelly) **not** work on lidarralbum.

## Contributors ✨

Thanks goes to these wonderful people:

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
  <tr>
    <td align="center"><a href="https://github.com/mod242"><img src="https://avatars.githubusercontent.com/u/40213799?v=3?s=100" width="100px;" alt=""/><br /><sub><b>mod242</b></sub></a><br /><a href="https://github.com/rafaelparente/beets-lidarr-fields/commits?author=mod242" title="Code">💻</a> </td>
	<td align="center"><a href="https://github.com/DOFfactory"><img src="https://avatars0.githubusercontent.com/u/10846169?v=4?s=100" width="100px;" alt=""/><br /><sub><b>DOFfactory</b></sub></a><br /><a href="https://github.com/rafaelparente/beets-lidarr-fields/issues?q=author:DOFfactory" title="Bug reports">🐛</a></td>
  </tr>
</table>

<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

<!-- ALL-CONTRIBUTORS-LIST:END -->

