Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/melchor629/youtubedl-audio-api
An RESTful API for YoutubeDL that only returns audio URLs
https://github.com/melchor629/youtubedl-audio-api
dockerfile flask python python3 restful-api youtube-dl
Last synced: about 3 hours ago
JSON representation
An RESTful API for YoutubeDL that only returns audio URLs
- Host: GitHub
- URL: https://github.com/melchor629/youtubedl-audio-api
- Owner: melchor629
- Created: 2018-03-24T16:51:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T16:41:10.000Z (2 months ago)
- Last Synced: 2024-09-05T23:51:44.552Z (2 months ago)
- Topics: dockerfile, flask, python, python3, restful-api, youtube-dl
- Language: Python
- Homepage:
- Size: 335 KB
- Stars: 18
- Watchers: 7
- Forks: 11
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# YouTube-DL Audio API
An pythonic RESTful API for getting URL of YouTube videos with only audio or video+audio, perfect for playing in background reducing the network bandwith. Uses [yt-dlp][1] for the queries, and [Flask][2] for the web microframework.
## Requirements
The project requires Python 3.10 or higher, and install some dependencies.
```bash
pipenv install
```
For local development, `pipenv` will create a virtual environment for you. There's a [Dockerfile][3] available for creating an image.
You can use the Docker image to use it in development. (see Docker section) This command should do the trick:
```bash
docker container run --rm -it -p 5000:5000 melchor9000/youtubedl-audio-api
```
## Using the web
By default, running the app with `flask --app ytdl_audio_api.app run --debug` will run on http://localhost:5000 . If you set the environment variable `PORT` to some port, it will listen for everyone at the specified port.
The app can be scalated using `gunicorn -c gunicorn_config.py ytdl_audio_api.wsgi`. Is configured to use `gevent` for asynchronous serving.
You can deploy the app to [Heroku][4] or into a [Docker][3] environment.
> **Note**: by default it will use `2 * Cores + 1` workers. You can change this using the `WORKERS`
> environment variable. In Heroku this is mandatory, so add a "Config Var" called `WORKERS` and put
> a value of 1 or 2 (if using the free dyno).
## RESTful API
The API is described in the [OpenApi Schema][oas] or in the `/oas.yaml`/`/swagger.yaml` of a deployed service. Use , (filling the URL at the top) or any other Swagger UI instance to see the API and its documentation.
With the spec, you can also generate clients to talk to your own instance on to my public instance.
## Docker
By default, the Docker image created will publish the web in the port 5000. Uses the `python:3` image.
An example of building the image, running and testing:
```bash
docker image build -t yt-audio-api .
docker container run -d --rm -p 5000:5000 yt-audio-api # or melchor9000/youtubedl-audio-api from Docker Hub
curl http://localhost:5000/api/0RLvtm0EghQ
```
It is available a `docker-compose.yaml` file to test it out. Uses the image from Docker Hub and a redis server for caching.
## Cache
Some request can be cached using Redis. The only thing you must do to use Redis is setting the environment
variable `REDIS` (or `REDIS_URL` useful for Heroku) with the url of the server.
## Logging
The server has logging for some points of functions. To modify the logging level, set `LOGGING_LEVEL` environment variable to the value you want. Valid values are `CRITICAL`, `FATAL`, `ERROR`, `WARNING`, `WARN`, `INFO`, `DEBUG` or `NOTSET`, see [logging][5] from Python.
## Proxy
You can set a proxy with the environment variable `PROXY`. Supported proxy protocols are http, https and socks5.
If you want to use a proxy as a fallback, use `FALLBACK_PROXY`. This will be used if any call to the YT API fails.
## CORS
By default, CORS is set to allow all origins. This can be overriden by defining the environment variable `CORS_ORIGINS` with a comma-separatid list of origins.
## Pretty JSONs
If, for some reason, you want to get the JSONs in a pretty format, set `JSONIFY_PRETTYPRINT_REGULAR` environment variable to `true`.
[1]: https://github.com/yt-dlp/yt-dlp
[2]: http://flask.pocoo.org
[3]: https://docker.com
[4]: https://heroku.com
[5]: https://docs.python.org/3/library/logging.html#logging-levels
[oas]: https://github.com/melchor629/youtubedl-audio-api/blob/master/ytdl_audio_api/oas.yaml