Merge pull request #15 from LizardByte/nightly

v0.0.3

.github/workflows/CI.yml

@@ -40,7 +40,7 @@ jobs:
           path: PlexyGlass.bundle
 
       - name: Install Python 2.7
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: '2.7'
 
@@ -81,16 +81,29 @@ jobs:
             !**/*.git*
             !**/*.pyc
             !**/__pycache__
+            !**/plexhints*
             !**/PlexyGlass.bundle/.*
             !**/PlexyGlass.bundle/cache.sqlite
+            !**/Themerr-plex.bundle/DOCKER_README.md
+            !**/Themerr-plex.bundle/Dockerfile
             !**/PlexyGlass.bundle/docs
             !**/PlexyGlass.bundle/scripts
 
       - name: Package Release
         shell: bash
         if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/master' }}
         run: |
-          7z "-xr!*.git*" "-xr!*.pyc" "-xr!__pycache__" "-x!.*" "-x!cache.sqlite" "-x!docs" "-x!scripts" \
+          7z \
+            "-xr!*.git*" \
+            "-xr!*.pyc" \
+            "-xr!__pycache__" \
+            "-xr!plexhints*" \
+            "-xr!PlexyGlass.bundle/.*" \
+            "-xr!PlexyGlass.bundle/cache.sqlite" \
+            "-xr!PlexyGlass.bundle/DOCKER_README.md" \
+            "-xr!PlexyGlass.bundle/Dockerfile" \
+            "-xr!PlexyGlass.bundle/docs" \
+            "-xr!PlexyGlass.bundle/scripts" \
             a "./PlexyGlass.bundle.zip" "PlexyGlass.bundle"
 
           mkdir artifacts

.github/workflows/issues-stale.yml

@@ -15,7 +15,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Stale
-        uses: actions/stale@v5
+        uses: actions/stale@v6
         with:
           close-issue-message: >
             This issue was closed because it has been stalled for 10 days with no activity.
@@ -37,7 +37,7 @@ jobs:
           repo-token: ${{ secrets.GH_BOT_TOKEN }}
 
       - name: Invalid Template
-        uses: actions/stale@v5
+        uses: actions/stale@v6
         with:
           close-issue-message: >
             This issue was closed because the the template was not completed after 5 days.

.github/workflows/release-notifier.yml

@@ -0,0 +1,81 @@
+---
+# This action is centrally managed in https://github.com/<organization>/.github/
+# Don't make changes to this file in this repo as they will be overwritten with changes made to the same file in
+# the above-mentioned repo.
+
+name: Release Notifications
+
+on:
+  release:
+    types: [published]
+    # https://docs.github.com/en/actions/learn-github-actions/workflow-syntax-for-github-actions#onevent_nametypes
+
+jobs:
+  discord:
+    runs-on: ubuntu-latest
+    steps:
+      - name: discord
+        uses: sarisia/actions-status-discord@v1  # https://github.com/sarisia/actions-status-discord
+        with:
+          webhook: ${{ secrets.DISCORD_RELEASE_WEBHOOK }}
+          nodetail: true
+          nofail: false
+          username: ${{ secrets.DISCORD_USERNAME }}
+          avatar_url: ${{ secrets.ORG_LOGO_URL }}
+          title: ${{ github.event.repository.name }} ${{ github.ref_name }} Released
+          description: ${{ github.event.release.body }}
+          color: 0xFF4500
+
+  facebook_group:
+    runs-on: ubuntu-latest
+    steps:
+      - name: facebook-post-action
+        uses: ReenigneArcher/facebook-post-action@v1  # https://github.com/ReenigneArcher/facebook-post-action
+        with:
+          page_id: ${{ secrets.FACEBOOK_GROUP_ID }}
+          access_token: ${{ secrets.FACEBOOK_ACCESS_TOKEN }}
+          message: |
+            ${{ github.event.repository.name }} ${{ github.ref_name }} Released
+            ${{ github.event.release.body }}
+          url: ${{ github.event.release.html_url }}
+
+  facebook_page:
+    runs-on: ubuntu-latest
+    steps:
+      - name: facebook-post-action
+        uses: ReenigneArcher/facebook-post-action@v1  # https://github.com/ReenigneArcher/facebook-post-action
+        with:
+          page_id: ${{ secrets.FACEBOOK_PAGE_ID }}
+          access_token: ${{ secrets.FACEBOOK_ACCESS_TOKEN }}
+          message: |
+            ${{ github.event.repository.name }} ${{ github.ref_name }} Released
+            ${{ github.event.release.body }}
+          url: ${{ github.event.release.html_url }}
+
+  reddit:
+    runs-on: ubuntu-latest
+    steps:
+      - name: reddit
+        uses: bluwy/release-for-reddit-action@v1  # https://github.com/bluwy/release-for-reddit-action
+        with:
+          username: ${{ secrets.REDDIT_USERNAME }}
+          password: ${{ secrets.REDDIT_PASSWORD }}
+          app-id: ${{ secrets.REDDIT_CLIENT_ID }}
+          app-secret: ${{ secrets.REDDIT_CLIENT_SECRET }}
+          subreddit: ${{ secrets.REDDIT_SUBREDDIT }}
+          title: ${{ github.event.repository.name }} ${{ github.ref_name }} Released
+          url: ${{ github.event.release.html_url }}
+          flair-id: ${{ secrets.REDDIT_FLAIR_ID }}  # https://www.reddit.com/r/<subreddit>>/api/link_flair.json
+          comment: ${{ github.event.release.body }}
+
+  twitter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: twitter
+        uses: ethomson/send-tweet-action@v1  # https://github.com/ethomson/send-tweet-action
+        with:
+          consumer-key: ${{ secrets.TWITTER_API_KEY }}
+          consumer-secret: ${{ secrets.TWITTER_API_SECRET }}
+          access-token: ${{ secrets.TWITTER_ACCESS_TOKEN }}
+          access-token-secret: ${{ secrets.TWITTER_ACCESS_TOKEN_SECRET }}
+          status: ${{ github.event.release.html_url }}

CHANGELOG.md

@@ -1,9 +1,16 @@
 # Changelog
 
+## [0.0.3] - 2022-10-04
+### Fixed
+- `plexhints` import error on Docker
+- Reduced release bundle size
+### Updated
+- Improved documentation for Docker
+
 ## [0.0.2] - 2022-09-11
 ### Added
 - Add docker-mod for linuxserver plex image
-- 
+
 ## [0.0.1] - 2022-09-09
 ### Added
 - Initial Release

Contents/Code/__init__.py

@@ -4,7 +4,7 @@
 import sys
 
 # plex debugging
-if 'plexscripthost' not in sys.executable.lower():  # the code is running outside of Plex
+if 'plexscripthost' not in sys.executable.lower() or sys.executable != '':  # the code is running outside of Plex
     from plexhints import plexhints_setup, update_sys_path
     plexhints_setup()  # read the plugin plist file and determine if plexhints should use elevated policy or not
     update_sys_path()  # when running outside plex, append the path

Contents/Services/URL/YouTube/ServiceCode.pys

@@ -7,7 +7,7 @@ from typing import Optional
 import sys
 
 # plex debugging
-if 'plexscripthost' not in sys.executable.lower():  # the code is running outside of Plex
+if 'plexscripthost' not in sys.executable.lower() or sys.executable != '':  # the code is running outside of Plex
     from plexhints import update_sys_path
     update_sys_path()
 

DOCKER_README.md

@@ -1,11 +1,28 @@
-# Docker
+### lizardbyte/plexyglass
 
-This is a docker mod for Plex which adds [PlexyGlass](https://github.com/LizardByte/PlexyGlass) to Plex as a plugin,
-to be downloaded/updated during container start.
+This is a [docker-mod](https://linuxserver.github.io/docker-mods/) for
+[plex](https://hub.docker.com/r/linuxserver/plex) which adds [PlexyGlass](https://github.com/LizardByte/PlexyGlass)
+to plex as a plugin, to be downloaded/updated during container start.
 
-In plex docker arguments, set an environment variable `DOCKER_MODS=lizardbyte/plexyglass:latest`
+This image extends the plex image, and is not intended to be created as a separate container.
+
+### Installation
+
+In plex docker arguments, set an environment variable `DOCKER_MODS=lizardbyte/plexyglass:latest` or
+`DOCKER_MODS=ghcr.io/lizardbyte/plexyglass:latest`
 
 If adding multiple mods, enter them in an array separated by `|`, such as
 `DOCKER_MODS=lizardbyte/plexyglass:latest|linuxserver/mods:other-plex-mod`
 
-For more information about linuxserver docker-mods, see [here](https://linuxserver.github.io/docker-mods/).
+### Supported Architectures
+
+Specifying `lizardbyte/plexyglass:latest` or `ghcr.io/lizardbyte/plexyglass:latest` should retrieve the correct image
+for your architecture.
+
+The architectures supported by this image are:
+
+| Architecture | Available |
+|:------------:|:---------:|
+|    x86-64    |     ✅     |
+|    arm64     |     ✅     |
+|    armhf     |     ✅     |

README.rst

@@ -26,3 +26,7 @@ Downloads
 .. image:: https://img.shields.io/github/downloads/lizardbyte/plexyglass/total?style=for-the-badge&logo=github
    :alt: GitHub Releases
    :target: https://github.com/LizardByte/PlexyGlass/releases/latest
+
+.. image:: https://img.shields.io/docker/pulls/lizardbyte/plexyglass?style=for-the-badge&logo=docker
+   :alt: Docker
+   :target: https://hub.docker.com/r/lizardbyte/plexyglass

docs/source/about/docker.rst

@@ -1,3 +1,6 @@
 :github_url: https://github.com/LizardByte/PlexyGlass/tree/nightly/DOCKER_README.md
 
+Docker
+------
+
 .. mdinclude:: ../../../DOCKER_README.md

docs/source/about/installation.rst

@@ -2,10 +2,32 @@
 
 Installation
 ============
-#. Download the ``plexyglass.bundle.zip`` from the latest
-   `releases <https://github.com/LizardByte/PlexyGlass/releases/latest>`_
+The recommended method for running PlexyGlass is to use the `bundle`_ in the `latest release`_.
+
+Bundle
+------
+The bundle is cross platform, meaning Linux, macOS, and Windows are supported.
+
+#. Download the ``plexyglass.bundle.zip`` from the `latest release`_
 #. Extract the contents to your Plex Media Server Plugins directory.
 
 .. Tip:: See
    `How do I find the Plug-Ins folder <https://support.plex.tv/articles/201106098-how-do-i-find-the-plug-ins-folder>`_
    for information specific to your Plex server install.
+
+Docker
+------
+Docker images are available on `Dockerhub`_ and `ghcr.io`_.
+
+See :ref:`Docker <about/docker:docker>` for additional information.
+
+Source
+------
+.. Caution:: Installing from source is not recommended most users.
+
+#. Follow the steps in :ref:`Build <contributing/build:build>`.
+#. Move the compiled ``PlexyGlass.bundle`` to your Plex Media Server Plugins directory.
+
+.. _latest release: https://github.com/LizardByte/PlexyGlass/releases/latest
+.. _Dockerhub: https://hub.docker.com/repository/docker/lizardbyte/plexyglass
+.. _ghcr.io: https://github.com/orgs/LizardByte/packages?repo_name=plexyglass