plexer-cli 0.0.1a0__py3-none-any.whl

plexer/artifact.py

@@ -0,0 +1,20 @@
+"""
+Plexer - Normalize media files for use with Plex Media Server
+
+Module: Artifact Class
+"""
+
+
+class Artifact:
+    """
+    General artifact object
+    """
+
+    name = ""
+    absolute_path = ""
+    mime_type = ""
+
+    def __init__(self, name: str, path: str, mime_type: str) -> None:
+        self.name = name
+        self.absolute_path = path
+        self.mime_type = mime_type

plexer/const.py

@@ -0,0 +1,7 @@
+"""
+Plexer - Normalize media files for use with Plex Media Server
+
+Module: Const - collection of global variables used across the application
+"""
+
+METADATA_FILE_NAME = ".plexer"

plexer/file_manager.py

@@ -0,0 +1,131 @@
+"""
+Plexer - Normalize media files for use with Plex Media Server
+
+Module: File Manager - code for file-related ops
+"""
+
+import os
+from pathlib import Path
+from magic import from_file
+from logzero import logger
+
+from .artifact import Artifact
+from .const import METADATA_FILE_NAME
+from .metadata import Metadata
+
+
+class FileManager:
+    """
+    Class used for any file-related ops
+    """
+
+    src_dir = ""
+    dst_dir = ""
+
+    def __init__(self, src_dir, dst_dir) -> None:
+        self.src_dir = src_dir
+        self.dst_dir = dst_dir
+
+    def get_artifacts(self, tgt_dir="") -> list:
+        """
+        Gather the names of all files and directories in a given directory and return as list
+
+
+        Target directory is the source directory by default.
+        """
+
+        artifacts = []
+        tgt_dir = tgt_dir if tgt_dir else self.src_dir
+
+        with os.scandir(tgt_dir) as sd_iter:
+            for artifact_entry in sd_iter:
+                try:
+                    artifact_mime_type = from_file(artifact_entry.path, mime=True)
+                except IsADirectoryError:
+                    artifact_mime_type = "directory"
+
+                artifacts.append(
+                    Artifact(
+                        name=artifact_entry.name,
+                        path=artifact_entry.path,
+                        mime_type=artifact_mime_type,
+                    )
+                )
+
+        return artifacts
+
+    def prep_artifacts(self, artifacts: list) -> list:
+        """
+        Perform any processing needed to prepare the artifact data for further processing
+
+        Right now, this includes:
+            * Properly ordering artifacts such that the metadata file is first
+        """
+
+        for idx, artifact in enumerate(artifacts):
+            if artifact.name == METADATA_FILE_NAME:
+                # float it to the top of the artifact set
+                artifacts.pop(idx)
+                artifacts.insert(0, artifact)
+
+                break
+
+        return artifacts
+
+    def process_directory(self, dir_artifacts: list) -> None:
+        """
+        Traverse the given directory artifacts, rename the
+          video files accordingly, and delete everything else
+
+        NOTE: the artifact for the metadata file MUST come first
+          in the artifact list. Failing to do so may lead to instability
+          during artifact processing.
+        """
+
+        video_metadata = Metadata()
+
+        logger.debug("starting directory artifact processing")
+
+        for artifact in dir_artifacts:
+            logger.info(
+                "processing artifact: [ FILE: %s | PATH: %s | FILE TYPE: %s ]",
+                artifact.name,
+                artifact.absolute_path,
+                artifact.mime_type,
+            )
+
+            if artifact.mime_type == "directory":
+                logger.info("subdirectory found, processing")
+
+                # start recursive subprocessing
+                new_dir_artifacts = self.get_artifacts(tgt_dir=artifact.absolute_path)
+                self.process_directory(dir_artifacts=new_dir_artifacts)
+            elif artifact.name == METADATA_FILE_NAME:
+                # read in video metadata
+                logger.info("metadata file found, importing")
+
+                video_metadata.import_metadata_from_file(
+                    file_path=artifact.absolute_path
+                )
+            elif artifact.mime_type.startswith("video/"):
+                # move + rename
+                logger.info("video file found, renaming")
+
+                file_path = Path(artifact.absolute_path)
+                file_dir = file_path.parent
+                file_ext = file_path.suffix
+
+                src_file = artifact.absolute_path
+                dst_file = (
+                    f"{file_dir}/{video_metadata.name}"
+                    f" ({video_metadata.release_year}){file_ext}"
+                )
+
+                logger.debug("moving %s to %s", src_file, dst_file)
+
+                os.rename(src_file, dst_file)
+            else:
+                # delete the file
+                logger.info("unnecessary file found, deleting")
+
+                os.remove(artifact.absolute_path)

plexer/metadata.py

@@ -0,0 +1,41 @@
+"""
+Plexer - Normalize media files for use with Plex Media Server
+
+Module: Metadata - code for analyzing and managing video metadata
+"""
+
+import json
+from logzero import logger
+
+
+class Metadata:
+    """
+    Code used for managing the metadata of a given video file, especially names
+    """
+
+    name = ""
+    release_year = 0
+
+    def __init__(self, name="", release_year=1900) -> None:
+        self.name = name
+        self.release_year = release_year
+
+    def import_metadata_from_file(self, file_path: str) -> None:
+        """
+        Read in given file and process data into metadata values
+        """
+
+        logger.debug("metadata file found @ %s - importing data", file_path)
+
+        with open(file_path, mode="r", encoding="utf-8") as metadata_file:
+            imported_metadata = json.load(metadata_file)
+
+        logger.debug("data imported as: %s", imported_metadata)
+
+        try:
+            self.name = imported_metadata["name"]
+            self.release_year = imported_metadata["release_year"]
+        except KeyError as e:
+            logger.error(
+                'data missing in metadata file; "%s" field was not found', e.args[0]
+            )

plexer_cli-0.0.1a0.dist-info/METADATA

@@ -0,0 +1,105 @@
+Metadata-Version: 2.3
+Name: plexer-cli
+Version: 0.0.1a0
+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
+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
+Keywords: catagorization,formatting,media,organization,plex
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Environment :: Console
+Classifier: Framework :: Hatch
+Classifier: Framework :: Pytest
+Classifier: Framework :: tox
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: Unix
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Utilities
+Requires-Python: >=3.9
+Requires-Dist: logzero~=1.7.0
+Requires-Dist: python-magic~=0.4.27
+Description-Content-Type: text/markdown
+
+# Plexer
+
+Normalize media files for use with Plex Media Server.
+
+![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)
+
+[![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)
+[![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)
+
+![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)
+
+[![Hatch project](https://img.shields.io/badge/%F0%9F%A5%9A-Hatch-4051b5.svg)](https://github.com/pypa/hatch)
+[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
+
+## Requirements
+
+### Software Dependencies
+
+Start by creating a virtual environment and installing the required packages. Typically that looks something like:
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements.txt
+```
+
+### Media Metadata
+
+The biggest requirement before running plexer is to ensure that you've created a `.plexer` file in each of your target directories.
+
+This is a JSON-formatted file that includes the movie metadata required by Plexer to perform its jobs.
+
+#### Plexer File Generator
+
+To easily create the `.plexer` file, you can use the one-liner below while in the movie's directory:
+
+```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
+```
+
+It can be modified to support different types of media as well.
+
+## Usage
+
+The source directory is the directory containing the raw media. The destination is where you'd like to save the processed media to.
+
+```text
+usage: plexer.py [-h] [-v] [--version] -s SOURCE_DIR -d DESTINATION_DIR
+
+options:
+  -h, --help            show this help message and exit
+  -v, --verbose         Verbosity (-v, -vv, etc)
+  --version             show program's version number and exit
+  -s SOURCE_DIR, --source-dir SOURCE_DIR
+  -d DESTINATION_DIR, --destination-dir DESTINATION_DIR
+```
+
+## Development
+
+### Software Stack
+
+For developing with Plexer, there are several tools that are in use:
+
+1. Build Backend, Packaging, and Dependency Management:
+   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/)

plexer_cli-0.0.1a0.dist-info/RECORD

@@ -0,0 +1,9 @@
+plexer/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plexer/artifact.py,sha256=JnaWeEM9msrs_EZpfGn7Xr1TcG8A7mUG-7BXuKNwXdU,378
+plexer/const.py,sha256=U49nn11PvkOcvUf5eg1_hsYs12ULg_f2VtL81hWje-w,178
+plexer/file_manager.py,sha256=nfmBnQXK8JWPp4INfLE6kVqeD6NMxFnn1YoTmywI4Dg,4153
+plexer/metadata.py,sha256=UQ0nazq3agv7-h4NiVHNlpf2z_6rPLCBQ3TfIXKn0F8,1170
+plexer_cli-0.0.1a0.dist-info/METADATA,sha256=pBZ0Yz7v9GmKW90fqiXHR7kRTuynuQDDnqYZNQLXv6U,4562
+plexer_cli-0.0.1a0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+plexer_cli-0.0.1a0.dist-info/licenses/LICENSE,sha256=cs3weOTez4n04m4foiWXOU6C6Pr83ORocewlbPDaJGs,1069
+plexer_cli-0.0.1a0.dist-info/RECORD,,

plexer_cli-0.0.1a0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.25.0
+Root-Is-Purelib: true
+Tag: py3-none-any

plexer_cli-0.0.1a0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Josh Carlson
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.