Go to file
Hazel c131924577
ci/woodpecker/push/woodpecker Pipeline was successful Details
Merge pull request 'fix/clean_feature_artists' (#38) from fix/clean_feature_artists into experimental
Reviewed-on: #38
2024-05-21 12:08:04 +00:00
.idea feat: hooked into ytdl to sign the function 2024-01-31 15:07:49 +01:00
.vscode fix: wrong creation of source types 2024-05-15 14:21:15 +02:00
assets fix: if request fails in a connection without host it raised an exception 2024-04-25 22:29:43 +02:00
development feat: added recursive structure 2024-05-16 14:29:50 +02:00
documentation feat: highlight downloadebel options 2024-01-16 10:08:08 +01:00
music_kraken fix: tests were a mess and didn't properly test the functionality but random things that worked with implementation 2024-05-21 13:52:20 +02:00
tests fix: tests were a mess and didn't properly test the functionality but random things that worked with implementation 2024-05-21 13:52:20 +02:00
.env.example feat: auto disable debug on deploy 2024-04-10 12:18:32 +02:00
.gitignore ci: add _version.py to gitignore 2024-04-15 12:42:57 -07:00
.woodpecker.yml ci: make tags release to the music-kraken pypi package instead of music-kraken-stable 2024-05-07 16:07:45 +00:00
LICENSE Initial commit 2022-10-14 13:02:01 +02:00
README.md feat: added links to wiki 2024-05-07 11:17:36 +02:00
build ci: add pipeline 2024-04-15 11:44:19 -07:00
contribute.md updated documentation 2023-06-23 13:35:53 +02:00
notes.md fixed tests, they pass now 2023-03-24 10:30:40 +01:00
pyproject.toml feat: tracksort and albumsort + some other stuff 2024-05-13 14:22:33 +02:00
requirements-dev.txt feat: build script 2024-04-09 11:48:32 +02:00

README.md

Music Kraken

Woodpecker CI Status

music kraken logo

If you want to use this a library or contribute, check out the wiki for more information.


Installation

You can find and get this project from either PyPI as a Python-Package, or simply the source code from Gitea. **

NOTES

  • Even though everything SHOULD work cross-platform, I have only tested it on Ubuntu.
  • If you enjoy this project, feel free to give it a star on GitHub.

From source

git clone https://gitea.elara.ws/music-kraken/music-kraken-core.git
python3 -m pip install -e music-kraken-core/

To update the program, if installed like this, go into the music-kraken-core directory and run git pull.

Get it running on other Systems

Here are the collected issues, that are related to running the program on different systems. If you have any issues, feel free to open a new one.

Windows + WSL

Add ~/.local/bin to your $PATH. #2

Quick-Guide

The Genre you define at the start, is the folder my program will download the files into, as well as the value of the ID3 genre field.

When it drops you into the shell 2 main things are important:

  1. You search with s: <query/url>
  2. You choose an option with just the index number of the option
  3. You download with d: <options/url>, where the options are comma separated

Query

The syntax for the query is really simple.

> s: #a <any artist>
searches for the artist <any artist>

> s: #a <any artist> #r <any release>
searches for the release (album) <any release> by the artist <any artist>

> s: #r <any release> Me #t <any track>
searches for the track <any track> from the release <any relaese>

The escape character is as usual \.


Matrix Space

music-kraken logo

I decided against creating a discord server, due to various communities get often banned from discord. A good and free Alternative are Matrix Spaces. I recommend the use of the Client Element. It is completely open source.

Click this invitation (https://matrix.to/#/#music-kraken:matrix.org) to join.