sickprodigy/beets-music-management
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initialize files

Browse Source
This commit is contained in:
Aaron 2024-12-24 10:09:14 -05:00
commit 35ad746563
5 changed files with 519 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

201
LICENSE Normal file
View File

@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

22
README.md Normal file
View File

@ -0,0 +1,22 @@
# Beets Music Management Configs and file Examples Using Docker/Portainer
Hello everyone, I struggled with beets and figured I'd share a bit of information here for others to find and maybe explain some concepts behind them and how to use.
most of the configs and files above are well commented. So be sure to read through those first. THIS IS STILL IN TESTING PHASE, but is somewhat working without tearing up your library this way.
I generally use lidarr arr-scripts to manage my music library. Here is where I got with my testing.
How I'm running beats:
- Debian 12
- Docker
- Docker Compose (Optional- I just use it to spin up portainer)
- Portainer Business Edition (Optional- people say to not to use it, only reason I can see is random issues that pop up like this container can't be deleted or stack is stuck, does get annoying)
Note: things that say (redacted) must be replaced with your own api keys.
Discord if you need help: https://discord.gg/9xzTtCxauJ
Feel free to open an issue with questions.
Problems I couldn't solve:
- Why is spotify the only indexer showing up after running for x amount of time? While I still have dns access to the musicbrainz. weird block? would rather stop the software from running if can't reach ANY/ALL site/s, so I can get the best of what is available.
- How to use multi-indexers for genres combining them instead of using 1 site or the other. WLG is broken, could push PR for a method
- Exporting to .lrc file so navidrome and/or plex can read the lyrics while playing. Only options were .pdf x and y

230
config.yaml Normal file
View File

@ -0,0 +1,230 @@
# beets config file # removed wlg from below for now see something
plugins: fetchart embedart convert scrub replaygain lastgenre chroma web lyrics deezer spotify discogs smartplaylist albumtypes lastimport popularity mbsync
pluginpath: # manually importing with docker 'command' inside container and installing with bash script
/config/plugins-git/beets-popularity/beetsplug
# /config/plugins-git/whatlastgenre/plugin/beets/beetsplug
directory: /music
library: /config/musiclibrary.blb
art_filename: coverart
threaded: yes
per_disc_numbering: yes
original_date: yes # set to yes to have year month and day fields set to release date
sort_case_insensitive: yes # default: yes
id3v23: no
asciify_paths: true
match:
strong_rec_thresh: 0.10 # 0.04
medium_rec_thresh: 0.25 # 0.25
rec_gap_thresh: 0.25 # 0.25
max_rec:
missing_tracks: medium # medium
unmatched_tracks: medium # medium
track_length: medium
track_index: medium
distance_weights:
source: 2.0 # 2.0
artist: 3.0 # 3.0
album: 3.0 # 3.0
media: 1.0 # 1.0
mediums: 1.0 # 1.0
year: 1.0 # 1.0
country: 0.5 # 0.5
label: 0.5 # 0.5
catalognum: 0.5 # 0.5
albumdisambig: 0.5 # 0.5
album_id: 5.0 # 5.0
tracks: 2.0 # 2.0
missing_tracks: 0.9 # 0.9
unmatched_tracks: 0.6 # 0.6
track_title: 3.0 # 3.0
track_artist: 2.0 # 2.0
track_index: 1.0 # 1.0
track_length: 2.0 # 2.0
track_id: 5.0 # 5.0
preferred:
countries: [] # []
media: [] # []
original_year: no # no
ignored: ['missing_tracks', 'track_length', 'unmatched_tracks', 'track_index'] # []
required: [] # []
ignored_media: [] # []
ignore_data_tracks: yes # yes
ignore_video_tracks: yes # yes
track_length_grace: 10 # 10
track_length_max: 30 # 30
paths:
# lidarr Standard = {Album Title} ({Release Year})/{Artist Name}-{Album Title}-{track:00}-{Track Title}-[{MediaInfo AudioBitRate}]-{Release Group}
# lidarr Multi = {Album Title} ({Release Year})/CD{medium:00}/{Artist Name}-{Album Title}-CD{medium:00}-{track:00}-{Track Title}-[{MediaInfo AudioBitRate}]-{Release Group}
# Lidarr Artist Folder Name = {Artist Name}
default: $albumartist/$album ($original_year)/$albumartist-$album-$disc$track-$title-[$bitrate]
singleton: $albumartist/$title ($original_year)/$albumartist-$disc$track-title-[$bitrate]
comp: Various Artists/$album ($original_year)/$albumartist-$album-$disc$track-$title-[$bitrate]
albumtype_soundtrack: Various Artists/$album ($original_year)/$albumartist-$album-$disc$track-$title-[$bitrate]
acoustid:
apikey: (redacted)
albumtypes:
types:
- ep: 'EP'
- single: 'Single'
- soundtrack: 'OST'
- live: 'Live'
- compilation: 'Anthology'
- remix: 'Remix'
ignore_va: compilation
bracket: '[]'
chroma:
auto: no
convert:
auto: no
ffmpeg: /usr/bin/ffmpeg
opts: -ab 320k -ac 2 -ar 48000
max_bitrate: 320
threads: 1
deezer: # https://beets.readthedocs.io/en/latest/plugins/deezer.html
source_weight: 0.0
discogs:
source_weight: 0.5
embedart:
auto: yes
import:
write: yes
copy: no
move: no
autotag: yes # default yes
resume: ask # ask whether skip asis # disabling does nothing
incremental: no # enable if you don't want to overwrite same file
from_scratch: no # default: no
quiet: no # default: no, controlling whether to ask for a manual decision from the user when the importer is unsure how to proceed
quiet_fallback: skip # Either skip (default) or asis, specifying what should happen in quiet mode when there is no strong recommendation.
timid: no # asks for confirmation on every autotagging match, even the ones that seem very close.
duplicate_action: skip
log: /config/beet.log
languages: ['en']
group_albums: no
detail: yes
fetchart:
auto: yes
lastfm:
user: sickprod
api_key: (redacted)
lastgenre: # https://beets.readthedocs.io/en/latest/plugins/lastgenre.html#lastgenre-plugin
auto: yes # yes could cause issues with wlg running
count: 5
separator: '; '
source: track # default album, track will pull album and track genres
force: yes
min_weight: 5 # default 10
prefer_specific: yes # yes prefers specifc to canonical and whitelist, no ig doesn't use those
# canonical: yes
canonical: /config/genre-tree.yaml # able to use a path
whitelist: /config/genres-whitelist.txt
lyrics:
fallback: ''
google_API_key: (redacted)
google_engine_ID: (redacted)
auto: yes
sources: google genius tekstowo lrclib
musicbrainz: # https://beets.readthedocs.io/en/latest/reference/config.html#musicbrainz-options
source_weight: 0.0
enabled: yes
genres: no # default: no ; if set to yes will replace current genres using wlg for that # seemed with
external_ids:
discogs: yes
spotify: yes
bandcamp: yes
deezer: yes
tidal: yes
replace:
'^\.': _
'[\x00-\x1f]': _
'[<>:"\?\*\|]': _
'[\xE8-\xEB]': e
'[\xEC-\xEF]': i
'[\xE2-\xE6]': a
'[\xF2-\xF6]': o
'[\xF8]': o
'\.$': _
'\s+$': ''
replaygain:
auto: no
scrub:
auto: yes
smartplaylist:
auto: yes # default: yes
relative_to: /music/Music-Library
playlist_dir: /bpg
forward_slash: no
playlists:
- name: Popular.m3u
query: 'popularity:60..'
- name: Popular-HipHop.m3u
query: ['popularity:55..', 'genre:Hip Hop']
- name: popular_rap.m3u
query: ['popularity:55..', 'genre:Rap']
- name: popular_rock.m3u
query: ['popularity:50..', 'genre:Rock']
- name: All.m3u
query: ''
- name: HipHopGenre.m3u
query: 'genre:Hip Hop'
- name: 'HipHopReleasedIn$year.m3u'
query: ['genre:"Hip Hop"', 'year::201(0|9)']
- name: beatles.m3u
query: 'artist:Beatles'
spotify:
source_weight: 0.5
region_filter: US
mode: open # optional open sends a link to browser to open spotify with playlist created. can be list send a list of links
show_failures: yes
tiebreak: first
the: # The the plugin allows you to move patterns in path formats https://beets.readthedocs.io/en/stable/plugins/the.html
# removed from plugins: since not using currently
a: no
the: no
# patterns: [] # causes issues if no patterns defined..
strip: no
format: '{0} {1}'
ui:
color: yes
colors:
text_success: green
text_warning: yellow
text_error: red
text_highlight: red
text_highlight_minor: lightgray
action_default: turquoise
action: blue
web:
host: 0.0.0.0
port: 8337
# The below plugin is outdated, tried to force to work with a few bash commands automated, just wouldn't work.
# wlg: # whatlastgenre allows you to tag multiple genres from different sources. Some sources only have 1 genre to choose from, like to show up in a few other playlists
# auto: no
# force: no
# count: 5
# separator: ', '
# whitelist: beets # can be wlg, beets, or path beets uses whitelist dfined in lastgenre plugin

33
docker-compose-post-commands.sh Normal file
View File

@ -0,0 +1,33 @@
#!/bin/bash
# seems issues with python3-discogs and needs updated on first install so here
pip install python3-discogs-client pyacoustid mutagen requests rauth requests-cache build pylast
# needed for chroma # Not really needed apparently Keep reading to understand
# apt-get install gstreamer1.0 python-gi # debian version?
# apk add gstreamer1.0 python-gi # **seems chroma works already anyways so just saving for later**
# test using 'beet fingerprint'
# pip 24.0 seems to be latest for lsiopy version, can't get newer unless updating source
# pip install --upgrade pip
apk add git
# think clone needs to be run first, then you will get errors running additionally forgot the proper way to fix.
git clone https://github.com/abba23/beets-popularity.git /config/plugins-git/beets-popularity
# git pull https://github.com/abba23/beets-popularity.git /config/plugins-git/beets-popularity
# git pull https://github.com/YetAnotherNerd/whatlastgenre.git /config/plugins-git/whatlastgenre
# python -m pip install /config/plugins-git/whatlastgenre
python -m pip install /config/plugins-git/beets-popularity
# for some reason this file isn't getting copied over so let's try this # this does work, but wlg is just broken in newer version. Needs PR
# cp /config/plugins-git/whatlastgenre/plugin/beets/beetsplug/wlg.py /lsiopy/lib/python3.11/site-packages/beetsplug
# now pulling pluginpath: from the first location basically into the config.yml of beets now
# pluginpath acts like there's no wlg so removed it all together fuck it
# show the pip installed properly maybe
echo "All done Sick!"
# apparently need to tail a random file to keep the container running...
tail -f /dev/null

33
docker-compose.yml Normal file
View File

@ -0,0 +1,33 @@
# Beets software for music library management.
# Metadata, Lyrics, CoverArt, Create playlists, smart playlists, ratings, and loads more able to do
---
version: "2.1"
services:
beets:
image: lscr.io/linuxserver/beets:nightly # think latest is 1.6.0 and nightly is newer, maybe less issues idk
container_name: beets
environment:
- PUID=1000
- PGID=1006
- TZ=America/New_York
volumes:
- /docker-containers/beets:/config
- /Music/beetsplaylist:/bpg
- /Music/Testing:/music
# - /unsorted/beets:/music
- /unsorted/beets:/downloads
# seems like the easiest way to fix problems just install on each first run.. this fixed discogs but not wlg
# seems to be crashing about it tho
command: "/config/docker-compose-post-commands.sh" # Oh yeah, this was how i'm importing newest version of plugins, but doesn't work properly. let me upload too
ports:
- 8337:8337
# restart: unless-stopped # disabled to see if something shows
stdin_open: true # to attach to containers
tty: true # also used to attach to containers
# network_mode: service:wireguard # To run through vpn service container, in turn UI port must be forwarded inside vpn. No local access unless otherwise defined
networks: # Specify network for container
- homelab
networks: # I got everythign reversed proxied here. so easier to connect to some panel they offer.
homelab:
external: true # This option causes compose to join the above network instead of making a _default one (supposedly)