https://github.com/OpenGenus/vidsum
Generate summary of any video :tv: anywhere and anytime
https://github.com/OpenGenus/vidsum
opengenus python video video-summarization youtube
Last synced: 7 months ago
JSON representation
Generate summary of any video :tv: anywhere and anytime
- Host: GitHub
- URL: https://github.com/OpenGenus/vidsum
- Owner: OpenGenus
- License: gpl-3.0
- Created: 2017-08-23T20:35:18.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T00:38:54.000Z (about 3 years ago)
- Last Synced: 2025-07-08T09:28:45.252Z (8 months ago)
- Topics: opengenus, python, video, video-summarization, youtube
- Language: Python
- Homepage:
- Size: 3.41 MB
- Stars: 270
- Watchers: 20
- Forks: 70
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## Generate summary of any video
Generate a summary of any video through its subtitles.
This is the community driven approach towards the summarization by the **[OpenGenus](https://github.com/opengenus)** community.
# Installing vidsum
In order to install vidsum, simply clone the repository to a local directory. You can do this by running the following commands:
```sh
$ git clone https://github.com/OpenGenus/vidsum.git
$ cd vidsum/code
```
Please note that vidsum requires the following packages to be installed:
- [pysrt](https://github.com/byroot/pysrt)
- [imageio](https://imageio.github.io/)
- [moviepy](https://zulko.github.io/moviepy/)
- [pytube](https://github.com/nficano/pytube)
- [sumy](https://github.com/miso-belica/sumy)
If you do not have these packages installed, then you can do so by running this command:
```sh
$ pip install -r requirements.txt
```
# Usage
To generate summary of a video file `sample.mp4` with subtitle file `subtitle.srt` :
```python
python sum.py -i sample.mp4 -s subtitle.srt
```
To summarize a YouTube video from its url:
```python
python sum.py -u
```
If you want to remain the downloaded YouTube video and subtitles:
```python
python sum.py -u -k
```
# Future developments
For future development to this approach, see [Wiki](https://github.com/OpenGenus/vidsum/wiki/Future_developments) and check out other [approaches](https://github.com/OpenGenus/vidsum/wiki/Other-approaches).
# Contributions
All contributions are welcomed. Please see [COMMIT_TEMPLATE.md](https://github.com/OpenGenus/vidsum/blob/master/.github/COMMIT_TEMPLATE.md) before making pull requests to this repository. See all contributors [here](https://github.com/OpenGenus/vidsum/graphs/contributors).