diff --git a/README.md b/README.md index 0e46ad3..be713ab 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,23 @@ -# ffmpeg-gui +# FFMPEG-GUI Simple TKinter GUI tool written in Python to facilitate some basic audio and video manipulations using ffmpeg + +## Installation +The tool can be run on Linux, MacOS and Windows provided the following requirements are met +### Requirements +* [Python 3.7](https://www.python.org/downloads/) or above +* python3-tk (Comes with Python 3, but may need installing seperately in linux using ```apt-get install python3-tk```) + +To check what version of python is installed, open a console and run: +```python +python --version +``` +If the python version is suitable then run the following to install the image-sorting-tool +```python +pip install ffmpeg-gui +``` + +## Usage +To launch the program after installation, run: +```bash +ffmpeg-gui +``` \ No newline at end of file diff --git a/setup.py b/setup.py new file mode 100644 index 0000000..ae12a7d --- /dev/null +++ b/setup.py @@ -0,0 +1,46 @@ +""" Package script to create a python dist +""" +from setuptools import setup +from ffmpeg_gui import __version__ as version +from ffmpeg_gui import __name__ as name + +requirements = [] +extra_requirements = {"dev": ["pylint>=2.0.0"]} + +with open('README.md', encoding='utf-8') as f: + long_description = f.read() + + +setup( + name=name, + version=version, + url='https://github.com/ThorpeJosh/ffmpeg-gui', + license='MIT', + author='Joshua Thorpe', + author_email='josh@thorpe.engineering', + description='FFMPEG GUI for some common and simple AV operations', + long_description=long_description, + long_description_content_type='text/markdown', + keywords=['ffmpeg', 'gui', 'audio', 'video', 'convert', 'stitch'], + packages=['ffmpeg_gui'], + include_package_data=True, + install_requires=requirements, + extras_require=extra_requirements, + python_requires='>=3.7', + classifiers=[ + 'License :: OSI Approved :: MIT License', + 'Programming Language :: Python', + 'Programming Language :: Python :: 3', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', + 'Operating System :: Microsoft :: Windows', + 'Operating System :: POSIX :: Linux', + 'Operating System :: MacOS' + ], + entry_points={ + 'gui_scripts': [ + 'ffmpeg-gui=ffmpeg_gui.__main__:run' + ], + }, +)