Dependencies

Python version

webchanges requires Python 3.6 or higher to run.

Mandatory packages

If webchanges is installed with pip, these Python packages are installed automatically:

Optional packages

Certain features require additional Python packages to work. These optional packages are installed by appending to the name webchanges the name of the feature (from the table below) inside square brackets, like so:

python3 -m pip install webchanges[use_browser]
python3 -m pip install webchanges[use_browser,redis]

Feature

Python package(s) installed

use _browser set to true (in a url job)

  • pyppeteer Note: you may also have to separately install OS-specific dependencies 1

bs4 method of the html2text filter

beautify filter

pdf2text filter

  • pdftotext Note: you will also have to separately install the required OS-specific dependencies 4

ocr filter

ical2text filter

pushover reporter

pushbullet reporter

matrix reporter

xmpp reporter

redis database

safe_password storage for email and xmpp reporters

testing

(to work on contributions to the project)

all

  • all the optional packages listed above. Note: you will also have to separately install the required OS-specific dependencies 1 4 5

Footnotes

1(1,2)

pypetteer’s OS-specific dependencies (non required in Windows or MacOS) are listed here. A missing dependency is often the cause of the error pyppeteer.errors.BrowserError: Browser closed unexpectedly.

2

Optional, to beautify content of <script> tags

3

Optional, to beautify content of <style> tags

4(1,2)

see https://github.com/jalan/pdftotext#os-dependencies

5(1,2)

see https://tesseract-ocr.github.io/tessdoc/Home.html