refactor to package format

cli.py → KeyFrameDetector/cli.py

@@ -1,6 +1,6 @@
 import argparse
 
-from keyframeDetector import keyframeDetection
+from KeyFrameDetector.key_frame_detector import keyframeDetection
 
 parser = argparse.ArgumentParser()
 

keyframeDetector.py → KeyFrameDetector/key_frame_detector.py

@@ -4,7 +4,7 @@
 import numpy as np
 import time
 import peakutils
-from utils import convert_frame_to_grayscale, prepare_dirs, plot_metrics
+from KeyFrameDetector.utils import convert_frame_to_grayscale, prepare_dirs, plot_metrics
 
 def keyframeDetection(source, dest, Thres, plotMetrics=False, verbose=False):
 

requirements.txt

@@ -0,0 +1,3 @@
+numpy
+opencv-python
+peakutils

setup.py

@@ -0,0 +1,35 @@
+import sys
+from setuptools import setup, find_packages
+from setuptools.command.install import install
+from setuptools.command.develop import develop
+from setuptools.command.egg_info import egg_info
+
+setup(
+    name="key-frame-detector",
+    version="1.0.0",
+    author="Joel Ibaceta",
+    author_email="[email protected]",
+    license='MIT',
+    description="It is a simple python tool to extract key frame images from video",
+    long_description="A simple tool to detect and extract key frame images from a video file",
+    url="https://github.com/joelibaceta/video-keyframe-extractor",
+    project_urls={
+        'Source': 'https://github.com/joelibaceta/video-keyframe-extractor',
+        'Tracker': 'https://github.com/joelibaceta/video-keyframe-extractor/issues'
+    },
+    packages=find_packages(),
+    include_package_data=True,
+    install_requires=['opencv-python', 'numpy', 'peakutils'],
+    classifiers=[
+        "Programming Language :: Python :: 3",
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Operating System :: OS Independent",
+    ],
+    keywords='video key-frame terminal opencv extractor',
+    entry_points={
+        "console_scripts": [
+            'key-frames-detector=KeyFrameDetector.cli:main'
+        ]
+    }
+)