plexer-cli 0.0.3.post5__tar.gz → 0.1.3__tar.gz

plexer_cli-0.1.3/.github/ISSUE_TEMPLATE/bug_report.yaml

@@ -0,0 +1,34 @@
+name: Bug Report
+about: Report a bug that you've found in this application.
+title: 'Bug: '
+labels: bug
+projects: "magneticstain/5"
+assignees: magneticstain
+type: bug
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: Description
+      description: A clear and concise description of what the bug is, what component it's in, etc.
+    validations:
+      required: true
+  - type: textarea
+    id: steps_to_reproduce
+    attributes:
+      label: Steps To Reproduce
+      description: Steps to reproduce the behavior.
+      placeholder: |
+        1. Go to '...'
+        2. Click on '....'
+        3. Scroll down to '....'
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    id: expected_behavior
+    attributes:
+      label: Expected Behavior
+      description: A clear and concise description of what was expected to happen.
+    validations:
+      required: true

plexer_cli-0.1.3/.github/ISSUE_TEMPLATE/feature_request.yaml

@@ -0,0 +1,29 @@
+name: Feature Request
+about: Suggest an new feature for this project
+title: 'Feat: '
+labels: feature
+projects: "magneticstain/5"
+assignees: magneticstain
+type: feature
+body:
+  - type: textarea
+    id: summary
+    attributes:
+      label: Summary
+      description: What does this feature intend to do?
+    validations:
+      required: true
+  - type: textarea
+    id: benefit
+    attributes:
+      label: Benefit
+      description: What is the benefit of implementing this?
+    validations:
+      required: true
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional Context
+      description: Add any other context, links, or screenshots about the feature request here.
+    validations:
+      required: true

plexer_cli-0.1.3/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+# PR Summary
+
+Include a general, high-level summary of what this PR presents.
+
+## Related Issue(s) [Opt.]
+
+Related to:

plexer_cli-0.1.3/.github/dependabot.yml

@@ -0,0 +1,23 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    schedule:
+      interval: "weekly"
+    target-branch: "main"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    labels:
+      - "dependencies"
+      - "security"
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    target-branch: "main"
+    commit-message:
+      prefix: "chore"
+      include: "scope"
+    labels:
+      - "dependencies"
+      - "security"

{plexer_cli-0.0.3.post5 → plexer_cli-0.1.3}/.github/workflows/openssf_scorecard.yml

@@ -4,8 +4,8 @@
 
 name: Scorecard supply-chain security scan
 on:
-  schedule:
-    - cron: '0 0 * * *'  # run a scan everyday at 00:00 UTC
+  # schedule:
+  #   - cron: '0 0 * * *'  # run a scan everyday at 00:00 UTC
   push:
     branches: [ main ]
 
@@ -23,25 +23,25 @@ jobs:
 
     steps:
       - name: "Checkout code"
-        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
         with:
           persist-credentials: false
 
       - name: "Run analysis"
-        uses: ossf/scorecard-action@62b2cac7ed8198b15735ed49ab1e5cf35480ba46 # v2.4.0
+        uses: ossf/scorecard-action@4eaacf0543bb3f2c246792bd56e8cdeffafb205a # v2.4.3
         with:
           results_file: results.sarif
           results_format: sarif
           publish_results: true
 
       - name: "Upload artifact"
-        uses: actions/upload-artifact@c24449f33cd45d4826c6702db7e49f7cdb9b551d # v3.2.1-node20
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
         with:
           name: SARIF file
           path: results.sarif
           retention-days: 5
 
       - name: "Upload to code-scanning"
-        uses: github/codeql-action/upload-sarif@294a9d92911152fe08befb9ec03e240add280cb3  # v3.26.8-64431c66d
+        uses: github/codeql-action/upload-sarif@e46ed2cbd01164d986452f91f178727624ae40d7 # v4.35.3
         with:
           sarif_file: results.sarif

{plexer_cli-0.0.3.post5 → plexer_cli-0.1.3}/.github/workflows/release.yml

@@ -6,6 +6,9 @@ on:
     tags:
       - 'v*'
 
+permissions:
+  contents: read
+
 jobs:
   release:
     name: Generate New Release - ${{ github.ref_name }}
@@ -19,28 +22,31 @@ jobs:
       packages: write  # required for pushing image to GHCR
     
     steps:
-      - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332  # v4.1.7
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
         with:
           fetch-depth: 0
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d  # v10.0.1
+        with:
+          enable-cache: true
 
       - name: Setup python for build
-        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3  # v5.2.0
-        with:
-          python-version: "3.x"
+        run: uv python install
 
       # run tests
-      - name: Install tox
-        run: python -m pip install tox-gh>=1.2
+      - name: Install build deps
+        run: uv sync --group build --dev
 
       - name: Setup test suite
-        run: tox -vv --notest -e test
+        run: uvx tox -vv --notest -e test
 
       - name: Run test suite
-        run: tox --skip-pkg-install -e test
+        run: uvx tox --skip-pkg-install -e test
       
       # build and publish
       - name: Install Hatch
-        run: pipx install hatch
+        run: uvx pipx install hatch
 
       - name: Build dist artifacts
         run: hatch build
@@ -48,22 +54,23 @@ jobs:
       # PyPI Release
       # required instead of using hatch due to usage of trusted publishers
       - name: Publish to TestPyPI
-        uses: pypa/gh-action-pypi-publish@897895f1e160c830e369f9779632ebc134688e1b  # v1.10.2
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33  # v1.14.2
         with:
           repository-url: https://test.pypi.org/legacy/
           print-hash: true
           verbose: true
+          attestations: false
 
       - name: Publish to PyPI
-        uses: pypa/gh-action-pypi-publish@897895f1e160c830e369f9779632ebc134688e1b  # v1.10.2
+        uses: pypa/gh-action-pypi-publish@dc37677b2e1c63e2034f94d8a5b11f265b73ba33  # v1.14.2
         with:
           attestations: true
       
       # Github Release
       - name: Create Github Release
-        uses: softprops/action-gh-release@c062e08bd532815e2082a85e87e3ef29c3e6d191  # v2.0.8
+        uses: softprops/action-gh-release@a06a81a03ee405af7f2048a818ed3f03bbf83c7b  # v2.5.0
         with:
-          name: 
+          name: ${{ github.ref_name }}
           files: |
             dist/*
           fail_on_unmatched_files: true
@@ -72,6 +79,7 @@ jobs:
       
       # 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
+      ## Uploads to Docker.io and ghcr.io (GitHub Container Registry)
       - name: Log in to Docker Hub
         uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567  # v3.3.0
         with:
@@ -87,10 +95,10 @@ jobs:
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81  # v5.5.1
+        uses: docker/metadata-action@c299e40c65443455700f0fdfc63efafe5b349051  # v5.10.0
         with:
           images: |
-            magneticstain/plexer-cli
+            magneticstain/${{ github.repository }}
             ghcr.io/${{ github.repository }}
 
       - name: Build and push Docker images to all registries
@@ -99,13 +107,15 @@ jobs:
         with:
           context: .
           push: true
+          # provenance: mode=max
+          # sbom: 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
+      # - name: Generate artifact attestation
+      #   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.3.post5 → plexer_cli-0.1.3}/.github/workflows/run_full_test_suite.yml

@@ -18,31 +18,35 @@ jobs:
     strategy:
       matrix:
         py:
+          # - "3.15"
+          - "3.14"
+          - "3.13"
           - "3.12"
           - "3.11"
           - "3.10"
-          - "3.9"
         os:
           - ubuntu-latest
 
     steps:
-      - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938  # v4.2.0
+      - uses: actions/checkout@8e8c483db84b4bee98b60c0593521ed34d9990e8  # v6.0.1
         with:
           fetch-depth: 0
-
-      - name: Setup python for test - ${{ matrix.py }}
-        uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3  # v5.2.0
+      
+      - name: Install uv and set python versions
+        uses: astral-sh/setup-uv@20cfd1bf945f4377ade1205e4dbc17946fc9a30d  # v10.0.1
         with:
           python-version: ${{ matrix.py }}
-      
-      - name: Setup ffmpeg for unit tests (moviepy)
-        uses: federicocarboni/setup-ffmpeg@37062fbf7149fc5578d6c57e08aed62458b375d6  # v3.1
+          enable-cache: true
+
+      - name: Setup python for build
+        run: uv python install
 
-      - name: Install tox
-        run: python -m pip install tox-gh>=1.2
+      # run tests
+      - name: Install build deps
+        run: uv sync --group build --dev
 
       - name: Setup test suite
-        run: tox -vv --notest -e test
+        run: uvx tox -vv --notest -e test
 
       - name: Run test suite
-        run: tox --skip-pkg-install -e test
+        run: uvx tox --skip-pkg-install -e test

{plexer_cli-0.0.3.post5 → plexer_cli-0.1.3}/.gitignore

@@ -161,6 +161,3 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
-
-# VS Code configs
-.vscode/

plexer_cli-0.1.3/.pre-commit-config.yaml

@@ -0,0 +1,12 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.15.1
+    hooks:
+      - id: ruff-format
+      - id: ruff-check
+        args: [ --fix ]
+  # REF: https://docs.astral.sh/uv/guides/integration/pre-commit/
+  - repo: https://github.com/astral-sh/uv-pre-commit
+    rev: 0.10.2
+    hooks:
+      - id: uv-lock

plexer_cli-0.1.3/.python-version

@@ -0,0 +1 @@
+3.14

plexer_cli-0.1.3/.tool-versions

@@ -0,0 +1 @@
+uv 0.10.2

plexer_cli-0.1.3/.trivyignore.yaml

@@ -0,0 +1,2 @@
+misconfigurations:
+  - id: AVD-DS-0026

plexer_cli-0.1.3/.vscode/launch.json

@@ -0,0 +1,42 @@
+{
+    "version": "0.2.0",
+    "configurations": [
+        
+        {
+            "name": "Run w/ Tmp Dirs",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "plexer_cli.main",
+            "args": [
+                "--source-dir", "/tmp/plexer-e2e/plexer-cli-test",
+                "--destination-dir", "/tmp/plexer-e2e/plexer-cli-test-dst",
+                "-vv"
+            ],
+            "justMyCode": true,
+        },
+        {
+            "name": "Dry Run w/ Tmp Dirs",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "plexer_cli.main",
+            "args": [
+                "--source-dir", "/tmp/plexer-e2e/plexer-cli-test",
+                "--destination-dir", "/tmp/plexer-e2e/plexer-cli-test-dst",
+                "--dry-run", "-vv"
+            ],
+            "justMyCode": true,
+        },
+        {
+            "name": "Dry Run w/ Tmp Dirs - Prompt All",
+            "type": "debugpy",
+            "request": "launch",
+            "module": "plexer_cli.main",
+            "args": [
+                "--source-dir", "/tmp/plexer-e2e/plexer-cli-test",
+                "--destination-dir", "/tmp/plexer-e2e/plexer-cli-test-dst",
+                "--prompt=all", "--dry-run", "-vv"
+            ],
+            "justMyCode": true,
+        }
+    ]
+}

plexer_cli-0.1.3/.vscode/plexer-cli.code-workspace

@@ -0,0 +1,11 @@
+{
+	"folders": [
+		{
+			"path": ".."
+		}
+	],
+	"settings": {
+		"trivy.useIgnoreFile": true,
+		"trivy.secretScanning": true
+	}
+}

plexer_cli-0.1.3/.vscode/settings.json

@@ -0,0 +1,7 @@
+{
+    "python.testing.pytestArgs": [
+        "tests"
+    ],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true
+}

plexer_cli-0.1.3/Dockerfile

@@ -0,0 +1,45 @@
+# syntax=docker/dockerfile:1
+
+FROM ghcr.io/astral-sh/uv:alpine3.23@sha256:7d1ef166503c3c123a51f17d4eeb4dc748c33ebf4ae3bfad54f1163e1c36afcb AS build
+
+WORKDIR /build
+
+# we are unable to use the --require-hashes option as there is no local file defining the hashes
+# this is what pip uses for comparison by default.
+# However, it can compare the hash against PyPI's hash.
+# Since PyPI sends requests over TLS, this should be secure enough for our threat model.
+# https://pypi.org/project/pipx/
+# RUN pip install pipx==1.7.1 --hash=sha256:a575ced25c507c1b1c978269f5684b5b291e81e3cd14eb3cee196a3c5b304732
+RUN uv sync --group build
+# https://pipx.pypa.io/latest/how-to/pin-packages.html
+RUN pipx install hatch==1.13.0 && pipx pin hatch
+
+COPY . .
+
+ENV PATH="$PATH:/root/.local/bin"
+
+RUN hatch build
+
+########################
+
+# Google distroless Python 3.13 Alpine image
+FROM gcr.io/distroless/python3-debian13:nonroot-arm64@sha256:f7a5fde15cf1e287dffac51d5d683e06dc6d4e5f63dde693fc8a4e54ac47cbcd
+
+RUN apk update && \
+    apk add --no-cache libmagic
+
+RUN addgroup --system --gid 1001 plexer && \
+    adduser --system --uid 1001 --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.3.post5 → plexer_cli-0.1.3}/PKG-INFO

@@ -1,11 +1,10 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.5
 Name: plexer_cli
-Version: 0.0.3.post5
-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
+Version: 0.1.3
+Summary: Normalize media files and directories for use with Plex Media Server
+Project-URL: Repository, https://github.com/magneticstain/plexer
+Project-URL: Documentation, https://github.com/magneticstain/plexer-cli/wiki
 Project-URL: Issues, https://github.com/magneticstain/plexer/issues
-Project-URL: Source, https://github.com/magneticstain/plexer
 Author-email: Josh Carlson <837837+magneticstain@users.noreply.github.com>
 License-Expression: MIT
 License-File: LICENSE
@@ -16,16 +15,21 @@ Classifier: Framework :: Hatch
 Classifier: Framework :: Pytest
 Classifier: Framework :: tox
 Classifier: Intended Audience :: System Administrators
-Classifier: License :: OSI Approved :: MIT License
+Classifier: Natural Language :: English
+Classifier: Operating System :: MacOS
 Classifier: Operating System :: Unix
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.9
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Multimedia :: Video
 Classifier: Topic :: Utilities
-Requires-Python: >=3.9
+Requires-Python: >=3.10
 Requires-Dist: logzero~=1.7.0
+Requires-Dist: prompt-toolkit>=3.0.52
 Requires-Dist: python-magic~=0.4.27
 Description-Content-Type: text/markdown
 
@@ -41,8 +45,8 @@ Description-Content-Type: text/markdown
 ![GitHub Issues or Pull Requests](https://img.shields.io/github/issues/magneticstain/plexer)
 ![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/magneticstain/plexer/total)
 
-[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/magneticstain/plexer/badge)](https://scorecard.dev/viewer/?uri=github.com/magneticstain/plexer)
-[![Codacy Badge](https://app.codacy.com/project/badge/Grade/38b2a65ed9ac4c85afc98e259d73474f)](https://app.codacy.com/gh/magneticstain/plexer/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
+[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/magneticstain/plexer-cli/badge)](https://scorecard.dev/viewer/?uri=github.com/magneticstain/plexer-cli)
+[![OpenSSF Best Practices](https://www.bestpractices.dev/projects/13659/badge)](https://www.bestpractices.dev/projects/13659)
 
 [![Run Full Suite of Checks and Tests](https://github.com/magneticstain/plexer/actions/workflows/run_full_test_suite.yml/badge.svg)](https://github.com/magneticstain/plexer/actions/workflows/run_full_test_suite.yml)
 [![Release](https://github.com/magneticstain/plexer/actions/workflows/release.yml/badge.svg)](https://github.com/magneticstain/plexer/actions/workflows/release.yml)
@@ -60,15 +64,13 @@ Currently, Plexer only supports organizing movies and other individual video fil
 ### Roadmap
 
 - [ ] Support for TV Shows ([#28](https://github.com/magneticstain/plexer/issues/28))
-- [ ] Docker implementations ([#29](https://github.com/magneticstain/plexer/issues/29))
+- [X] Docker implementations ([#29](https://github.com/magneticstain/plexer/issues/29))
 - [ ] MacOS support ([#30](https://github.com/magneticstain/plexer/issues/30))
 - [ ] Windows support ([#31](https://github.com/magneticstain/plexer/issues/31))
-- [ ] Metadata inference using file/directory info (i.e. analyze the video files to "guess" what the name, year, etc is) ([#32](https://github.com/magneticstain/plexer/issues/32))
+- [X] Metadata inference using file/directory info (i.e. analyze the video files to "guess" what the name, year, etc is) ([#32](https://github.com/magneticstain/plexer/issues/32))
 
 ## Install
 
-To install Plexer, there are a few options available.
-
 ### Docker
 
 The most portable way to install and run Plexer is by using Docker.
@@ -89,7 +91,7 @@ docker run --rm -it magneticstain/plexer-cli
 docker run --rm -it ghcr.io/magneticstain/plexer-cli
 ```
 
-#### Via Local Build
+#### Via Local Image 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.
 
@@ -101,21 +103,19 @@ docker run --rm -it plexer_cli
 
 ## Requirements
 
-### Media Metadata
+### Linux and MacOS Native Install
 
-The most important requirement before running plexer is to ensure that you've created a `.plexer` file in each of your target directories.
+If you've installed plexer-cli natively (i.e. outside of a Docker container) on Ubuntu, Devian, Fedora, etc, or MacOS, you will also need to install additional dependencies:
 
-This is a JSON-formatted file that includes the movie metadata required by Plexer to perform its jobs.
+#### Python-Magic
 
-#### Plexer File Generator
+While `python-magic` is imported in the standard fashion (via pip/python requirements), it itself depends on the presence of the libmagic C library. To install this library, follow [the installation instructions provided in the `python-magic` README](https://github.com/ahupp/python-magic?tab=readme-ov-file#installation).
 
-To easily create the `.plexer` file, you can use the one-liner below while in the movie's directory:
+### Media Metadata
 
-```bash
-echo -n "Media Name: ";read MEDIA_NAME;echo -n "Release Year (YYYY): ";read RELEASE_YEAR;echo "{\"name\": \"${MEDIA_NAME}\", \"release_year\": \"${RELEASE_YEAR}\"}" > .plexer
-```
+The most important requirement before running plexer is to ensure that you've created a `.plexer` file in each of your target directories.
 
-It can be modified to support different types of media as well.
+This is a JSON-formatted file that includes the movie metadata required by Plexer to perform its jobs.
 
 ## Usage
 
@@ -149,7 +149,17 @@ For developing with Plexer, there are several tools that are in use:
    1. [Hatch](https://hatch.pypa.io/1.12/)
 1. Analysis Tools:
    1. [Ruff](https://docs.astral.sh/ruff/)
-   1. [Codacy](https://app.codacy.com/gh/magneticstain/plexer/dashboard)
 1. Testing:
    1. [Pytest](https://docs.pytest.org/en/latest/)
    1. [Tox](https://tox.wiki/en/stable/)
+
+### Coding Standards and Conventions
+
+- Pre-commit hooks are utilized and managed in `.pre-commit-config.yml`
+  - For example, `ruff` is run as part of every commit
+  - These pre-commit hooks **MUST** be installed and utilized by all developers
+
+#### Testing
+
+- All functions **MUST** have unit tests created for them
+- Tests are executed using **VS Code** with the `launch.json` config file in `.vscode`