plexer-cli 0.0.1a0__tar.gz → 0.0.1.post4__tar.gz

plexer_cli-0.0.1.post4/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,26 @@
+---
+name: Bug report
+about: Report a bug that you've found in the application
+title: ''
+labels: bug
+projects: "magneticstain/5"
+assignees: magneticstain
+
+---
+
+## Description
+
+A clear and concise description of what the bug is, what component it's in, etc.
+
+## Steps To Reproduce
+
+Steps to reproduce the behavior:
+
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+## Expected behavior
+
+A clear and concise description of what was expected to happen.

plexer_cli-0.0.1.post4/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,21 @@
+---
+name: Feature request
+about: Suggest an new feature for this project
+title: ''
+labels: feature
+projects: "magneticstain/5"
+assignees: magneticstain
+
+---
+
+## Feature Summary
+
+What does this feature do?
+
+## Benefit
+
+What is the benefit of implementing this?
+
+## Additional Context
+
+Add any other context, links, or screenshots about the feature request here.

{plexer_cli-0.0.1a0 → plexer_cli-0.0.1.post4}/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,5 +1,7 @@
 # PR Summary
 
+This is a summary.
+
 ## General Changes
 
 - A

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

@@ -8,9 +8,6 @@ on:
 
 jobs:
   release:
-    # ensure only tagged commits get uploaded to PyPI
-    # if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags')
-
     name: Generate New Release - ${{ github.ref_name }}
     runs-on: ubuntu-latest
     environment: release
@@ -27,9 +24,9 @@ jobs:
       - name: Setup python for build
         uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3  # v5.2.0
         with:
-          python-version: "3.12"
+          python-version: "3.x"
 
-      # run unit tests
+      # run tests
       - name: Install tox
         run: python -m pip install tox-gh>=1.2
 
@@ -46,12 +43,25 @@ 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
         uses: pypa/gh-action-pypi-publish@897895f1e160c830e369f9779632ebc134688e1b  # v1.10.2
         with:
           repository-url: https://test.pypi.org/legacy/
           print-hash: true
+          verbose: true
 
       - name: Publish to PyPI
         uses: pypa/gh-action-pypi-publish@897895f1e160c830e369f9779632ebc134688e1b  # v1.10.2

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

@@ -1,29 +1,29 @@
 Collecting tox-gh
   Downloading tox_gh-1.4.1-py3-none-any.whl.metadata (5.5 kB)
 Collecting tox>=4.18.1 (from tox-gh)
-  Downloading tox-4.20.0-py3-none-any.whl.metadata (5.0 kB)
+  Downloading tox-4.21.2-py3-none-any.whl.metadata (5.0 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)
   Downloading chardet-5.2.0-py3-none-any.whl.metadata (3.4 kB)
 Collecting colorama>=0.4.6 (from tox>=4.18.1->tox-gh)
   Downloading colorama-0.4.6-py2.py3-none-any.whl.metadata (17 kB)
-Collecting filelock>=3.15.4 (from tox>=4.18.1->tox-gh)
+Collecting filelock>=3.16.1 (from tox>=4.18.1->tox-gh)
   Downloading filelock-3.16.1-py3-none-any.whl.metadata (2.9 kB)
 Collecting packaging>=24.1 (from tox>=4.18.1->tox-gh)
   Downloading packaging-24.1-py3-none-any.whl.metadata (3.2 kB)
-Collecting platformdirs>=4.2.2 (from tox>=4.18.1->tox-gh)
+Collecting platformdirs>=4.3.6 (from tox>=4.18.1->tox-gh)
   Downloading platformdirs-4.3.6-py3-none-any.whl.metadata (11 kB)
 Collecting pluggy>=1.5 (from tox>=4.18.1->tox-gh)
   Downloading pluggy-1.5.0-py3-none-any.whl.metadata (4.8 kB)
-Collecting pyproject-api>=1.7.1 (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.3 (from tox>=4.18.1->tox-gh)
+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)
-Collecting distlib<1,>=0.3.7 (from virtualenv>=20.26.3->tox>=4.18.1->tox-gh)
+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.20.0-py3-none-any.whl (157 kB)
+Downloading tox-4.21.2-py3-none-any.whl (165 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)
@@ -33,7 +33,7 @@ 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 153.0 MB/s eta 0:00:00
+   ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ 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)
 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.20.0 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.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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: plexer-cli
-Version: 0.0.1a0
+Version: 0.0.1.post4
 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
@@ -31,36 +31,53 @@ Description-Content-Type: text/markdown
 
 # Plexer
 
-Normalize media files for use with Plex Media Server.
+<!-- 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)
 
 ![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)
 
+![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)
+
 [![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)
 
-![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)
+## Summary
 
-[![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)
+A CLI tool made to make organizing your media for [Plex Media Server](https://www.plex.tv/) easy. Normalize names of media files and directories to match [the hierarchial requirements that Plex requires](https://support.plex.tv/articles/naming-and-organizing-your-movie-media-files/).
 
-## Requirements
+## Features
+
+### Support
 
-### Software Dependencies
+Currently, Plexer only supports organizing movies and other individual video files.
 
-Start by creating a virtual environment and installing the required packages. Typically that looks something like:
+### Roadmap
+
+- [ ] Support for TV Shows ([#28](https://github.com/magneticstain/plexer/issues/28))
+- [ ] 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))
+
+## 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.
 
 ```bash
-python -m venv .venv
-source .venv/bin/activate
-pip install -r requirements.txt
+pip install plexer-cli
 ```
 
+## Requirements
+
 ### Media Metadata
 
-The biggest requirement before running plexer is to ensure that you've created a `.plexer` file in each of your target directories.
+The most important 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.
 
@@ -89,10 +106,17 @@ options:
   -d DESTINATION_DIR, --destination-dir DESTINATION_DIR
 ```
 
+## Support & Feedback
+
+If you run into issues while using Plexer, think you know a way to make it better, or just need help using it, create a new issue within this project and they will triaged when possible.
+
 ## Development
 
 ### Software Stack
 
+[![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)
+
 For developing with Plexer, there are several tools that are in use:
 
 1. Build Backend, Packaging, and Dependency Management:

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

@@ -1,35 +1,52 @@
 # Plexer
 
-Normalize media files for use with Plex Media Server.
+<!-- 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)
 
 ![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)
 
+![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)
+
 [![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)
 
-![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)
+## Summary
 
-[![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)
+A CLI tool made to make organizing your media for [Plex Media Server](https://www.plex.tv/) easy. Normalize names of media files and directories to match [the hierarchial requirements that Plex requires](https://support.plex.tv/articles/naming-and-organizing-your-movie-media-files/).
 
-## Requirements
+## Features
+
+### Support
 
-### Software Dependencies
+Currently, Plexer only supports organizing movies and other individual video files.
 
-Start by creating a virtual environment and installing the required packages. Typically that looks something like:
+### Roadmap
+
+- [ ] Support for TV Shows ([#28](https://github.com/magneticstain/plexer/issues/28))
+- [ ] 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))
+
+## 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.
 
 ```bash
-python -m venv .venv
-source .venv/bin/activate
-pip install -r requirements.txt
+pip install plexer-cli
 ```
 
+## Requirements
+
 ### Media Metadata
 
-The biggest requirement before running plexer is to ensure that you've created a `.plexer` file in each of your target directories.
+The most important 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.
 
@@ -58,10 +75,17 @@ options:
   -d DESTINATION_DIR, --destination-dir DESTINATION_DIR
 ```
 
+## Support & Feedback
+
+If you run into issues while using Plexer, think you know a way to make it better, or just need help using it, create a new issue within this project and they will triaged when possible.
+
 ## Development
 
 ### Software Stack
 
+[![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)
+
 For developing with Plexer, there are several tools that are in use:
 
 1. Build Backend, Packaging, and Dependency Management:

{plexer_cli-0.0.1a0 → plexer_cli-0.0.1.post4}/plexer.py

@@ -4,7 +4,7 @@ Plexer - Normalize media files for use with Plex Media Server
 """
 
 __author__ = "magneticstain"
-__version__ = "0.0.1-alpha"
+__version__ = "0.0.1-4"
 __license__ = "MIT"
 
 import argparse

plexer_cli-0.0.1a0/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,21 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ''
-labels: bug
-assignees: magneticstain
-
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**To Reproduce**
-Steps to reproduce the behavior:
-1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
-4. See error
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.

plexer_cli-0.0.1a0/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,17 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ''
-labels: enhancement
-assignees: magneticstain
-
----
-
-**Feature Summary**
-What does this feature do?
-
-**Benefit**
-What is the benefit of implementing this?
-
-**Additional context**
-Add any other context or screenshots about the feature request here.