ffmpeg-update 1.4.1__py3-none-any.whl

ffmpeg_update-1.4.1.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: ffmpeg-update
+Version: 1.4.1
+Summary: CLI tool to manage FFmpeg static binaries
+Project-URL: homepage, https://github.com/pantheraleo-7/ffmpeg-update
+Author: Asadullah Shaikh
+Keywords: binaries,ffmpeg,installer,static
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: System :: Installation/Setup
+Classifier: Topic :: System :: Software Distribution
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Requires-Dist: fire
+Requires-Dist: requests
+Requires-Dist: tqdm
+Description-Content-Type: text/markdown
+
+# FFUp
+
+A Python CLI tool to manage FFmpeg static binaries on Unix-like systems. It fetches the latest builds published by [Martin Riedl](https://ffmpeg.martin-riedl.de/).
+
+## Features
+
+- Install static builds of FFmpeg, FFprobe, and/or FFplay.
+- Update to the latest version.
+- Check for update.
+- Uninstall from the system.
+- Supports custom installation paths.
+- Supports both **Linux** and **macOS** (Windows builds are not available upstream).
+
+## Installation
+
+```bash
+pip install ffmpeg-update
+```
+
+## Usage
+
+### With `ffup`:
+
+The installation provides the `ffup` command.
+
+- **Install**:
+  ```bash
+  ffup install [--dir <custom-path>]
+  ```
+- **Update**:
+  ```bash
+  ffup update [--dir <custom-path>] [--dry-run]
+  ```
+- **Check**:
+  ```bash
+  ffup check [--dir <custom-path>]
+  ```
+- **Uninstall**:
+  ```bash
+  ffup uninstall [--dir <custom-path>]
+  ```
+
+### With `python`:
+
+Alternatively, the module can be invoked directly.
+
+```bash
+python -m ffup <command>
+```
+
+## Documentation
+
+### CLI Commands, Their Flags and Environment Variables
+
+1. **Install**:
+
+```bash
+ffup install [--dir <custom-path>]
+```
+
+- Downloads and installs the binary.
+- Flags and Environment variables:
+  - `--dir <custom-path>`: Specifies the installation directory.
+  - `$XDG_BIN_HOME`: Used as the installation directory if `--dir` is not specified.
+  - Defaults to `~/.local/bin` if none of the above is defined.
+
+2. **Update**:
+
+```bash
+ffup update [--dir <custom-path>] [--dry-run]
+```
+
+- Updates the binary to the latest version.
+- Flags:
+  - `--dir <custom-path>`: Specifies the directory where the binary is installed.
+  - Defaults to the first executable found on the `$PATH`.
+  - `--dry-run`: Only checks for update, skips download and install.
+
+3. **Check**:
+
+```bash
+ffup check [--dir <custom-path>]
+```
+
+- Checks for update.
+- Same as `ffup update [--dir <custom-path>] --dry-run`.
+- Flags:
+  - `--dir <custom-path>`: Specifies the directory where the binary is installed.
+  - Defaults to the first executable found on the `$PATH`.
+
+4. **Uninstall**:
+
+```bash
+ffup uninstall [--dir <custom-path>]
+```
+
+- Removes the installed binary.
+- Flags:
+  - `--dir <custom-path>`: Specifies the directory where the binary is installed.
+  - Defaults to the first executable found on the `$PATH`.
+
+### Global Flags and Their Environment Variables
+
+- `--sys` or `$FF_SYS`: Specifies the platform name (`macos`, `linux`). Default is to detect using `platform` stdlib.
+- `--arch` or `$FF_ARCH`: Specifies the platform architecture (`arm64`, `amd64`). Default is to detect using `platform` stdlib.
+- `--repo` or `$FF_REPO`: Specifies the static build type (`snapshot`, `release`). Defaults to `snapshot`.
+- `--bin` or `$FF_BIN`: Specifies the binary name (`ffmpeg`, `ffprobe`, `ffplay`). Defaults to `ffmpeg`.
+
+> **Note:** Flags have precedence over their respective environment variables.
+
+> **Note:** Command arguments may be given positionally. Global arguments are always specified with their respective keywords (flags).
+
+### Error Handling
+
+- Permission error triggers automatic escalation via `sudo` [and, consequently, prompts the user for password at `stdin`].
+- Path handling checks are exhaustive, with diagnostics logged to `stdout` and `stderr` as appropriate.

ffmpeg_update-1.4.1.dist-info/RECORD

@@ -0,0 +1,7 @@
+ffup/__init__.py,sha256=JOvFvqYGeEJu1XMhcDSw-tVGZhGxX1AjSoX384iB1VU,30
+ffup/__main__.py,sha256=bYt9eEaoRQWdejEHFD8REx9jxVEdZptECFsV7F49Ink,30
+ffup/cli.py,sha256=JrC2y5YAIhdOLs_YhfbXDb3--p2d2KuTteUD-2U5vvY,4781
+ffmpeg_update-1.4.1.dist-info/METADATA,sha256=OTKG0q1VFXYtAKK7KiyilrmJ3jul9IucFG0pXwA8cKc,4308
+ffmpeg_update-1.4.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+ffmpeg_update-1.4.1.dist-info/entry_points.txt,sha256=1PwlMliyeJa6o_dC6u0A0fPLu7fE72m2LeB671z6_IQ,35
+ffmpeg_update-1.4.1.dist-info/RECORD,,

ffmpeg_update-1.4.1.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.27.0
+Root-Is-Purelib: true
+Tag: py3-none-any

ffmpeg_update-1.4.1.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ffup = ffup:main

ffup/__init__.py

@@ -0,0 +1 @@
+from .cli import main as main

ffup/__main__.py

@@ -0,0 +1,3 @@
+from .cli import main
+
+main()

ffup/cli.py

@@ -0,0 +1,146 @@
+import os
+import platform
+import re
+import shutil
+import subprocess
+import sys
+import tempfile
+import zipfile
+from pathlib import Path
+
+import fire
+import requests
+from tqdm import tqdm
+
+
+class FFUp:
+    def __init__(self, sys=None, arch=None, repo=None, bin=None):
+        self.sys = sys or os.getenv('FF_SYS') \
+            or platform.system().replace('Darwin', 'macOS').lower()
+
+        self.arch = arch or os.getenv('FF_ARCH') \
+            or ('arm64' if  platform.machine() in ['arm64', 'aarch64'] else 'amd64')
+
+        self.repo = repo or os.getenv('FF_REPO') or 'snapshot'
+        self.bin = bin or os.getenv('FF_BIN') or 'ffmpeg'
+
+        self.URL = f'https://ffmpeg.martin-riedl.de/redirect/latest/{self.sys}/{self.arch}/{self.repo}/{self.bin}.zip'
+        self._TMPDIR = tempfile.TemporaryDirectory()
+
+    def __del__(self):
+        self._TMPDIR.cleanup()
+
+    def check(self, dir=None):
+        self.update(dir=dir, dry_run=True)
+
+    def install(self, dir=None):
+        path = Path(dir or os.getenv('XDG_BIN_HOME') or os.path.expanduser('~/.local/bin'), self.bin)
+
+        if shutil.which(self.bin) is not None:
+            print('Warning: found an existing installation on the `PATH`.')
+
+        if path.exists():
+            print('Error: found an existing installation at the given path.', file=sys.stderr)
+            sys.exit(1)
+
+        self._latest()
+        file = self._download()
+        self._install(file, path)
+
+    def update(self, dir=None, dry_run=False):
+        path = self._getpath(dir)
+        self._current(path)
+        self._latest()
+        if self.current_version!=self.latest_version:
+            print('Update available.')
+            if not dry_run:
+                file = self._download()
+                self._install(file, path)
+        else:
+            print('Already up to date.')
+
+    def uninstall(self, dir=None):
+        path = self._getpath(dir)
+        self._uninstall(path)
+
+    def _getpath(self, dir):
+        if dir is None:
+            path = shutil.which(self.bin)
+            if path is None:
+                print('Error: no installation found on the `PATH`.', file=sys.stderr)
+                sys.exit(1)
+        else:
+            path = Path(dir, self.bin)
+            if not path.exists():
+                print('Error: no installation found at the given path.', file=sys.stderr)
+                sys.exit(1)
+
+        return Path(path)
+
+    def _current(self, path):
+        output = subprocess.check_output([path, '-version'], text=True)
+
+        match = re.search(r'version (N-\d+-\w+|\d\.\d)', output)
+        if match is None:
+            print(f'Error: failed to parse current version from `{path} -version` output.', file=sys.stderr)
+            sys.exit(1)
+
+        self.current_version = match.group(1)
+        print('Current version:', self.current_version)
+
+    def _latest(self):
+        response = requests.get(self.URL, allow_redirects=False)
+        response.raise_for_status()
+
+        if response.status_code==307:
+            match = re.search(r'_(N-\d+-\w+|\d\.\d)', response.headers['location'])
+            if match is None:
+                print('Error: failed to parse latest version from redirected url.', file=sys.stderr)
+                sys.exit(1)
+
+            self.latest_version = match.group(1)
+            print('Latest version:', self.latest_version)
+
+        else:
+            print('Error: unexpected', response, file=sys.stderr)
+            print('Headers:', response.headers, file=sys.stderr)
+            sys.exit(1)
+
+    def _download(self):
+        with requests.get(self.URL, stream=True) as response:
+            response.raise_for_status()
+            bar = tqdm(
+                total=int(response.headers['content-length']),
+                unit='B', unit_scale=True,
+                desc='Downloading', dynamic_ncols=True
+            )
+            file = Path(self._TMPDIR.name, 'ff.zip')
+            with file.open('wb') as zf:
+                for chunk in response.iter_content(chunk_size=4096):
+                    chunk_size = zf.write(chunk)
+                    bar.update(chunk_size)
+        return file
+
+    def _install(self, file, path):
+        with zipfile.ZipFile(file, 'r') as zf:
+            bin = zf.extract(self.bin, self._TMPDIR.name)
+            os.chmod(bin, 0o755)
+
+        try:
+            os.replace(bin, path)
+        except PermissionError:
+            subprocess.run(['sudo', 'mv', bin, path], check=True, capture_output=True)
+
+        print('Successfully installed:', path)
+
+    def _uninstall(self, path):
+        try:
+            os.remove(path)
+        except PermissionError:
+            subprocess.run(['sudo', 'rm', path], check=True, capture_output=True)
+
+        print('Successfully uninstalled:', path)
+
+
+def main():
+    fire.Fire(FFUp)