Changelog

0.5.0

• Removed: [npc.PeriodicJob] npc.PeriodicJob.min_delay removed to make the waiting for next run non GIL blocking

• Added: [npc.PeriodicJob] npc.PeriodicJob.all_jobs - list of all running jobs, npc.PeriodicJob.log - Logging for jobs, npc.PeriodicJob.id - Unique ID of the job, npc.PeriodicJob.set_log_level() - To change the log level for a job

• Changed: [npc.PeriodicJob] _stopped -> _stop_event, _can_run -> _pause_event, npc.PeriodicJob.last_run - Is now a instance variable rather than class variable which could have caused unexpected behaviour

• Changed: [npc.info.load_config()] Move to agnostic pyproject instead of poetry specific

• Changed: [npc.BasePlugin.check_update()] Always show the update window not only on the first run

• Added: [npc.BasePlugin.update_available()] Hook to handle available updates for plugins that need it

• Changed: [npc.BasePlugin.stop()] Stop all running periodic jobs (incl. ones not created by the base plugin)

• Changed: [npc.BasePlugin.settings_changed()] Also adjust logging for periodic jobs

0.4.2

• Changed: [npc.BasePlugin._automatic_update_check_delay()] Fix automatic update delay not reflected when changing the interval

0.4.1

• Changed: [npc.reload_plugin()] Changed plugin_name to plugin_id as it is more accurate

• Removed: [npc.BasePlugin] Removed npc.BasePlugin.__name__() in favour of npc.BasePlugin.plugin_name.

• Added: [npc.BasePlugin.plugin_identifier()] Added plugin identifier

• Changed: [npc.BasePlugin.stop()] Fix unloading of modules

0.4.0

• Changed: [npc.config.Field] Added label parameter and made description optional.

• Added: [npc.config.Field.metasettings_description()] Added property combining label and description

• Changed: [npc.String()] Added label parameter and made description optional.

• Changed: [npc.Int()] Added label parameter and made description optional.

• Changed: [npc.Float()] Added label parameter and made description optional.

• Changed: [npc.Bool()] Added label parameter and made description optional.

• Changed: [npc.TextView()] Added label parameter and made description optional.

• Changed: [npc.Dropdown()] Added label parameter and made description optional.

• Changed: [npc.Radio()] Added label parameter and made description optional.

• Changed: [npc.ListString()] Added label parameter and made description optional.

• Changed: [npc.File()] Added label parameter and made description optional.

• Changed: [npc.Folder()] Added label parameter and made description optional.

• Changed: [npc.Image()] Added label parameter and made description optional.

• Added: [npc.changes] [npc.IS_DEV] Explicit flag for development versions

• Changed: [npc.info.load_config()] Return whether the plugin is a development version

0.3.6

• Changed: [npc.log()] Fix windowed messages on Nicotine+ < 3.3.0

• Added: [npc.LegacyLogLevel] Fix windowed messages on Nicotine+ < 3.3.0

• Changed: [npc.BasePlugin.check_update()] Show window if no updates are available

0.3.5

• Changed: [npc.command()] Support legacy command system for Nicotine+ < 3.3.0

• Changed: [npc.logging.NLogHandler] Fix logging on Nicotine+ < 3.3.3

• Changed: [npc.log()] Fix logging on Nicotine+ < 3.3.3

• Changed: [npc.Version.parse()] Properly parse version strings with alpha, beta, and dev releases. Fixing recognition of dev version in config.

• Changed: [npc.BasePlugin._setup_commands()] Add support for Nicotine+ < 3.3.0 legacy command system

0.3.4

• Changed: [npc.BasePlugin.settings_changed()] Fixed still logging debug messages when verbose is disabled

0.3.2

• Added: [npc.changes] Export * from npc module in root __init__.py, in order to make imports easier when this package is used in another party plugin.

• Changed: [npc.changes] Updated scripts.py and generate_changelog.py to be usable in plugins using this package. Just copy them over and use them as is.

• Changed: [npc.changes] Document the use of all the scripts in this package.

0.3.1

• Changed: [npc.config.Field] Removed plugin as a parameter for the from_value function.

• Changed: [npc.config.Field.from_value()] Removed plugin as a parameter.

• Added: [npc.Folder()] Quick alias for File() with npc.types.FileChooser.FOLDER

• Added: [npc.Image()] Quick alias for File() with npc.types.FileChooser.IMAGE

0.3.0

• Added: [npc.File()] (no description provided)

• Changed: [npc.Version] Add support for proper semantic versioning (alpha and beta releases)

0.2.0

• Added: [npc.logging.NLogHandler] (no description provided)

• Removed: [npc.BasePlugin] Removed npc.BasePlugin.vlog() in favour of the npc.BasePlugin.log logger instance. Use self.log.debug(...) instead.

• Changed: [npc.BasePlugin] Replaced npc.BasePlugin.log() function with npc.BasePlugin.log logger instance. Use self.log.info(...) instead of self.log(...).

• Changed: [npc.BasePlugin.window()] Renamed from npc.BasePlugin.window_log() to npc.BasePlugin.window()