updated docs and tests

Author: tikuma-lsuhsc

.github/workflows/test_n_pub.yml

@@ -13,23 +13,9 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        python-version: [3.7, 3.8, 3.9, "3.10"]
-        os: [ubuntu-latest, macos-latest, windows-latest]
-        # python-version: [3.7, 3.8, 3.9]
-        # os: [windows-latest]
-        exclude:
-          - os: macos-latest
-            python-version: 3.7
-          - os: windows-latest
-            python-version: 3.7
-          - os: macos-latest
-            python-version: 3.8
-          - os: windows-latest
-            python-version: 3.8
-          - os: macos-latest
-            python-version: 3.9
-          - os: windows-latest
-            python-version: 3.9
+        python-version: ["3.10"]
+        os: [macos-latest, windows-latest]
+        # os: [ubuntu-latest, macos-latest, windows-latest]
 
     steps:
       - run: echo ${{github.ref}}
@@ -44,11 +30,13 @@ jobs:
 
       - name: Setup Python dependencies
         run: |
-          python -m pip install -U pip
-          pip install -U build pytest pytest-github-actions-annotate-failures 
+          python -m pip install -U pip setuptools wheel 
+          pip install -r requirements.txt
 
-      - name: Install ffmpegio-plugin-static-ffmpeg package
-        run: pip install -q .
+      - name: Install ffmpegio-plugin-downloader package
+        run: |
+          pip install -q .
+          pip list
 
       - name: Run tests
         run: pytest -vv
@@ -68,8 +56,7 @@ jobs:
 
       - name: Setup Python dependencies
         run: |
-          python -m pip install -U pip setuptools
-          pip install -U build
+          python -m pip install -U pip setuptools wheel build
 
       - name: Build a binary wheel and a source tarball
         run: python -m build --sdist --wheel --outdir dist/ .
@@ -89,6 +76,9 @@ jobs:
       #     skip_existing: true
 
       - name: Publish distribution 📦 to PyPI
+        env:
+          PYPI_API_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
+        if: env.PYPI_API_TOKEN != null
         uses: pypa/gh-action-pypi-publish@master
         with:
           password: ${{ secrets.PYPI_API_TOKEN }}

.gitmodules

@@ -1,5 +1,5 @@
-`ffmpegio-plugin-plugin-static-ffmpeg`: A Python `ffmpegio` plugin to use FFmpeg binaries in `static-ffmpeg` package
-====================================================================================================================
+`ffmpegio-plugin-static-ffmpeg`: A Python `ffmpegio` plugin to use FFmpeg binaries in `static-ffmpeg` package
+=============================================================================================================
 
 |pypi| |pypi-status| |pypi-pyvers| |github-license| |github-status|
 
@@ -14,16 +14,37 @@
 .. |github-status| image:: https://img.shields.io/github/workflow/status/python-ffmpegio/python-ffmpegio-plugin-static-ffmpeg/Run%20Tests
   :alt: GitHub Workflow Status
 
-Python `ffmpegio` package aims to bring the full capability of `FFmpeg <https://ffmpeg.org>`__
-to read, write, and manipulate multimedia data to Python. FFmpeg is an open-source cross-platform 
-multimedia framework, which can handle most of the multimedia formats available today.
+`Python ffmpegio <https://python-ffmpegio.github.io/python-ffmpegio/>`__ package aims to bring 
+the full capability of `FFmpeg <https://ffmpeg.org>`__ to read, write, and manipulate multimedia 
+data to Python. FFmpeg is an open-source cross-platform multimedia framework, which can handle 
+most of the multimedia formats available today.
 
-`ffmpegio-plugin-static-ffmpeg` adds a capability to use the FFmpeg and FFprobe executable 
-distributed in `static-ffmpeg` Python package.
+One caveat of FFmpeg is that there is no official program installer for Windows and MacOS (although 
+`homebrew` could be used for the latter). `ffmpegio-plugin-static-ffmpeg` enables the `ffmpegio` package to 
+use the build of FFmpeg distributed by the `static-ffmpeg <https://github.com/zackees/static_ffmpeg>`__ 
+package.
 
-To use the plugin, it just needs to be installed via `pip`, and `ffmpegio` will automatically detect 
-the paths to FFmpeg and FFprobe when it is imported in a Python script.
+Use
+===
+
+Simply install the package:
 
 .. code-block:: bash
 
-  pip install ffmpegio-plugin-static-ffmpeg
+  pip install ffmpegio-core ffmpegio-plugin-static-ffmpeg
+
+Then `ffmpegio` will auto-detect the plugin and `static-ffmpeg`'s executables:
+
+.. code-block:: python
+  
+  import ffmpegio
+
+  print(ffmpegio.path.FFMPEG_BIN) # ...\site-packages\static_ffmpeg\bin\win32\ffmpeg.exe
+  print(ffmpegio.path.FFPROBE_BIN) # ...\site-packages\static_ffmpeg\bin\win32\ffprobe.exe
+  
+Because the `static-ffmpeg` package downloads its binaries on demand, the first
+time importing `ffmpegio` with this plugin enabled may take a while.
+
+.. note::
+  `ffmpegio-plugin-static-ffmpeg` will *not* be activated if `ffmpeg` and `ffprobe` are 
+  already available on the system PATH.

README.rst

@@ -1,7 +1,7 @@
 [metadata]
 name = ffmpegio-plugin-static-ffmpeg
 version = attr: ffmpegio_plugin_static_ffmpeg.__version__
-description = ffmpegio finder plugin to use static-ffmpeg executable from static-ffmpeg package
+description = ffmpegio finder plugin to use FFmpeg executables from static-ffmpeg package
 long_description_content_type = text/x-rst
 long_description = file: README.rst
 keywords = multimedia, ffmpeg

setup.cfg

@@ -1,11 +1,22 @@
-from ffmpegio import plugins
+from ffmpegio import plugins, path
+import ffmpegio_plugin_static_ffmpeg
+from static_ffmpeg import run
 
 
-def test_hooks():
-    hook = plugins.get_hook().finder
-    print(hook)
-    print(plugins.pm.get_plugins())
+def test_plugin():
+    assert ffmpegio_plugin_static_ffmpeg in plugins.pm.get_plugins()
+
+
+def test_operation():
+    ffmpeg_bin, ffprobe_bin = run.get_or_fetch_platform_executables_else_raise()
+    path.find()
+    assert path.get_ffmpeg() == ffmpeg_bin
+    assert path.get_ffmpeg(True) == ffprobe_bin
 
 
 if __name__ == "__main__":
-    test_hooks()
+    test_plugin()
+    test_operation
+
+    print(path.FFMPEG_BIN)
+    print(path.FFPROBE_BIN)