Overview
LizardByte has the full documentation hosted on Read the Docs.
About
Plexhints is a set of tools to aid in the development of plugins for Plex Media Server. It is not a framework, but rather a set of tools that can be used to make your life easier.
Features
Python library providing type hints to aid in the development of Plex plugins. Get rid of all those IDE warnings and errors!
A GitHub Action that will install and bootstrap a Plex Media Server in a CI environment. The action can install plugins and setup dummy libraries. Additionally the Plex token is provided as an output. This is useful for testing your plugin or other Plex project in a CI environment.
Integrations
Installation
Python Package
This library is available on PyPI as plexhints. It can be installed in several ways.
PyPI
python -m pip install plexhintsgit
python -m pip install git+https://github.com/lizardbyte/plexhints.git@dist#egg=plexhintsgithub archive
python -m pip install https://github.com/lizardbyte/plexhints/archive/dist.zip#egg=plexhintsUsage
Plexhints can be used by just importing the plexhints module and running a couple of functions. After doing so you can use plexhints in your IDE and run most of your code outside of Plex. This is useful for debugging and testing.
Main Entry Point
Place this at the top of your Contents/Code/__init__.py file. It is important to only import these when running outside of Plex.
# plex debugging
try:
import plexhints # noqa: F401
except ImportError:
pass
else: # the code is running outside of Plex
from plexhints import plexhints_setup, update_sys_path
plexhints_setup() # reads the plugin plist file and determine if plexhints should use elevated policy or not
update_sys_path() # when running outside plex, append the pathSubmodules
In files other than the main __init__.py file, you can simply import the plexhints module and use it as shown.
# plex debugging
try:
import plexhints # noqa: F401
except ImportError:
pass
else: # the code is running outside of Plex
from plexhints.log_kit import LogAvailable Imports
from plexhints.agent_kit import Agent, Media # agent kit
from plexhints.core_kit import Core # core kit
from plexhints.decorator_kit import handler, indirect, route # decorator kit
from plexhints.exception_kit import Ex # exception kit
from plexhints.locale_kit import Locale # locale kit
from plexhints.log_kit import Log # log kit
from plexhints.model_kit import Movie, VideoClip, VideoClipObject # model kit
from plexhints.network_kit import HTTP # network kit
from plexhints.object_kit import Callback, IndirectResponse, MediaObject, MessageContainer, MetadataItem, \
MetadataSearchResult, PartObject, SearchResult # object kit
from plexhints.parse_kit import HTML, JSON, Plist, RSS, XML, YAML # parse kit
from plexhints.prefs_kit import Prefs # prefs kit
from plexhints.proxy_kit import Proxy # proxy kit
from plexhints.resource_kit import Resource # resource kit
from plexhints.shortcut_kit import L, E, D, R, S # shortcut kit
from plexhints.util_kit import String, Util # util kit
from plexhints.constant_kit import CACHE_1MINUTE, CACHE_1HOUR, CACHE_1DAY, CACHE_1WEEK, CACHE_1MONTH # constant kit
from plexhints.constant_kit import ClientPlatforms, Protocols, OldProtocols, ServerPlatforms, ViewTypes, \
SummaryTextTypes, AudioCodecs, VideoCodecs, Containers, ContainerContents, \
StreamTypes # constant kit, more commonly used in URL services
# extra objects
from plexhints.extras_kit import BehindTheScenesObject, \
ConcertVideoObject, \
DeletedSceneObject, \
FeaturetteObject, \
InterviewObject, \
LiveMusicVideoObject, \
LyricMusicVideoObject, \
MusicVideoObject, \
OtherObject, \
SceneOrSampleObject, \
ShortObject, \
TrailerObject2 maintainers
Metadata
2 maintainers
Release files for plexhints 2024.520.225051
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| plexhints-2024.520.225051.tar.gz | 50.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| plexhints-2024.520.225051-py2-none-any.whl | Python 2 | none | any | Details |
Total release size: 124.9 kB
Release files / plexhints-2024.520.225051.tar.gz
| Download URL | plexhints-2024.520.225051.tar.gz |
|---|---|
| Size | 50.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
0803f947382887790fc35426c98d404e9eac31466d3f1154febf73893e891a01
|
|
BLAKE2b-256 checksum How to use checksums |
159531cf844962f4caa9334c8fc3250a52117c6ec67da16111c107ebec523844
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
Release files / plexhints-2024.520.225051-py2-none-any.whl
| Download URL | plexhints-2024.520.225051-py2-none-any.whl |
|---|---|
| Size | 73.9 kB |
| Tags | Python 2 |
|
SHA-256 checksum How to use checksums |
a15ee6cd8512f0616224f2d1d63093e831dce99f388310f2a85582d5892dd7a7
|
|
BLAKE2b-256 checksum How to use checksums |
6a4ced10f78cae009fec431aeddb49a645ff0bdcb495555c66d182955488ffaf
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/5.0.0 CPython/3.12.3
|
