webchanges

pypi version supported Python version licence

Read the documentation at https://webchanges.readthedocs.io/en/latest/ travis build status code coverage

webchanges checks webpages (or the output of local commands) for changes, and notifies you via e-mail or one of many other supported services if one is detected. The notification includes the changed URL or command and a summary of what has changed. This project is a fork of urlwatch as suggested here and is optimized for HTML, ensuring that it “just works”.

Installation

webchanges is available on PyPI and can be installed using pip:

pip install webchanges

Optional dependencies may be needed; see here.

Documentation

The documentation is hosted on Read the Docs

Code

The code and issues tracker are hosted on GitHub

Quick Start

  1. Run webchanges --edit to customize your job list (this will create jobs.yaml and config.yaml)

  2. Run webchanges --edit-config if you want to set up e-mail sending

The interval for checking is defined by how often you run webchanges. It is recommended to use schedulers to automatically run webchanges periodically:

  • In Linux, you can use cron. Use crontab.guru to figure out the schedule expression for the checking interval, we recommend no more often than 30 minutes (this would be */30 * * * *). If you have never used cron before, check out the crontab command help.

  • On Windows, use the Windows Task Scheduler or see this question on StackOverflow for alternatives.

Contributing

We welcome many types of contributions, e.g. documentation, bug reports, pull requests (code, infrastructure or documentation fixes and more!). For more information about how to contribute to the project, see here.

License

Released under the MIT License, but including code licensed under the BSD 3-Clause License. See the license here.