first release ver

Author: tikuma-lsuhsc

.github/workflows/test_n_pub.yml

@@ -2,8 +2,6 @@ name: Run Tests
 
 on:
   push:
-    branches:
-      - "main"
     tags:
       - "v*.*.*"
   pull_request:
@@ -22,15 +20,15 @@ jobs:
         exclude:
           - os: macos-latest
             python-version: 3.7
-          - os: windows-latest
+          - os: ubuntu-latest
             python-version: 3.7
           - os: macos-latest
             python-version: 3.8
-          - os: windows-latest
+          - os: ubuntu-latest
             python-version: 3.8
           - os: macos-latest
             python-version: 3.9
-          - os: windows-latest
+          - os: ubuntu-latest
             python-version: 3.9
 
     steps:
@@ -52,7 +50,12 @@ jobs:
         run: pip install -q .
 
       - name: Run tests
-        run: pytest -vv
+        # run: pytest -vv
+        uses: nick-fields/retry@v2
+        with:
+          timeout_seconds: 15
+          max_attempts: 3
+          command: pytest -vv
 
   distribute:
     name: Distribution

README.rst

@@ -1,5 +1,5 @@
-`ffmpeg-downloader`: Python FFmpeg binary downloader
-===================================================
+`ffmpeg-downloader`: Python FFmpeg release build binary downloader
+==================================================================
 
 |pypi| |pypi-status| |pypi-pyvers| |github-license| |github-status|
 
@@ -14,22 +14,58 @@
 .. |github-status| image:: https://img.shields.io/github/workflow/status/python-ffmpegio/python-ffmpeg-downloader/Run%20Tests
   :alt: GitHub Workflow Status
 
-Python `ffmpeg-downloader` package automatically downloads FFmpeg binaries for Windows, Linux, & MacOS. Note 
+Python `ffmpeg-downloader` package automatically downloads the latest FFmpeg release binaries for Windows, Linux, & MacOS. Note 
 while it supports Linux and MacOS, it is intended for Windows users, for whom there is no installer is currently
 available. Linux and MacOS users should install via OS package manager (e.g., `apt-get` for Ubuntu and `brew` for MacOS).
 
-Install `ffmpeg-downloader` package via ``pip``:
+The FFmpeg release builds are downloaded from 3rd party hosts:
+
+=======  =========================================================================
+Windows  `https://www.gyan.dev/ffmpeg/builds <https://www.gyan.dev/ffmpeg/builds>`_
+Linux    `https://johnvansickle.com/ffmpeg <https://johnvansickle.com/ffmpeg>`_
+MacOS    `https://evermeet.cx/ffmpeg <https://evermeet.cx/ffmpeg>`_
+=======  =========================================================================
+
+If you appreciate their efforts to build and host these builds, please consider donating on their websites.
+
+Installation
+------------
 
 .. code-block:: bash
 
    pip install ffmpeg-downloader
 
-Console Command
----------------
+Console Commands
+----------------
+
+To download and install FFmpeg binaries:
+
+.. code-block:: bash
+
+  python -m ffmpeg_downloader
+
+To check for a newer release and update:
+
+.. code-block:: bash
+
+  python -m ffmpeg_downloader --update
+
+To uninstall:
+
+.. code-block:: bash
+
+  python -m ffmpeg_downloader --remove
+
+In Python
+---------
 
-* 
+This package exposes the following 4 attributes:
 
-In-Python Use
--------------
+.. code-block:: python
+  
+  import ffmpeg_downloader as ffdl
 
-* 
+  ffdl.ffmpeg_dir     # FFmpeg binaries directory 
+  ffdl.ffmpeg_version # version string of the intalled FFmpeg
+  ffdl.ffmpeg_path    # full path of the FFmpeg binary
+  ffdl.ffprobe_path   # full path of the FFprobe binary

setup.cfg

@@ -1,14 +1,13 @@
 [metadata]
 name = ffmpeg_downloader
 version = attr: ffmpeg_downloader.__version__
-description = FFmpeg Executable Downloader
+description = FFmpeg Release Build Downloader
 # long_description_content_type = text/x-rst
 # long_description = file: README.md
-keywords = multimedia
+keywords = multimedia, ffmpeg, ffprobe
 license = GPL-2.0 License
-# url=https://python-ffmpegio.github.io/python-ffmpegio-downloader
+    url=https://github.com/python-ffmpegio/python-ffmpeg-downloader
 project_urls=
-    Repository=https://github.com/python-ffmpegio/python-ffmpeg-downloader
     Issues=https://github.com/python-ffmpegio/python-ffmpegio-downloader/issues
     Pull Requests=https://github.com/python-ffmpegio/python-ffmpegio-downloader/pulls
 classifiers =
@@ -32,6 +31,6 @@ packages=ffmpeg_downloader
 install_requires =
     tqdm
     # patool;platform_system!='Linux'
-    pylzma
+    # pylzma
     appdirs
 python_requires = >=3.7,

src/ffmpeg_downloader/__init__.py

@@ -1,12 +1,9 @@
-__version__ = "0.0.0"
+__version__ = "0.1.0"
 __all__ = [
     "ffmpeg_dir",
     "ffmpeg_version",
     "ffmpeg_path",
     "ffprobe_path",
-    "has_update",
-    "update",
-    "remove",
 ]
 
 from os import listdir, path, rmdir, name as os_name
@@ -15,7 +12,7 @@
 from appdirs import user_data_dir
 
 
-if sys.platform in ("win32", "cygwin"):
+if os_name == "nt":
     from ._win32 import (
         download_n_install,
         get_version as get_latest_version,
@@ -77,7 +74,9 @@ def __getattr__(name):  # per PEP 562
             "ffmpeg_path": lambda: _ffmpeg_version()
             and path.join(_ffmpeg_dir(), "ffmpeg" if os_name != "nt" else "ffmpeg.exe"),
             "ffprobe_path": lambda: _ffmpeg_version()
-            and path.join(_ffmpeg_dir(), "ffprobe" if os_name != "nt" else "ffprobe.exe"),
+            and path.join(
+                _ffmpeg_dir(), "ffprobe" if os_name != "nt" else "ffprobe.exe"
+            ),
             "ffmpeg_version": _ffmpeg_version,
         }[name]()
     except:

src/ffmpeg_downloader/_download_helper.py

@@ -1,11 +1,15 @@
 from urllib import request
 from contextlib import contextmanager
-import os, stat
+import os, stat, ssl
+
+ctx = ssl.create_default_context()
+ctx.check_hostname = False
+ctx.verify_mode = ssl.CERT_NONE
 
 
 @contextmanager
-def download_base(url, content_type, ctx=None):
-    with request.urlopen(url, timeout=1.0, context=ctx) as response:
+def download_base(url, content_type, timeout=None):
+    with request.urlopen(url, timeout=timeout or 1.0, context=ctx) as response:
         # pprint(response.headers.get_content_type())
         if response.headers.get_content_type() != content_type:
             raise RuntimeError(f'"{url}" is not the expected content type.')
@@ -16,15 +20,15 @@ def download_base(url, content_type, ctx=None):
         yield response, nbytes
 
 
-def download_info(url, content_type, ctx=None):
-    with download_base(url, content_type, ctx) as (response, nbytes):
+def download_info(url, content_type, timeout=None):
+    with download_base(url, content_type, timeout) as (response, nbytes):
         info = response.read().decode("utf-8")
     return info
 
 
-def download_file(outfile, url, content_type, ctx=None, progress=None):
+def download_file(outfile, url, content_type, progress=None, timeout=None):
 
-    with download_base(url, content_type, ctx) as (response, nbytes):
+    with download_base(url, content_type, timeout) as (response, nbytes):
         if progress:
             progress(0, nbytes)
 

src/ffmpeg_downloader/_linux.py

@@ -8,17 +8,9 @@
 
 def get_version():
 
-    ctx = ssl.create_default_context()
-    ctx.check_hostname = False
-    ctx.verify_mode = ssl.CERT_NONE
-
     return re.search(
         r"version: (\d+\.\d+(?:\.\d+)?)",
-        download_info(
-            f"{home_url}/release-readme.txt",
-            "text/plain",
-            ctx,
-        ),
+        download_info(f"{home_url}/release-readme.txt", "text/plain", 10),
     )[1]
 
 
@@ -29,16 +21,14 @@ def download_n_install(install_dir, progress=None, arch=None):
     elif arch not in archs:
         raise ValueError(f"Invalid arch specified. Must be one of {arch}")
 
-    ctx = ssl.create_default_context()
-    ctx.check_hostname = False
-    ctx.verify_mode = ssl.CERT_NONE
-
     with TemporaryDirectory() as tmpdir:
         tarpath = path.join(tmpdir, "ffmpeg_linux.tar.xz")
         url = f"{home_url}/releases/ffmpeg-release-{arch}-static.tar.xz"
 
         with TemporaryDirectory() as tmpdir:
-            download_file(tarpath, url, "application/x-xz", ctx, progress=progress)
+            download_file(
+                tarpath, url, "application/x-xz", progress=progress, timeout=10
+            )
 
         with tarfile.open(tarpath, "r") as f:
             f.extractall(tmpdir)
@@ -54,6 +44,7 @@ def download_n_install(install_dir, progress=None, arch=None):
         except:
             pass
 
+        # os.makedirs(install_dir, exist_ok=True)
         shutil.move(src_dir_path, install_dir)
 
     for cmd in ("ffmpeg", "ffprobe"):

src/ffmpeg_downloader/_macos.py

@@ -1,6 +1,6 @@
 from tempfile import TemporaryDirectory
 from os import path
-import json, os, zipfile
+import json, os, zipfile, shutil
 from ._download_helper import download_info, download_file, chmod, download_base
 
 home_url = "https://evermeet.cx/ffmpeg"
@@ -16,10 +16,14 @@ def download_n_install(install_dir, progress=None):
 
     ntotal = 0
 
-    nfiles = [
-        download_base(f"{home_url}/getrelease/{cmd}/zip")
-        for cmd in ("ffmpeg", "ffprobe")
-    ]
+    def get_nbytes(cmd):
+        with download_base(f"{home_url}/getrelease/{cmd}/zip", "application/zip") as (
+            _,
+            nbytes,
+        ):
+            return nbytes
+
+    nfiles = [get_nbytes(cmd) for cmd in ("ffmpeg", "ffprobe")]
     ntotal = sum(nfiles)
     n1 = nfiles[0]
     prog = (
@@ -47,7 +51,8 @@ def download_n_install(install_dir, progress=None):
                 os.remove(dst_path)
             except:
                 pass
-            os.rename(path.join(tmpdir, cmd), dst_path)
+            os.makedirs(install_dir, exist_ok=True)
+            shutil.move(path.join(tmpdir, cmd), dst_path)
             chmod(dst_path)
 
         with open(path.join(install_dir, "VERSION"), "wt") as f: