danvics/ytdl-sub
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

update readme again

Browse source
This commit is contained in:
jbannon 2022-04-01 19:14:57 +00:00
parent 02203e3a7b
commit f3b7be04b6
1 changed files with 31 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
README.md
View file

@ -228,7 +228,7 @@ Rammstein:
artist: "Rammstein" artist: "Rammstein"
``` ```
You can have multiple subscription files for better organizing. Now that that is defined, we can invoke the download You can have multiple subscription files for better organizing. We can invoke the subscriptoin download
using the command below. This makes it easy to use `ytdl-sub` in a cron job. using the command below. This makes it easy to use `ytdl-sub` in a cron job.
```shell ```shell
ytdl-sub sub subscription.yaml ytdl-sub sub subscription.yaml
@ -257,17 +257,38 @@ ytdl-sub server
``` ```
POST request to invoke the same one-time download example via REST. POST request to invoke the same one-time download example via REST.
```commandline ```commandline
curl -X POST -H "Content-type: application/json" \ curl -X POST -H "Content-type: application/json" \
-d '{ \ -d '{ \
"soundcloud.username": "alis_on", \ "soundcloud.username": "alis_on", \
"overrides": { \ "overrides.artist": "A.L.I.S.O.N.", \
"artist": "A.L.I.S.O.N.", \ "overrides.genre": "Synthwave;Electronic;Instrumental" \
"genre": "Synthwave;Electronic;Instrumental" \ }' \
} \ 'localhost:8080/soundcloud_discography'
}' \
'localhost:8080/soundcloud_wih_id3_tags'
``` ```
## Other Nice-To-Have Feature Ideas [not available yet]
### Check existing media before downloading
Right now, ytdl-sub will naively download everything in the given playlist/artist url. We should check the destination
directory first to see if it has already been downloaded. Might involve including a tag with its ytdl id.
### More download strategies
Only full artist (soundcloud) and playlists (youtube) are currently supported. Add new ones for single song/video
downloads.
### Make adding new sources easy to implement
Developers should not have to work around spaghetti to add new sources to ytdl-subscribe. It should be very modularized
and definable in a separate file as a plugin.
### Musicbrainz Integration
Integration with musicbrainz to fetch correct artist names, song titles, ids, etc and make those tags usable would be
a great feature for OCD music hoarders like myself, and would play nicely with existing collections to ensure
files land in the same directory. This can be worked around for now by using overrides.
### Configurable Time Windows to Delete Stale Media
There are some news channels and podcasts that I'd like to download but only keep the prior 2 weeks-worth of videos.
This would have to introspect files that reside in the host filesystem. Extreme caution would be required since we are
perma-deleting files.
## Contributing ## Contributing
I would like to get this to a point where I create a stable release before I accept PRs from the outside world. In the I would like to get this to a point where I create a stable release before I accept PRs from the outside world. In the
meantime, any feedback in the form of a Github issue would be greatly appreciated and taken into consideration. meantime, any feedback in the form of a Github issue would be greatly appreciated and taken into consideration.