From 1a91f1a3f668f5e4f737e2634beaaecb982e2584 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Herv=C3=A9=20Beraud?= Date: Sat, 12 May 2018 11:56:08 +0200 Subject: [PATCH] introduce more python way to install vidsum --- .gitignore | 5 ++++ README.md | 31 ++++++++++-------------- setup.cfg | 32 +++++++++++++++++++++++++ setup.py | 7 ++++++ vidsum/__init__.py | 0 code/sum.py => vidsum/__main__.py | 6 ++++- {code => vidsum}/data/1.srt | 0 {code => vidsum}/data/1_summarized.mp4 | Bin 8 files changed, 61 insertions(+), 20 deletions(-) create mode 100644 .gitignore create mode 100644 setup.cfg create mode 100644 setup.py create mode 100644 vidsum/__init__.py rename code/sum.py => vidsum/__main__.py (99%) rename {code => vidsum}/data/1.srt (100%) rename {code => vidsum}/data/1_summarized.mp4 (100%) diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..42e45ec --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +Pipfile +build/ +dist/ +vidsum.egg-info/ +*.pyc diff --git a/README.md b/README.md index 22fc36c..261afe3 100644 --- a/README.md +++ b/README.md @@ -6,39 +6,32 @@ This is the community driven approach towards the summarization by the **[OpenGe # 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 +In order to install vidsum: +- simply clone the repository to a local directory. +- install pbr as a dependency for building the package. +- install vidsum -``` -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: +You can do this by running the following commands: ```sh -$ pip install -r requirements.txt - +$ git clone https://github.com/OpenGenus/vidsum.git +$ pip install pbr +$ python setup.py install ``` +The previous command automaticaly install all requirements needed. # 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 +vidsum -i sample.mp4 -s subtitle.srt ``` To summarize a YouTube video from its url: ```python -python sum.py -u +vidsum -u ``` If you want to remain the downloaded YouTube video and subtitles: ```python -python sum.py -u -k +vidsum -u -k ``` # Future developments diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 0000000..d1d285e --- /dev/null +++ b/setup.cfg @@ -0,0 +1,32 @@ +[metadata] +name = vidsum +home-page = https://github.com/OpenGenus/vidsum +summary = Generate summary of any video anywhere and anytime +description-file = + README.md +author = OpenGenus +author-email = team@opengenus.org +licence = GNU General Public License v3 (GPLv3) +classifier = + Development Status :: 5 - Production/Stable + Intended Audience :: Information Technology + License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+) + Operating System :: POSIX + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.4 + Programming Language :: Python :: 3.5 + Programming Language :: Python :: 3.6 + +[files] +packages = + vidsum + +[entry_points] +console_scripts = + vidsum = vidsum.__main__:main + +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..78c57ea --- /dev/null +++ b/setup.py @@ -0,0 +1,7 @@ +from setuptools import setup + +setup( + requires=['pbd'], + pbr=True, + long_description_content_type="text/markdown", +) diff --git a/vidsum/__init__.py b/vidsum/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/code/sum.py b/vidsum/__main__.py similarity index 99% rename from code/sum.py rename to vidsum/__main__.py index 1d8a977..0cc2b03 100644 --- a/code/sum.py +++ b/vidsum/__main__.py @@ -220,7 +220,7 @@ def download_video_srt(subs): return movie_filename, subtitle_filename -if __name__ == '__main__': +def main(): parser = argparse.ArgumentParser("Watch videos quickly") parser.add_argument('-i', '--video-file', help="Input video file") parser.add_argument('-s', '--subtitles-file', @@ -249,3 +249,7 @@ def download_video_srt(subs): os.remove(movie_filename) os.remove(subtitle_filename) print("[sum.py] Remove the original files") + + +if __name__ == '__main__': + main() diff --git a/code/data/1.srt b/vidsum/data/1.srt similarity index 100% rename from code/data/1.srt rename to vidsum/data/1.srt diff --git a/code/data/1_summarized.mp4 b/vidsum/data/1_summarized.mp4 similarity index 100% rename from code/data/1_summarized.mp4 rename to vidsum/data/1_summarized.mp4