Nokwatch docs
Star Fork

Plugins

Nokwatch supports optional plugins that add new job types and UI. Plugins use the same database and dashboard: you manage all jobs (standard monitors and plugin jobs) from the main UI and use the same notifications, tags, and cooldowns.

Installing plugins

From the Web UI

Open Modules in the menu to see available plugins. You can install or uninstall from there (requires network; plugins are installed via pip). After installing, restart Nokwatch so it picks up the plugin.

From the command line

With your Nokwatch environment active:

pip install nokwatch-scan

Or from source (e.g. from the Nokwatch repo):

pip install -e plugins/nokwatch-scan

Restart the app so it loads the plugin. The plugin’s menu item (e.g. Scanner) will appear in the nav.

Source code

The nokwatch-scan plugin source is included in the main Nokwatch repo under plugins/nokwatch-scan. Future plugins will live in a dedicated nokwatch-plugins repository (separate from the main Nokwatch repo).

nokwatch-scan (Scanner)

The Scanner plugin monitors listing pages (e.g. eBay, job boards, classifieds) for new or changed items.

Listing scan jobs

Configure a URL and an extractor:

  • JSON APIs — Use JSONPath (e.g. $.items[*]) to define the list of items and fields for item URL, title, and price.
  • HTML pages — Use CSS selectors for the item container, title, link, and price.

Nokwatch fetches the page on a schedule, extracts items, and notifies you when new items appear or match your filters.

Filters

Optional text pattern and price range (min/max) let you narrow results before notifications.

Scanner UI

Use Scanner in the menu to add, edit, and manage scan jobs. You can run a check immediately to test the extractor. Scan jobs also appear on the main dashboard.

Editing scan jobs from the dashboard

You can edit shared options (notifications, tags, cooldown, auth) from the main Edit Monitor dialog. For extractor config (JSONPath or CSS selectors), use the Scanner’s edit page (/scan/<id>/edit).

More plugins

Additional plugins (e.g. other job types and integrations) are in development.

See API Reference for plugin APIs (e.g. Scanner /api/scan/jobs).