Skip to main content

Check web (or command output) for changes since last run and notify. Anonymously alerts you of web 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 web 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 Security Status with:

pip install webchanges

Running in Docker

webchanges can be run in a Docker container. Please see https://github.com/yubiuser/webchanges-docker for one such implementation.

Documentation Documentation status

The documentation is hosted on Read the Docs.

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 code from urlwatch 2.21. You can easily upgrade from the current version of urlwatch (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;

  • 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;

  • New features such as --errors to catch jobs that no longer work;

  • Much better documentation;

  • More reliability and stability, including a 30+ percentage point increase in testing coverage;

  • 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.19.tar.gz (119.5 kB view details)

Uploaded Source

Built Distribution

webchanges-3.19-py3-none-any.whl (122.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: webchanges-3.19.tar.gz
  • Upload date:
  • Size: 119.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for webchanges-3.19.tar.gz
Algorithm Hash digest
SHA256 848b0f5834392af95c8523b623b075bc470f5123a1e3ed3b9a947ed611593f62
MD5 b301ccd5df33a0d96d6ea9340c278172
BLAKE2b-256 0f06d25d10298324e881644c90f38777a75908a29b67c1d36ca2c10901760713

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: webchanges-3.19-py3-none-any.whl
  • Upload date:
  • Size: 122.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.8

File hashes

Hashes for webchanges-3.19-py3-none-any.whl
Algorithm Hash digest
SHA256 b0f57bd4e3c9aefff65980ed2b2b95e363cb04837e4dd50096b0ef7e53a1e609
MD5 5f4c92b03d375aa4c652515b1c487663
BLAKE2b-256 a9a0c37b983bae24b2045c4fa21b7b13273b0419fde6a7907c2627f5d5a62103

See more details on using hashes here.

Provenance

Supported by

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