plexer-cli 0.0.1.post4__tar.gz → 0.0.3__tar.gz

{plexer_cli-0.0.1.post4 → plexer_cli-0.0.3}/.github/workflows/release.yml

@@ -13,8 +13,10 @@ jobs:
     environment: release
 
     permissions:
+      attestations: write
       contents: write  # needed to create GH Release
       id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing to PyPI
+      packages: write  # required for pushing image to GHCR
     
     steps:
       - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
@@ -43,17 +45,6 @@ jobs:
       - name: Build dist artifacts
         run: hatch build
       
-      # Github Release
-      - name: Create Github Release
-        uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191  # v2.0.8
-        with:
-          name: 
-          files: |
-            dist/*
-          fail_on_unmatched_files: true
-          generate_release_notes: true
-          make_latest: true
-      
       # PyPI Release
       # required instead of using hatch due to usage of trusted publishers
       - name: Publish to TestPyPI
@@ -67,4 +58,15 @@ jobs:
         uses: pypa/gh-action-pypi-publish@897895f1e160c830e369f9779632ebc134688e1b  # v1.10.2
         with:
           attestations: true
+      
+      # Github Release
+      - name: Create Github Release
+        uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191  # v2.0.8
+        with:
+          name: 
+          files: |
+            dist/*
+          fail_on_unmatched_files: true
+          generate_release_notes: true
+          make_latest: true
       

plexer_cli-0.0.3/.github/workflows/release_docker_image.yml

@@ -0,0 +1,88 @@
+name: Release - Docker Images
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  docker_release:
+    name: Push Docker Image Release - ${{ github.ref_name }}
+    runs-on: ubuntu-latest
+    environment: release
+
+    strategy:
+      matrix:
+        container_repos: ["docker.io", "ghcr.io"]
+
+    permissions:
+      attestations: write
+      contents: read
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing to PyPI
+      packages: write  # required for pushing image to GHCR
+    
+    steps:
+      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+        with:
+          fetch-depth: 0
+
+      - name: Setup python for build
+        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3  # v5.2.0
+        with:
+          python-version: "3.x"
+
+      # run tests
+      - name: Install tox
+        run: python -m pip install tox-gh>=1.2
+
+      - name: Setup test suite
+        run: tox -vv --notest -e test
+
+      - name: Run test suite
+        run: tox --skip-pkg-install -e test
+      
+      # build and publish
+      - name: Install Hatch
+        run: pipx install hatch
+
+      - name: Build dist artifacts
+        run: hatch build
+      
+      # Docker Release
+      # REF: https://docs.github.com/en/actions/use-cases-and-examples/publishing-packages/publishing-docker-images#publishing-images-to-docker-hub-and-github-packages
+      - name: Log in to Docker Hub
+        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567  # v3.3.0
+        with:
+          username: ${{ secrets.DOCKER_USERNAME }}
+          password: ${{ secrets.DOCKER_PASSWORD }}
+      
+      - name: Log in to Github Container registry
+        uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567  # v3.3.0
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81  # v5.5.1
+        with:
+          images: |
+            magneticstain/${{ github.repository }}
+            ghcr.io/${{ github.repository }}
+
+      - name: Build and push Docker images to all registries
+        id: push
+        uses: docker/build-push-action@4f58ea79222b3b9dc2c8bbdd6debcef730109a75  # v6.9.0
+        with:
+          context: .
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+      - name: Generate artifact attestation for GHCR
+        uses: actions/attest-build-provenance@1c608d11d69870c2092266b3f9a6f3abbf17002c  # v1.4.3
+        with:
+          subject-name: ghcr.io/${{ github.repository }}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true
+      

{plexer_cli-0.0.1.post4 → plexer_cli-0.0.3}/=1.2

@@ -1,7 +1,7 @@
 Collecting tox-gh
-  Downloading tox_gh-1.4.1-py3-none-any.whl.metadata (5.5 kB)
+  Downloading tox_gh-1.4.4-py3-none-any.whl.metadata (6.5 kB)
 Collecting tox>=4.18.1 (from tox-gh)
-  Downloading tox-4.21.2-py3-none-any.whl.metadata (5.0 kB)
+  Downloading tox-4.23.0-py3-none-any.whl.metadata (3.6 kB)
 Collecting cachetools>=5.5 (from tox>=4.18.1->tox-gh)
   Downloading cachetools-5.5.0-py3-none-any.whl.metadata (5.3 kB)
 Collecting chardet>=5.2 (from tox>=4.18.1->tox-gh)
@@ -19,11 +19,11 @@ Collecting pluggy>=1.5 (from tox>=4.18.1->tox-gh)
 Collecting pyproject-api>=1.8 (from tox>=4.18.1->tox-gh)
   Downloading pyproject_api-1.8.0-py3-none-any.whl.metadata (2.7 kB)
 Collecting virtualenv>=20.26.6 (from tox>=4.18.1->tox-gh)
-  Downloading virtualenv-20.26.6-py3-none-any.whl.metadata (4.5 kB)
+  Downloading virtualenv-20.27.0-py3-none-any.whl.metadata (4.5 kB)
 Collecting distlib<1,>=0.3.7 (from virtualenv>=20.26.6->tox>=4.18.1->tox-gh)
-  Downloading distlib-0.3.8-py2.py3-none-any.whl.metadata (5.1 kB)
-Downloading tox_gh-1.4.1-py3-none-any.whl (6.7 kB)
-Downloading tox-4.21.2-py3-none-any.whl (165 kB)
+  Downloading distlib-0.3.9-py2.py3-none-any.whl.metadata (5.2 kB)
+Downloading tox_gh-1.4.4-py3-none-any.whl (6.8 kB)
+Downloading tox-4.23.0-py3-none-any.whl (166 kB)
 Downloading cachetools-5.5.0-py3-none-any.whl (9.5 kB)
 Downloading chardet-5.2.0-py3-none-any.whl (199 kB)
 Downloading colorama-0.4.6-py2.py3-none-any.whl (25 kB)
@@ -32,8 +32,8 @@ Downloading packaging-24.1-py3-none-any.whl (53 kB)
 Downloading platformdirs-4.3.6-py3-none-any.whl (18 kB)
 Downloading pluggy-1.5.0-py3-none-any.whl (20 kB)
 Downloading pyproject_api-1.8.0-py3-none-any.whl (13 kB)
-Downloading virtualenv-20.26.6-py3-none-any.whl (6.0 MB)
-   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 6.0/6.0 MB 102.0 MB/s eta 0:00:00
-Downloading distlib-0.3.8-py2.py3-none-any.whl (468 kB)
+Downloading virtualenv-20.27.0-py3-none-any.whl (3.1 MB)
+   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 3.1/3.1 MB 46.8 MB/s eta 0:00:00
+Downloading distlib-0.3.9-py2.py3-none-any.whl (468 kB)
 Installing collected packages: distlib, pluggy, platformdirs, packaging, filelock, colorama, chardet, cachetools, virtualenv, pyproject-api, tox, tox-gh
-Successfully installed cachetools-5.5.0 chardet-5.2.0 colorama-0.4.6 distlib-0.3.8 filelock-3.16.1 packaging-24.1 platformdirs-4.3.6 pluggy-1.5.0 pyproject-api-1.8.0 tox-4.21.2 tox-gh-1.4.1 virtualenv-20.26.6
+Successfully installed cachetools-5.5.0 chardet-5.2.0 colorama-0.4.6 distlib-0.3.9 filelock-3.16.1 packaging-24.1 platformdirs-4.3.6 pluggy-1.5.0 pyproject-api-1.8.0 tox-4.23.0 tox-gh-1.4.4 virtualenv-20.27.0

plexer_cli-0.0.3/Dockerfile

@@ -0,0 +1,38 @@
+# syntax=docker/dockerfile:1
+
+FROM python:3.13-slim AS build
+
+WORKDIR /build
+
+RUN pip install pipx==1.7.1
+RUN pipx install hatch==1.13.0
+
+COPY . .
+
+ENV PATH="$PATH:/root/.local/bin"
+
+RUN hatch build
+
+########################
+
+# linux/amd64 arch
+FROM python:3.13-alpine@sha256:81362dd1ee15848b118895328e56041149e1521310f238ed5b2cdefe674e6dbf
+
+RUN apk update && \
+    apk add libmagic
+
+RUN addgroup --system --gid 888 plexer && \
+    adduser --system --uid 888 --ingroup plexer plexer
+
+WORKDIR /app
+
+COPY --chown=plexer:plexer --from=build /build/dist/ ./dist/
+
+RUN python -m venv /app/venv
+ENV PATH="/app/venv/bin:$PATH"
+RUN pip install ./dist/plexer_cli-*.whl
+
+USER plexer
+
+ENTRYPOINT [ "/app/venv/bin/plexer" ]
+CMD [ "--help" ]

{plexer_cli-0.0.1.post4 → plexer_cli-0.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
-Name: plexer-cli
-Version: 0.0.1.post4
+Name: plexer_cli
+Version: 0.0.3
 Summary: Normalize media files for use with Plex Media Server
 Project-URL: Repository, https://github.com/magneticstain/plexer.git
 Project-URL: Documentation, https://github.com/magneticstain/plexer#readme
@@ -33,7 +33,7 @@ Description-Content-Type: text/markdown
 
 <!-- reenable once issue #27 is complete -->
 <!-- ![GitHub Release](https://img.shields.io/github/v/release/magneticstain/plexer?include_prereleases) -->
-![PyPI - Version](https://img.shields.io/pypi/v/plexer-cli)
+[![PyPI - Version](https://img.shields.io/pypi/v/plexer_cli)](https://pypi.org/project/plexer-cli/)
 
 ![GitHub License](https://img.shields.io/github/license/magneticstain/plexer)
 ![Supported Python Versions](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmagneticstain%2Fplexer%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)
@@ -67,10 +67,36 @@ Currently, Plexer only supports organizing movies and other individual video fil
 
 ## Install
 
-To install plexer, us pip/[pipx](https://github.com/pypa/pipx)/[pipenv](https://pipenv.pypa.io/en/latest/)/your favorite build front-end to install the `plexer-cli` package.
+To install Plexer, there are a few options available.
+
+### Docker
+
+The most portable way to install and run Plexer is by using Docker.
+
+#### Via Container Registry
+
+The easiest way to run Plexer in Docker is by using the public containers hosted on container registries. Plexer images are available on both Docker Hub and GitHub Container Registry. See the commands below for how to run Plexer using each registry.
+
+##### Docker Hub
+
+```bash
+docker run --rm -it magneticstain/plexer-cli
+```
+
+##### Github Container Registry
+
+```bash
+docker run --rm -it ghcr.io/magneticstain/plexer-cli
+```
+
+#### Via Local Build
+
+In the case that container registries are unavailable, there's also the option to build the image locally. To do that, check out the `main` branch of this repo, build the Plexer image, and run it.
 
 ```bash
-pip install plexer-cli
+git clone https://github.com/magneticstain/plexer-cli.git
+docker build -t plexer_cli .
+docker run --rm -it plexer_cli
 ```
 
 ## Requirements

{plexer_cli-0.0.1.post4 → plexer_cli-0.0.3}/README.md

@@ -2,7 +2,7 @@
 
 <!-- reenable once issue #27 is complete -->
 <!-- ![GitHub Release](https://img.shields.io/github/v/release/magneticstain/plexer?include_prereleases) -->
-![PyPI - Version](https://img.shields.io/pypi/v/plexer-cli)
+[![PyPI - Version](https://img.shields.io/pypi/v/plexer_cli)](https://pypi.org/project/plexer-cli/)
 
 ![GitHub License](https://img.shields.io/github/license/magneticstain/plexer)
 ![Supported Python Versions](https://img.shields.io/python/required-version-toml?tomlFilePath=https%3A%2F%2Fraw.githubusercontent.com%2Fmagneticstain%2Fplexer%2Frefs%2Fheads%2Fmain%2Fpyproject.toml)
@@ -36,10 +36,36 @@ Currently, Plexer only supports organizing movies and other individual video fil
 
 ## Install
 
-To install plexer, us pip/[pipx](https://github.com/pypa/pipx)/[pipenv](https://pipenv.pypa.io/en/latest/)/your favorite build front-end to install the `plexer-cli` package.
+To install Plexer, there are a few options available.
+
+### Docker
+
+The most portable way to install and run Plexer is by using Docker.
+
+#### Via Container Registry
+
+The easiest way to run Plexer in Docker is by using the public containers hosted on container registries. Plexer images are available on both Docker Hub and GitHub Container Registry. See the commands below for how to run Plexer using each registry.
+
+##### Docker Hub
+
+```bash
+docker run --rm -it magneticstain/plexer-cli
+```
+
+##### Github Container Registry
+
+```bash
+docker run --rm -it ghcr.io/magneticstain/plexer-cli
+```
+
+#### Via Local Build
+
+In the case that container registries are unavailable, there's also the option to build the image locally. To do that, check out the `main` branch of this repo, build the Plexer image, and run it.
 
 ```bash
-pip install plexer-cli
+git clone https://github.com/magneticstain/plexer-cli.git
+docker build -t plexer_cli .
+docker run --rm -it plexer_cli
 ```
 
 ## Requirements

{plexer_cli-0.0.1.post4 → plexer_cli-0.0.3}/pyproject.toml

@@ -3,7 +3,7 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "plexer-cli"
+name = "plexer_cli"
 dynamic = ["version"]
 description = "Normalize media files for use with Plex Media Server"
 readme = "README.md"
@@ -46,8 +46,11 @@ Documentation = "https://github.com/magneticstain/plexer#readme"
 Issues = "https://github.com/magneticstain/plexer/issues"
 Source = "https://github.com/magneticstain/plexer"
 
+[project.scripts]
+plexer = "plexer_cli.main:main"
+
 [tool.hatch.version]
-path = "plexer.py"
+path = "src/plexer_cli/main.py"
 
 [tool.hatch.envs.dev]
 dependencies = [
@@ -55,6 +58,3 @@ dependencies = [
   "pytest~=8.3.3",
   "moviepy~=1.0.3"
 ]
-
-[tool.hatch.build.targets.wheel]
-  packages = ["src/plexer"]

plexer_cli-0.0.1.post4/plexer.py → plexer_cli-0.0.3/src/plexer_cli/main.py

@@ -1,10 +1,12 @@
 #!/usr/bin/env python3
 """
 Plexer - Normalize media files for use with Plex Media Server
+
+Main App Entrypoint
 """
 
 __author__ = "magneticstain"
-__version__ = "0.0.1-4"
+__version__ = "0.0.3"
 __license__ = "MIT"
 
 import argparse
@@ -13,12 +15,30 @@ from logzero import logger
 # yes, docs suggest importing it twice:
 # https://logzero.readthedocs.io/en/latest/#advanced-usage-examples
 
-from plexer.file_manager import FileManager
+from plexer_cli.file_manager import FileManager
+
+def fetch_cli_args() -> argparse.Namespace:
+    """Parse CLI arguments passed to the application during startup"""
+
+    parser = argparse.ArgumentParser()
 
+    parser.add_argument(
+        "-v", "--verbose", action="count", default=0, help="Verbosity (-v, -vv, etc)"
+    )
 
-def main(cli_args):
+    parser.add_argument("--version", action="version", version=f"{__version__}")
+
+    parser.add_argument("-s", "--source-dir", action="store", required=True)
+    parser.add_argument("-d", "--destination-dir", action="store", required=True)
+
+    return parser.parse_args()
+
+
+def main():
     """Main entry point of the app"""
 
+    cli_args = fetch_cli_args()
+
     # logzero.json(enable=True)
     logzero.loglevel(logzero.DEBUG)
     logzero.logfile(None)
@@ -36,20 +56,3 @@ def main(cli_args):
     logger.info("processing artifacts")
     fm.process_directory(dir_artifacts=artifacts)
     logger.info("artifact processing completed successfully")
-
-
-if __name__ == "__main__":
-    parser = argparse.ArgumentParser()
-
-    parser.add_argument(
-        "-v", "--verbose", action="count", default=0, help="Verbosity (-v, -vv, etc)"
-    )
-
-    parser.add_argument("--version", action="version", version=f"{__version__}")
-
-    parser.add_argument("-s", "--source-dir", action="store", required=True)
-    parser.add_argument("-d", "--destination-dir", action="store", required=True)
-
-    args = parser.parse_args()
-
-    main(args)

{plexer_cli-0.0.1.post4 → plexer_cli-0.0.3}/tests/test_file_manager.py

@@ -7,8 +7,8 @@ from os import mkdir
 import pytest
 import moviepy.editor
 
-from plexer.const import METADATA_FILE_NAME
-from plexer.file_manager import FileManager
+from plexer_cli.const import METADATA_FILE_NAME
+from plexer_cli.file_manager import FileManager
 
 
 class TestFileManager:

{plexer_cli-0.0.1.post4 → plexer_cli-0.0.3}/tests/test_metadata.py

@@ -4,8 +4,8 @@ Plexer Unit Tests - Metadata.py
 
 import pytest
 
-from plexer.const import METADATA_FILE_NAME
-from plexer.metadata import Metadata
+from plexer_cli.const import METADATA_FILE_NAME
+from plexer_cli.metadata import Metadata
 
 
 class TestMetadata: