Skip to content

Commit

Permalink
update readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
apastel committed Nov 9, 2024
1 parent c6b7fb0 commit ecacd75
Show file tree
Hide file tree
Showing 3 changed files with 30 additions and 4 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
YTMusic Deleter is an installable program for performing batch delete operations on your YouTube Music library, since
currently there is no built-in option to do this. This tool is faster than browser-based / Javscript-based tools because
it uses the YouTube Music API to make rapid requests against your library instead of doing the deletion manually in your browser.
It also has additional features for playlist management, like sorting and removing duplicates.

If this project helped you and you want to thank me, you can <a href="https://www.buymeacoffee.com/jewbix.cube">get me a beer!</a>

Expand All @@ -29,8 +30,9 @@ Features
* Reset all of your "Liked" ratings
* Delete your play history
### Playlist Utilities
* Sort your playlists
* Sort your playlists using any combination of: Artist, Album, Track Title, and Duration
* Remove duplicates from your playlists
* Add all of your uploads or library songs to a particular playlist

![YTMusic Deleter screenshot](https://i.imgur.com/TVpB6xY.gif)

Expand Down
28 changes: 26 additions & 2 deletions ytmusic_deleter/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,16 @@ but may find inaccurrate matches in its current experimental state. Use the `--s
#### Non-deletion commands:
`sort-playlist`:&nbsp;&nbsp;&nbsp;&nbsp;Sort a playlist alphabetically by artist and then by song title.

>Use the `--shuffle` or `-s` option to shuffle the playlist instead of sorting it.
>Use the `--shuffle` or `-s` option to shuffle the playlist instead of sorting it.
Use `--custom-sort` or `-c` to define custom sort parameters Available parameters are: `artist`, `album_title`, `track_title`, and `duration`. See below for examples.
Use `--reverse` to reverse the sort order.

`remove-duplicates`:&nbsp;&nbsp;&nbsp;&nbsp;Remove duplicate tracks from a particular playlist.

>Use the `--exact` or `-e` option to only remove exact duplicates. This will skip the portion
that checks for duplicates that are similar matches but not the same exact track.

`add-all-to-playlist`:&nbsp;&nbsp;&nbsp;&nbsp;Add all library songs or uploads to a particular playlist.
#### Examples

Getting help:
Expand Down Expand Up @@ -75,11 +84,26 @@ Remove everything (uploads, library tracks, playlists, and unlike all songs):
```
ytmusic-deleter delete-all
```
Sort a playlist called **Workout Jams**:
Sort a playlist called **Workout Jams** using the default settings (sorts by artist then album title):
```
ytmusic-deleter sort-playlist "workout jams"
```

Sort a playlist using custom sorting attributes (attributes are applied in order):
```
ytmusic-deleter sort-playlist "workout jams" --custom-sort artist --custom-sort album_title --custom-sort track_title
```

Remove duplicate tracks from a playlist called "Focus"
```
ytmusic-deleter remove-duplicates focus
```

Add all uploads to a playlist called "All my uploads"
```
ytmusic-deleter add-all-to-playlist "All my uploads" --uploads
```

#### Extra options
These supplemental options are unlikely to be helpful for most use cases and are mainly to support the GUI version.
```
Expand Down
2 changes: 1 addition & 1 deletion ytmusic_deleter/cli.py
Original file line number Diff line number Diff line change
Expand Up @@ -360,7 +360,7 @@ def delete_all(ctx: click.Context):
@cli.command()
@click.argument("playlist_titles", nargs=-1, required=True)
@click.option("--shuffle", "-s", is_flag=True, help="Shuffle the playlist(s) instead of sorting.")
@click.option("--custom-sort", "-c", multiple=True, help="Enable custom sorting")
@click.option("--custom-sort", "-c", multiple=True, metavar="ATTRIBUTE", help="Enable custom sorting")
@click.option("--reverse", "-r", is_flag=True, help="Reverse the entire playlist after sorting")
@click.pass_context
def sort_playlist(ctx: click.Context, shuffle, playlist_titles, custom_sort, reverse):
Expand Down

0 comments on commit ecacd75

Please sign in to comment.