-
-It's inspired by [Tidal-Media-Downloader](https://github.com/yaronzz/Tidal-Media-Downloader) - currently not mantained project.
-This repository will contain features requests from that project and will be the enhanced version.
-
-> [!WARNING]
-> This app is for personal use only and is not affiliated with Tidal. Users must ensure their use complies with Tidal's terms of service and local copyright laws. Downloaded tracks are for personal use and may not be shared or redistributed. The developer assumes no responsibility for misuse of this app.
-
# Installation
-Install package using `pip`
+`tiddl` is available at [python package index](https://pypi.org/project/tiddl/) and you can install it with your favorite Python package manager.
+
+> [!IMPORTANT]
+> Also make sure you have installed [`ffmpeg`](https://ffmpeg.org/download.html) - it is used to convert downloaded tracks to proper format.
+
+## uv
+
+We recommend using [uv](https://docs.astral.sh/uv/)
+
+```bash
+uv tool install tiddl
+```
+
+## pip
+
+You can also use [pip](https://packaging.python.org/en/latest/tutorials/installing-packages/)
```bash
pip install tiddl
```
-Run the package cli with `tiddl`
+## docker
+
+**coming soon**
+
+# Usage
+
+Run the app with `tiddl`
```bash
$ tiddl
-Usage: tiddl [OPTIONS] COMMAND [ARGS]...
+ Usage: tiddl [OPTIONS] COMMAND [ARGS]...
- TIDDL - Tidal Downloader ♫
+ tiddl - download tidal tracks ♫
-Options:
- -v, --verbose Show debug logs.
- -q, --quiet Suppress logs.
- -nc, --no-cache Omit Tidal API requests caching.
- --help Show this message and exit.
-
-Commands:
- auth Manage Tidal token.
- config Print path to the configuration file.
- fav Get your Tidal favorites.
- file Parse txt or JSON file with urls.
- search Search on Tidal.
- url Get Tidal URL.
+╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ --omit-cache --no-omit-cache [default: no-omit-cache] │
+│ --debug --no-debug [default: no-debug] │
+│ --install-completion Install completion for the current shell. │
+│ --show-completion Show completion for the current shell, to copy it or customize │
+│ the installation. │
+│ --help Show this message and exit. │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
+╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────╮
+│ auth Manage Tidal authentication. │
+│ download Download Tidal resources. │
+╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
-> [!NOTE]
-> Also make sure you have installed `ffmpeg` if you want to convert track file extensions.
+## Authentication
-## Dockerised Version (no Python required)
-
-Based on python:alpine, slim build
-**Docker run example (quickest / easiest)**
-
-```
-docker run -rm -v /downloads/dir:/root/Music/Tiddl/ -v ./config/tiddl/:/root/ ghcr.io/oskvr37/tiddl:latest
-```
-
-**docker-compose.yml example (not required, though allows for advanced configs)**
-
-```
-services:
- tiddl:
- container_name: tiddl
- image: ghcr.io/oskvr37/tiddl:latest
- volumes:
- - /downloads/dir:/root/Music/Tiddl/ #default dir
- - ./config/tiddl/:/root/ # Default location of config file
- command: tail -f /dev/null # Keep it running in background
-```
-
-**Access the container:**
-
-```
-docker exec -it tiddl sh
-```
-
-_all other instructions match python version_
-
-# Basic usage
-
-## Login with Tidal account
+Login to app with your Tidal account: run the command below and follow instructions.
```bash
tiddl auth login
```
-## Download resource
+## Downloading
-You can download track / video / album / artist / playlist
+You can download tracks / videos / albums / artists / playlists / mixes.
```bash
-tiddl url https://listen.tidal.com/track/103805726 download
-tiddl url https://listen.tidal.com/video/25747442 download
-tiddl url https://listen.tidal.com/album/103805723 download
-tiddl url https://listen.tidal.com/artist/25022 download
-tiddl url https://listen.tidal.com/playlist/84974059-76af-406a-aede-ece2b78fa372 download
+$ tiddl download url UBVjd%Y{>>T$YAS@R{8*_b-N%
z=2!&R7$Y(IM)ll^WX$T6u;ME!-&nh%SnO$Onq7-YO?B2E7O<-CF7zr4OYE~G+RH!v
zv?tKZNWpwh+Gb1DHOAyx9&f Pl7|J<;cFiw)Xy`sDy=;cT+W=6p9u~>UyoTTBP>Qe`lIU{
zZ!e_b=nql-d6_8LakSYgp|bYww^}Z@4`&eWb{bG`X4-Y8Xc1SEZ_;|j-F(oi>N=N8
zM48=0>GgK{)LrXpiqu5%%8&0~<=D9gexRg@xvY+h_Cv|6Y`B;PuX{s0`o1JInda_c
zw&wJKDs|=R^F4fmcL^rFVsYpnMn(}XS_PZj2B%Y`w2A9kau-w%SDosU*}7Y%=NyXG
z$KUAP6q=?;xyZUCC`LWO8?G#kBp5ow_fn*GM|<-*=Q#OqBAv2c^ISI1(*~t$W3>LT
zp0&3$`F5bb5SF^~wI}=)uEJkDDVk&FQb>FshO!_AOF3$&%&QW8*d~#DPfhB;DvZwP
zMp*e=o^^8lIv4a_2C >u?gmiO1yIJrrpH+a}^@&+uU>#nR`qgL=4d=H7JfqrjP2A
z4DrNXb7^7{FUBv3pNg_OEc&|0kBru%m;?)$_M|zo9$v}T7Ey!lBx|uZTjnUYF5AN>
z=Os7rmQus&2b=l74L(GFhQ+9qGfyf%rj-a0c4}-s!c?O^ihmP%;YIYe7Xda#OxI;~
z8WhCAZPXB#yX9$Q2Yf%6b{e96GMU#WJ0yMc8q&$AfuP;tDa)S>E7&|Xk)$SQuX!>e
zek1O>U$pe32zc~w<&VWV<{fC%l{Xe_y6$o%vf!Mw!=bQ}?#-*Cjy!xaw*1D<+c8(7
zN !}UwsO}ckH
znt1BvdQu+DvNG
z&Ze&zMmhBDLb^kkQWHGc3n%Hes#1S9S4MXG6nS{bWyExmBWp)i>``P!Mk`|W_N{Q2
z3LWlB!j#|<47Kl;kTxYuZCxSe_hL4Qs>x4QFd-doq9Ey2SgEz?eaTq%==c%pi2_DT
zDOrhP89|lX7K%k|G&m7#4-Ew4n4s