simplified readme (#25)

This commit is contained in:
Jesse Bannon 2022-05-15 21:56:43 -07:00 committed by GitHub
parent d17f677db3
commit 3543101592
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 9 additions and 28 deletions

View file

@ -16,6 +16,7 @@ and prepares it for consumption in your favorite media player
[Plex](https://github.com/plexinc/pms-docker), [Plex](https://github.com/plexinc/pms-docker),
[Emby](https://github.com/plexinc/pms-docker), [Emby](https://github.com/plexinc/pms-docker),
modern music players). modern music players).
We recognize that everyone stores their We recognize that everyone stores their
media differently. Our approach for file and metadata formatting is to provide media differently. Our approach for file and metadata formatting is to provide
maximum flexibility while maintaining simplicity. Read more about it maximum flexibility while maintaining simplicity. Read more about it
@ -24,7 +25,7 @@ maximum flexibility while maintaining simplicity. Read more about it
## Supported Features ## Supported Features
Below lists supported download schemes. You can see our Below lists supported download schemes. You can see our
[various example configurations](https://github.com/jmbannon/ytdl-sub/tree/master/examples) [various example configurations](https://github.com/jmbannon/ytdl-sub/tree/master/examples)
we personally use to get an idea on how to use ytdl-sub to your liking. to get an idea on how to use ytdl-sub to your liking.
- Download any and all audio/video from a channel or playlist - Download any and all audio/video from a channel or playlist
- Format videos to look like - Format videos to look like
@ -70,7 +71,7 @@ to look like:
### config.yaml ### config.yaml
The config file defines _how_ to download and format media. You can define any The config file defines _how_ to download and format media. You can define any
number of presets to represent media as whatever you want. number of presets to represent media how you see fit.
```yaml ```yaml
configuration: configuration:
working_directory: '.ytdl-sub-downloads' working_directory: '.ytdl-sub-downloads'
@ -170,26 +171,6 @@ ytdl-sub dl \
--overrides.tv_show_name "John /\ Smith" --overrides.tv_show_name "John /\ Smith"
``` ```
### REST API [not available yet]
The dream will be to create mobile apps or browser extensions to invoke
downloads from the couch. Once the server and API is written, the short-term
plan is to self-host a swaggerhub io instance and invoke the rest api from the
browser. It will be a while before this gets implemented, but when it does, it
will look like this.
```commandline
# spin-up the server
ytdl-sub server
```
POST request to invoke the same one-time download example via REST.
```commandline
curl -X POST -H "Content-type: application/json" \
-d '{ \
"youtube.channel_id": "UCsvn_Po0SmunchJYtttWpOxMg" \
"overrides.tv_show_name": "John /\ Smith" \
}' \
'localhost:8080/yt_channel_as_tv'
```
## Installation ## Installation
Once we are ready for our first release, we will add this package to pypi. Then, Once we are ready for our first release, we will add this package to pypi. Then,
we plan to create a docker image that uses the we plan to create a docker image that uses the

View file

@ -1,15 +1,15 @@
ytdl-sub: to enjoy media in your favorite player ytdl-sub: to enjoy media in your favorite player
================================================ ================================================
ytdl-sub is an `open-source <https://github.com/jmbannon/ytdl-sub>`_ ytdl-sub automates downloading media and preparing it for
python app that automates downloading media and preparing it for consumption in your favorite media player. It is
consumption in your favorite media player in the most hassle-free way `open-source <https://github.com/jmbannon/ytdl-sub>`_
possible. and written entirely in Python.
If you are new to ytdl-sub, head over to the If you are new to ytdl-sub, head over to the
:doc:`Getting Started <getting_started>` :doc:`Getting Started <getting_started>`
page. This guide explains how you can use ytdl-sub, install, configure it to download page to see how you can use ytdl-sub, install, configure it
various types of media, and start downloading. to your liking, and start downloading.
Contents Contents
======== ========