Skip to content

Commit

Permalink
🚀 update for 1.0.0
Browse files Browse the repository at this point in the history
  • Loading branch information
oskvr37 committed Jul 27, 2024
1 parent db04061 commit 86513d4
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 5 deletions.
23 changes: 19 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,30 +10,45 @@ 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`

```bash
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()

Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -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',
Expand Down

0 comments on commit 86513d4

Please sign in to comment.