Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dxsooo/videodownload
VideoDownload tool for Youtube/BiliBili
https://github.com/dxsooo/videodownload
bilibili celery download downloader python video-downloader youtube
Last synced: 1 day ago
JSON representation
VideoDownload tool for Youtube/BiliBili
- Host: GitHub
- URL: https://github.com/dxsooo/videodownload
- Owner: dxsooo
- License: apache-2.0
- Created: 2022-08-07T09:06:51.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T16:02:38.000Z (18 days ago)
- Last Synced: 2024-10-28T18:14:11.685Z (18 days ago)
- Topics: bilibili, celery, download, downloader, python, video-downloader, youtube
- Language: Python
- Homepage:
- Size: 405 KB
- Stars: 14
- Watchers: 3
- Forks: 0
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# VideoDownload
[](./LICENSE)
[](https://github.com/dxsooo/VideoDownload/releases/latest)
[](https://www.codefactor.io/repository/github/dxsooo/videodownload)
[](https://codecov.io/gh/dxsooo/VideoDownload)
[](https://bestpractices.coreinfrastructure.org/projects/7265)
[](https://hub.docker.com/r/dxsooo/video-download)
VideoDownload tool for *Youtube/BiliBili*
- [Basic Usage](#basic-usage)
- [With source code](#with-source-code)
- [With Docker](#with-docker)
- [Additional Configuration](#additional-configuration)
- [Celery Mode](#celery-mode)
- [Contributing](./CONTRIBUTING.md)
- [Thanks](#thanks)
## Basic Usage
### With source code
Requirements:
- Aria2 (for Youtube)
- FFmpeg (for Youtube、BiliBili)
- Poetry (as package management)
- Python 3.8.3+
Setup:
```bash
git clone https://github.com/dxsooo/VideoDownload.git
cd VideoDownload
# unix like systems
poetry export -f requirements.txt --without-hashes | pip install -r /dev/stdin
# for windows powershell or cmd
poetry export -f requirements.txt --output requirements.txt --without-hashes
pip install -r requirements.txt
```
Run:
```bash
python download.py -u
```
VideoURL is the video playing url and the url pattern should follow:
|source|url pattern|
|-|-|
|Youtube||
|BiliBili| or |
The video is saved in `videos/` of the current path and named with video id.
There are more options:
```bash
% python download.py --help
usage: download.py [-h] -u URL [-d DIR]
options:
-h, --help show this help message and exit
-u URL, --url URL video playing url
-d DIR, --dir DIR video save directory
```
### With Docker
You can easily download video by docker:
```bash
docker run -t -v/path/to/save:/app/videos dxsooo/video-download:0.4.11 download.py -u
```
## Additional Configuration
As [YT-DLP](https://github.com/yt-dlp/yt-dlp) is used in youtube download, a method to config its options is provided. You can add an ini file in `configs/youtube.ini` with content like:
```ini
[ydl_opts]
max_filesize=314572800 ; limit file size, 300M
subtitleslang=en.* ; set subtitles langs to en, default is zh
```
> You can also mount the ini file to docker container for configuration.
## Celery Mode
VideoDownload can also work as a [Celery](https://docs.celeryq.dev/en/stable/index.html) worker that receive download tasks, making it possible and convenient to deploy in distribute systems and integrate with cloud-native services.
It is recommended to use by docker:
```bash
docker run -d --name video-downloader-1 \
-e BROKER=${YOUR_CELERY_BROKER} \
-e BACKEND=${YOUR_CELERY_BACKEND} \
-v /path/to/save:/app/videos \
--entrypoint=celery \
dxsooo/video-download:0.4.11 -A celery_worker worker -c 4 -E
```
> For BiliBili, as some deps could not run with multi process, concurrency(-c) should be 1. But it is ok to run multi docker containers to walk around.
And then you can send task by one of the following methods:
### 1.with Celery, Python only
```python
# pip install celery
from celery import Celery
celery = Celery(broker="")
celery.send_task('celery_worker.download',("",))
```
### 2.use REST API from celery flower, language-independent
Start flower by:
```bash
docker run -d --name video-downloader-flower \
-e BROKER=${YOUR_CELERY_BROKER} \
-e BACKEND=${YOUR_CELERY_BACKEND} \
--entrypoint=celery \
-p 5555:5555 \
dxsooo/video-download:0.4.11 -A celery_worker flower
```
Example request:
```http
POST /api/task/async-apply/celery_worker.download HTTP/1.1
Accept: application/json
Accept-Encoding: gzip, deflate, compress
Content-Type: application/json; charset=utf-8
Host: localhost:5555
{
"args": [""]
}
```
> if you want to use custom queue instead of the default `celery`, start worker with `-Q `, and send request refer
Read the source code for more parameters to control task.
## Thanks
- [Bilix](https://github.com/HFrost0/bilix)
- [YT-DLP](https://github.com/yt-dlp/yt-dlp)