diff --git a/.gitignore b/.gitignore index f8f7ea6..59417c5 100644 --- a/.gitignore +++ b/.gitignore @@ -5,5 +5,4 @@ __pycache__/ *.log build/ dist/ -*.spec Return haunted farmhouse Part 1.mp4 diff --git a/USAGE.md b/USAGE.md index 9d47b61..b2e222e 100644 --- a/USAGE.md +++ b/USAGE.md @@ -33,11 +33,9 @@ Before running the script, ensure you have the following installed on your **Arc ## 3. Running the Converter -Once the setup is complete, you can run the converter script. +Once the setup is complete, you can run the converter script or the packaged executable. -### Basic Usage - -The script takes an input video file and an optional output directory. If the input file is not provided via the command line, the script will prompt you to enter it. +### Running the Python Script ```bash python -m src.main [path_to_your_input_video_file] [-o ] @@ -53,20 +51,25 @@ python -m src.main # Script will then prompt: Please enter the path to the input video file: ``` -**Example:** +### Running the Packaged Executable -```bash -# Convert a video and save it in the same directory -python -m src.main /home/user/Videos/my_original_video.mp4 +After building the executable (see `DEVELOPMENT_PLAN.md` for details on packaging), you can find it in the `dist/` directory. -# Convert a video and save it to a specific output directory -python -m src.main /home/user/Videos/my_original_video.mp4 -o /home/user/ConvertedVideos -``` +1. **Navigate to the `dist` directory:** + ```bash + cd /path/to/your/project/video-converter/dist + ``` +2. **Run the executable:** + ```bash + ./video-converter [path_to_your_input_video_file] [-o ] + ``` -### Output File Naming + The usage is identical to the Python script, but you execute the binary directly. -* If an output directory is specified, the converted file will be named `my_original_video_DR_compatible.mov`. -* If no output directory is specified (i.e., the output is in the same directory as the input), the converted file will be named `recoded_my_original_video_DR_compatible.mov`. + **Example:** + ```bash + ./video-converter /home/user/Videos/my_original_video.mp4 -o /home/user/ConvertedVideos + ``` ## 4. What it Does diff --git a/video-converter.spec b/video-converter.spec new file mode 100644 index 0000000..75d316d --- /dev/null +++ b/video-converter.spec @@ -0,0 +1,35 @@ +# -*- mode: python ; coding: utf-8 -*- + +block_cipher = None + +a = Analysis(['src/main.py'], + pathex=['/home/joe/Cloud9/Documents/Obisdian/projects/Video Converter'], + binaries=[('/usr/bin/ffmpeg', '.'), ('/usr/bin/ffprobe', '.')], + datas=[], + hiddenimports=[], + hookspath=[], + hooksconfig={}, + runtime_hooks=[], + excludes=[], + win_no_prefer_redirects=False, + win_private_assemblies=False, + cipher=block_cipher, + noarchive=False) +pyz = PYZ(a.pure, a.zipped_data, + cipher=block_cipher) + +exe = EXE(pyz, + a.scripts, + a.binaries, + a.zipfiles, + a.datas, + [], + name='video-converter', + debug=False, + strip=False, + upx=True, + console=True, + disable_windowed_traceback=False, + target_arch=None, + codesign_identity=None, + entitlements_file=None )