Skip to main content

Check web (or commands) for changes since last run and notify. Anonymously alerts you of webpage changes.

Project description

webchanges checks web content and notifies you via e-mail (or one of many other supported services) if a change is detected. webchanges can also check the output of local commands. The notification includes the changed URL or command and a summary (diff) of what has changed.

webchanges anonymously alerts you of webpage changes.

Requirements

webchanges requires Supported Python versions.

You should use the latest version of Python if possible, but older Python versions are supported for 3 years after being obsoleted by a new major release (3.x). For each major release, only the latest bug and security fix version (3.x.y) is supported.

Installation

Install webchanges PyPI version Kit format Package stability with:

pip install webchanges

Documentation

The documentation is hosted on Read the Docs Documentation status.

Quick Start

Initialize

  1. Run the following command to create the default config.yaml (configuration) and jobs.yaml (jobs) files and open an editor to add your jobs:

    webchanges --edit
  2. Run the following command to change the default configuration, e.g. to receive change notifications (”reports”) by e-mail and/or one of many other methods:

    webchanges --edit-config

Run

To check the sources in your jobs and report on (e.g. display or via e-mail) any changes found from the previous execution, just run:

webchanges

webchanges does not include a scheduler. We recommend using a system scheduler to automatically run webchanges periodically:

  • On Linux or macOS, you can use cron (if you have never used cron before, see here); crontab.guru will build a schedule expression for you.

  • On Windows, you can use the built-in Windows Task Scheduler.

Code

Code coverage by Coveralls Issues at https://github.com/mborsetti/webchanges/issues

The code and issues tracker are hosted on GitHub.

Contributing

We welcome any contribution no matter how small as both pull requests and issue reports.

More information for developers and documentation contributors is here, and our wishlist is here.

License

License at https://pypi.org/project/webchanges/

Released under the MIT License but redistributing modified source code from urlwatch 2.21 licensed under a BSD 3-Clause License. See the complete license here.

Compatibility with urlwatch

This project is based on urlwatch 2.21. You can easily upgrade from urlwatch 2.25 (see here) using the same job and configuration files and benefit from many HTML-focused improvements, including:

  • Report links that are clickable!

  • Original formatting such as bolding / headers, italics, underlining, list bullets (•) and indentation;

  • Added and deleted lines clearly highlighted by color and strikethrough, and long lines that wrap around;

  • Correct rendering by email clients who override stylesheets (e.g. Gmail);

  • Other legibility improvements;

  • Use of stable Playwright instead of buggy Pyppeteer for websites that need JavaScript rendering before capture, increasing stability, reliability, flexibility and control;

  • New filters such as additions_only, which makes it easier to track content that was added without the distractions of the content that was deleted;

  • Much better documentation;

  • More reliability and stability, including a 39 percentage point increase in testing coverage to 81%;

  • Many other additions, refinements and fixes (see detailed information).

Examples:

https://raw.githubusercontent.com/mborsetti/webchanges/main/docs/html_diff_filters_example_1.png

https://raw.githubusercontent.com/mborsetti/webchanges/main/docs/html_diff_filters_example_3.png

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

webchanges-3.10.3.tar.gz (119.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

webchanges-3.10.3-py3-none-any.whl (129.1 kB view details)

Uploaded Python 3

File details

Details for the file webchanges-3.10.3.tar.gz.

File metadata

  • Download URL: webchanges-3.10.3.tar.gz
  • Upload date:
  • Size: 119.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for webchanges-3.10.3.tar.gz
Algorithm Hash digest
SHA256 f6f519500fb9cbac92c2863127987158852ec6e4bfd9494180f30c0f4932962e
MD5 405b8ac1f15a11c03b77afc55b3d23b2
BLAKE2b-256 1cdf6dbc97e1bce1d63ea9745de0cbf59164a1544d6d65f39f0b0d47a199c9dd

See more details on using hashes here.

File details

Details for the file webchanges-3.10.3-py3-none-any.whl.

File metadata

  • Download URL: webchanges-3.10.3-py3-none-any.whl
  • Upload date:
  • Size: 129.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.13

File hashes

Hashes for webchanges-3.10.3-py3-none-any.whl
Algorithm Hash digest
SHA256 d4ec06a50975d4900f96458a0afc8a526c59641bcd361e4abd1c352780467690
MD5 ee7fc3f11c70e0e5f814dbb3f3b18fb0
BLAKE2b-256 97790a25ebe10f74f753f2f2661c3c8d959d7b739daacdd6794103d764466470

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page