portable-ffmpeg 0.1.0__tar.gz

portable_ffmpeg-0.1.0/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    open-pull-requests-limit: 5
+    reviewers:
+      - "mrkbac"
+    commit-message:
+      prefix: "ci"
+      include: "scope"

portable_ffmpeg-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,35 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: release
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+    
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Install uv
+      uses: astral-sh/setup-uv@v4
+      with:
+        version: "latest"
+    
+    - name: Set up Python
+      run: uv python install
+    
+    - name: Install dependencies
+      run: uv sync --dev
+    
+    - name: Run tests
+      run: uv run pytest
+    
+    - name: Build package
+      run: uv build
+    
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

portable_ffmpeg-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,47 @@
+name: Lint and Test
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: tox-dev/action-pre-commit-uv@v1
+
+  test:
+    needs: pre-commit
+
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os:
+          # x86
+          - ubuntu-latest
+          - windows-latest
+          - macos-13
+          # arm64
+          - ubuntu-24.04-arm
+          - macos-latest
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+
+      - name: Install dependencies
+        run: uv sync --dev -p "${{ matrix.python-version }}"
+
+      - name: Run tests
+        run: |
+          uv run run_test.py

portable_ffmpeg-0.1.0/.gitignore

@@ -0,0 +1,18 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+binaries/
+.coverage
+
+# macOS
+.DS_Store
+
+# Coverage reports
+htmlcov/

portable_ffmpeg-0.1.0/.pre-commit-config.yaml

@@ -0,0 +1,28 @@
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v5.0.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: debug-statements
+      - id: mixed-line-ending
+
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.11.13
+    hooks:
+      - id: ruff-check
+        args: [--fix]
+      - id: ruff-format
+
+  - repo: local
+    hooks:
+      - id: pyright
+        name: pyright
+        entry: uv run --no-progress --frozen --all-extras --all-groups pyright --project pyproject.toml .
+        language: system
+        types: [python]
+        pass_filenames: false

portable_ffmpeg-0.1.0/.python-version

@@ -0,0 +1 @@
+3.10

portable_ffmpeg-0.1.0/PKG-INFO

@@ -0,0 +1,168 @@
+Metadata-Version: 2.4
+Name: portable-ffmpeg
+Version: 0.1.0
+Summary: Downloads static ffmpeg builds for Windows, macOS, and Linux
+Project-URL: Homepage, https://github.com/mrkbac/portable-ffmpeg
+Project-URL: Repository, https://github.com/mrkbac/portable-ffmpeg
+Project-URL: Issues, https://github.com/mrkbac/portable-ffmpeg/issues
+Author-email: Marko Bausch <60338487+mrkbac@users.noreply.github.com>
+License: MIT
+Keywords: audio,ffmpeg,ffprobe,multimedia,portable,static,video
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Provides-Extra: dev
+Requires-Dist: pre-commit; extra == 'dev'
+Requires-Dist: pyright; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: pytest>=8.4.0; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Portable FFmpeg
+
+Downloads static ffmpeg builds for Windows, macOS, and Linux.
+
+- Supports Windows, macOS, and Linux
+- Supports x86_64 architecture on all platforms, ARM64 on macOS and Linux
+- Automatic platform detection and binary caching
+
+## Usage
+
+### Python API
+
+```python
+from portable_ffmpeg import get_ffmpeg
+ffmpeg_path, ffprobe_path = get_ffmpeg()
+print(ffmpeg_path)  # Path to ffmpeg executable
+```
+
+### Command Line Interface
+
+After installation, you can use `static_ffmpeg` and `static_ffprobe` directly from the command line:
+
+```bash
+# Use static ffmpeg
+static_ffmpeg -i input.mp4 output.mp3
+
+# Use static ffprobe
+static_ffprobe -v quiet -print_format json -show_format input.mp4
+
+# Print paths to the binaries
+print_paths
+```
+
+The CLI commands automatically download and cache the appropriate static binaries for your platform.
+
+### PATH Management
+
+You can also programmatically manage your PATH:
+
+```python
+from portable_ffmpeg import add_to_path, remove_from_path
+
+# Add FFmpeg binaries to PATH
+add_to_path()
+
+# Add only if FFmpeg is not already available (weak mode)
+add_to_path(weak=True)
+
+# Remove from PATH
+remove_from_path()
+```
+
+## Sources of Static Builds
+
+This package downloads static FFmpeg binaries from the following trusted sources:
+
+### Windows (x86_64 only)
+
+- **Source**: [CODEX FFMPEG @ gyan.dev](https://www.gyan.dev/ffmpeg/builds/)
+- **URL**: `https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip`
+- **Description**: Official Windows builds, 64-bit static binaries licensed as GPLv3
+
+### macOS
+
+#### Intel (x86_64)
+
+- **Source**: [OSXExperts.net](http://www.osxexperts.net/)
+- **URLs**:
+  - FFmpeg: `https://www.osxexperts.net/ffmpeg71intel.zip`
+  - FFprobe: `https://www.osxexperts.net/ffprobe71intel.zip`
+- **Description**: Static FFmpeg 7.1 binaries for macOS Intel processors
+
+#### Apple Silicon (arm64)
+
+- **Source**: [OSXExperts.net](http://www.osxexperts.net/)
+- **URLs**:
+  - FFmpeg: `https://www.osxexperts.net/ffmpeg711arm.zip`
+  - FFprobe: `https://www.osxexperts.net/ffprobe711arm.zip`
+- **Description**: Static FFmpeg 7.1.1 binaries optimized for Apple Silicon processors
+
+### Linux (x86_64 and arm64)
+
+- **Source**: [John Van Sickle - FFmpeg Static Builds](https://johnvansickle.com/ffmpeg/)
+- **URLs**:
+  - x86_64: `https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz`
+  - arm64: `https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-arm64-static.tar.xz`
+- **Description**: Latest versions of FFmpeg for Linux kernels 3.2.0+, statically linked
+
+
+### Alternative Sources
+
+The following sources provide FFmpeg static builds but are not currently supported by this package. They could be considered for future releases:
+
+- **[FFmpeg Martin Riedl](https://ffmpeg.martin-riedl.de/)**
+  - **Platforms**: macOS, Linux
+  - **Architectures**: x86_64, ARM64
+  - **Description**: Regularly updated static builds with comprehensive codec support
+
+- **[BtbN FFmpeg Builds](https://github.com/BtbN/FFmpeg-Builds)**
+  - **Platforms**: Windows, Linux
+  - **Architectures**: x86_64, ARM64, x86 (Windows only)
+  - **Description**: GitHub Actions-built binaries with automated releases
+
+- **[EverMeet FFmpeg](https://evermeet.cx/ffmpeg/)**
+  - **Platforms**: macOS only
+  - **Architectures**: x86_64
+  - **Description**: Long-standing macOS static builds provider
+
+- **[FreeBSD FFmpeg Static](https://github.com/Thefrank/ffmpeg-static-freebsd/)**
+  - **Platforms**: FreeBSD only
+  - **Architectures**: Various
+  - **Description**: Static builds specifically for FreeBSD systems
+
+- **[John Van Sickle Extended](https://johnvansickle.com/ffmpeg/)**
+  - **Additional Architectures**: i686, armhf, armel (beyond the currently supported x86_64 and ARM64)
+  - **Description**: Comprehensive Linux support including older and embedded architectures
+
+## Caching
+
+Downloaded binaries are cached in the package's `binaries/` directory to avoid re-downloading. Each virtual environment gets its own copy of the binaries.
+
+The cache is organized by platform and architecture (e.g., `linux-amd64`, `windows-amd64`, `osx-arm64`).
+
+### Cache Management
+
+```python
+from portable_ffmpeg import clear_cache
+
+# Clear all cached binaries
+clear_cache()
+```
+
+Or use the command line:
+
+```bash
+clear_cache
+```

portable_ffmpeg-0.1.0/README.md

@@ -0,0 +1,137 @@
+# Portable FFmpeg
+
+Downloads static ffmpeg builds for Windows, macOS, and Linux.
+
+- Supports Windows, macOS, and Linux
+- Supports x86_64 architecture on all platforms, ARM64 on macOS and Linux
+- Automatic platform detection and binary caching
+
+## Usage
+
+### Python API
+
+```python
+from portable_ffmpeg import get_ffmpeg
+ffmpeg_path, ffprobe_path = get_ffmpeg()
+print(ffmpeg_path)  # Path to ffmpeg executable
+```
+
+### Command Line Interface
+
+After installation, you can use `static_ffmpeg` and `static_ffprobe` directly from the command line:
+
+```bash
+# Use static ffmpeg
+static_ffmpeg -i input.mp4 output.mp3
+
+# Use static ffprobe
+static_ffprobe -v quiet -print_format json -show_format input.mp4
+
+# Print paths to the binaries
+print_paths
+```
+
+The CLI commands automatically download and cache the appropriate static binaries for your platform.
+
+### PATH Management
+
+You can also programmatically manage your PATH:
+
+```python
+from portable_ffmpeg import add_to_path, remove_from_path
+
+# Add FFmpeg binaries to PATH
+add_to_path()
+
+# Add only if FFmpeg is not already available (weak mode)
+add_to_path(weak=True)
+
+# Remove from PATH
+remove_from_path()
+```
+
+## Sources of Static Builds
+
+This package downloads static FFmpeg binaries from the following trusted sources:
+
+### Windows (x86_64 only)
+
+- **Source**: [CODEX FFMPEG @ gyan.dev](https://www.gyan.dev/ffmpeg/builds/)
+- **URL**: `https://www.gyan.dev/ffmpeg/builds/ffmpeg-release-essentials.zip`
+- **Description**: Official Windows builds, 64-bit static binaries licensed as GPLv3
+
+### macOS
+
+#### Intel (x86_64)
+
+- **Source**: [OSXExperts.net](http://www.osxexperts.net/)
+- **URLs**:
+  - FFmpeg: `https://www.osxexperts.net/ffmpeg71intel.zip`
+  - FFprobe: `https://www.osxexperts.net/ffprobe71intel.zip`
+- **Description**: Static FFmpeg 7.1 binaries for macOS Intel processors
+
+#### Apple Silicon (arm64)
+
+- **Source**: [OSXExperts.net](http://www.osxexperts.net/)
+- **URLs**:
+  - FFmpeg: `https://www.osxexperts.net/ffmpeg711arm.zip`
+  - FFprobe: `https://www.osxexperts.net/ffprobe711arm.zip`
+- **Description**: Static FFmpeg 7.1.1 binaries optimized for Apple Silicon processors
+
+### Linux (x86_64 and arm64)
+
+- **Source**: [John Van Sickle - FFmpeg Static Builds](https://johnvansickle.com/ffmpeg/)
+- **URLs**:
+  - x86_64: `https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-amd64-static.tar.xz`
+  - arm64: `https://johnvansickle.com/ffmpeg/releases/ffmpeg-release-arm64-static.tar.xz`
+- **Description**: Latest versions of FFmpeg for Linux kernels 3.2.0+, statically linked
+
+
+### Alternative Sources
+
+The following sources provide FFmpeg static builds but are not currently supported by this package. They could be considered for future releases:
+
+- **[FFmpeg Martin Riedl](https://ffmpeg.martin-riedl.de/)**
+  - **Platforms**: macOS, Linux
+  - **Architectures**: x86_64, ARM64
+  - **Description**: Regularly updated static builds with comprehensive codec support
+
+- **[BtbN FFmpeg Builds](https://github.com/BtbN/FFmpeg-Builds)**
+  - **Platforms**: Windows, Linux
+  - **Architectures**: x86_64, ARM64, x86 (Windows only)
+  - **Description**: GitHub Actions-built binaries with automated releases
+
+- **[EverMeet FFmpeg](https://evermeet.cx/ffmpeg/)**
+  - **Platforms**: macOS only
+  - **Architectures**: x86_64
+  - **Description**: Long-standing macOS static builds provider
+
+- **[FreeBSD FFmpeg Static](https://github.com/Thefrank/ffmpeg-static-freebsd/)**
+  - **Platforms**: FreeBSD only
+  - **Architectures**: Various
+  - **Description**: Static builds specifically for FreeBSD systems
+
+- **[John Van Sickle Extended](https://johnvansickle.com/ffmpeg/)**
+  - **Additional Architectures**: i686, armhf, armel (beyond the currently supported x86_64 and ARM64)
+  - **Description**: Comprehensive Linux support including older and embedded architectures
+
+## Caching
+
+Downloaded binaries are cached in the package's `binaries/` directory to avoid re-downloading. Each virtual environment gets its own copy of the binaries.
+
+The cache is organized by platform and architecture (e.g., `linux-amd64`, `windows-amd64`, `osx-arm64`).
+
+### Cache Management
+
+```python
+from portable_ffmpeg import clear_cache
+
+# Clear all cached binaries
+clear_cache()
+```
+
+Or use the command line:
+
+```bash
+clear_cache
+```

portable_ffmpeg-0.1.0/pyproject.toml

@@ -0,0 +1,96 @@
+[project]
+name = "portable-ffmpeg"
+version = "0.1.0"
+description = "Downloads static ffmpeg builds for Windows, macOS, and Linux"
+readme = "README.md"
+authors = [
+    { name = "Marko Bausch", email = "60338487+mrkbac@users.noreply.github.com" },
+]
+license = { text = "MIT" }
+requires-python = ">=3.10"
+dependencies = []
+keywords = [
+    "ffmpeg",
+    "ffprobe",
+    "video",
+    "audio",
+    "multimedia",
+    "static",
+    "portable",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Homepage = "https://github.com/mrkbac/portable-ffmpeg"
+Repository = "https://github.com/mrkbac/portable-ffmpeg"
+Issues = "https://github.com/mrkbac/portable-ffmpeg/issues"
+
+[project.optional-dependencies]
+dev = ["pytest>=8.4.0", "pytest-cov", "ruff", "pyright", "pre-commit"]
+
+[project.scripts]
+static_ffmpeg = "portable_ffmpeg:run_ffmpeg"
+static_ffprobe = "portable_ffmpeg:run_ffprobe"
+print_paths = "portable_ffmpeg:print_paths"
+clear_cache = "portable_ffmpeg:clear_cache"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.ruff]
+target-version = "py310"
+line-length = 100
+
+[tool.ruff.lint]
+select = ['ALL']
+ignore = [
+    "S310",    # Audit URL open (expected for downloading binaries)
+    "S103",    # os.chmod setting permissive mask (need executable permissions)
+    "S603",    # subprocess call: check for execution of untrusted input (expected for CLI entry points)
+    "COM812",  # Trailing comma missing (conflicts with formatter)
+    "PLR2004", # Magic values (acceptable in some cases)
+    "T201",    # print statement used
+    "ERA001",  # Commented-out code
+]
+[tool.ruff.lint.per-file-ignores]
+# relaxes in tests
+"tests/*" = [
+    "S101",    # Use of assert detected (legitimate in tests)
+    "BLE001",  # Broad exception catching (acceptable in tests)
+    "PT011",   # Broad pytest.raises (sometimes acceptable)
+    "PERF203", # try-except in loop (acceptable in tests)
+    "PLR2004", # Magic values (acceptable in tests)
+    "D401",    # Imperative mood (less important in tests)
+]
+
+[dependency-groups]
+dev = [
+    "pre-commit>=4.2.0",
+    "pyright>=1.1.402",
+    "pytest-asyncio>=1.0.0",
+    "pytest-cov>=6.2.1",
+    "pytest-mock>=3.14.1",
+    "ruff>=0.11.13",
+]
+
+[tool.pytest.ini_options]
+markers = ["slow: marks tests as slow (deselect with '-m \"not slow\"')"]
+addopts = "--strict-markers --strict-config"
+
+[tool.coverage.report]
+fail_under = 100
+show_missing = true

portable_ffmpeg-0.1.0/run_test.py

@@ -0,0 +1,49 @@
+"""Run tests with coverage and generate summary for GitHub Actions."""
+
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+
+def main() -> None:
+    """Run tests and generate summary based on arguments."""
+    print("Running tests with coverage...")
+
+    # Run pytest with coverage, capturing output
+    result = subprocess.run(
+        [  # noqa: S607
+            "pytest",
+            "--cov=src/portable_ffmpeg",
+            "--cov-report=term-missing",
+            "--cov-fail-under=95",
+        ],
+        check=False,
+        capture_output=True,
+        text=True,
+    )
+
+    # Print output to console
+    if result.stdout:
+        print(result.stdout)
+    if result.stderr:
+        print(result.stderr, file=sys.stderr)
+
+    # Write summary to GitHub Actions if environment variable is set
+    if summary_file := os.environ.get("GITHUB_STEP_SUMMARY"):
+        print(f"Writing summary to {summary_file}")
+        with Path(summary_file).open("w") as f:
+            f.write("# Test Coverage Summary\n\n")
+            f.write("```text\n")
+            if result.stdout:
+                f.write(result.stdout)
+            else:
+                f.write("No coverage data available\n")
+            f.write("```\n")
+
+    # Exit with the same code as pytest
+    sys.exit(result.returncode)
+
+
+if __name__ == "__main__":
+    main()

portable_ffmpeg-0.1.0/src/portable_ffmpeg/__init__.py

@@ -0,0 +1,29 @@
+"""Static FFmpeg binaries for Windows, macOS, and Linux.
+
+This package automatically downloads and manages static FFmpeg binaries
+for cross-platform use without requiring system installation.
+"""
+
+from .core import (
+    add_to_path,
+    clear_cache,
+    get_ffmpeg,
+    print_paths,
+    remove_from_path,
+    run_ffmpeg,
+    run_ffprobe,
+)
+from .enums import Architectures, FFmpegVersions, OperatingSystems
+
+__all__ = [
+    "Architectures",
+    "FFmpegVersions",
+    "OperatingSystems",
+    "add_to_path",
+    "clear_cache",
+    "get_ffmpeg",
+    "print_paths",
+    "remove_from_path",
+    "run_ffmpeg",
+    "run_ffprobe",
+]