diff --git a/README.md b/README.md index 0cf7e72..8f70402 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Fully typed, no requirements. 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. -# Usage +# Installation Install package using `pip` @@ -18,22 +18,37 @@ Install package using `pip` pip install tiddl ``` -After installation use `tiddl` +After installation you can use `tiddl` to set up auth token ```bash $ tiddl ⚙️ Go to https://link.tidal.com/CYARD and add device! Hit enter when you are ready... ✅ Token good for 7 days -Enter track id to download: ``` +Use `tiddl -h` to show help message + +# Usage + +After authentication - when your token is ready - you can start downloading tracks + +- `tiddl -s -q high` sets high quality as default quality +- `tiddl TRACK_ID` downloads track with high quality +- `tiddl TRACK_ID -q master` downloads track with best possible quality +- `tiddl TRACK_ID -p my_folder -o my_song` downloads track to `my_folder/my_song.flac` +- `tiddl TRACK_ID -p my_folder -o my_song -s` same as above, but saves `my_folder` as default download path + You can also use TIDDL as module, it's fully typed so you will get type hints ```python from tiddl import TidalApi -api = TidalApi(token, user_id, country_code) +api = TidalApi( + config["token"], + config["user"]["user_id"], + config["user"]["country_code"] +) my_playlists = api.getPlaylists() diff --git a/setup.py b/setup.py index aef5b6c..7cc5d33 100644 --- a/setup.py +++ b/setup.py @@ -2,7 +2,7 @@ setup( name="tiddl", - version="0.1.0", + version="1.0.0", description="TIDDL (Tidal Downloader) is a Python CLI application that allows downloading Tidal tracks.", long_description=open('README.md').read(), long_description_content_type='text/markdown',