forked from Github/Axter-Stash
33 lines
1.3 KiB
Markdown
33 lines
1.3 KiB
Markdown
# StashPluginHelper: Ver 0.1.0 (By David Maisonave)
|
|
StashPluginHelper is a class that performs common implementation used in most plugins.
|
|
|
|
### Features
|
|
- Log Features:
|
|
- Optionally log out to multiple outputs for each Log or Trace call.
|
|
- Logging includes source code line number.
|
|
- Sets a maximum plugin log file size.
|
|
- Stash Interface Features:
|
|
- Sets STASH_INTERFACE with StashInterface
|
|
- Gets STASH_URL value from command line argument and/or from STDIN_READ
|
|
- Sets FRAGMENT_SERVER based on command line arguments or STDIN_READ
|
|
- Sets PLUGIN_ID based on the main script file name (in lower case)
|
|
- Gets PLUGIN_TASK_NAME value
|
|
- Sets pluginSettings (The plugin UI settings)
|
|
- Misc Features:
|
|
- Gets DRY_RUN value from command line argument and/or from UI and/or from config file.
|
|
- Gets DEBUG_TRACING value from command line argument and/or from UI and/or from config file.
|
|
- Sets RUNNING_IN_COMMAND_LINE_MODE to True if detects multiple arguments
|
|
- Sets CALLED_AS_STASH_PLUGIN to True if it's able to read from STDIN_READ
|
|
|
|
### Using StashPluginHelper
|
|
from filemonitor_config import config
|
|
settings = {
|
|
"recursiveDisabled": False,
|
|
"zzdebugTracing": False,
|
|
"zzdryRun": False,
|
|
}
|
|
plugin = StashPluginHelper(settings=settings, config=config)
|
|
|
|
### Requirements
|
|
`pip install stashapp-tools --upgrade`
|