Skip to main content

Check web (or commands) for changes and notify

Project description

webchanges checks web content (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 by its author to optimize it for HTML.

Installation

webchanges pypi version is available on PyPI for supported Python version (Python versions are supported for 3 years after being obsoleted by a new major release) 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 Read the documentation at https://webchanges.readthedocs.io/.

Code

issues CI testing status code coverage by Codecov code coverage by Coveralls

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

webchanges will check for changes every time you run it, but does not include a scheduler. We recommend using a system scheduler to automatically run webchanges periodically:

  • In Linux, you can use cron; crontab.guru will build a schedule expression for you. If you have never used cron before, see here.

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

Contributing

We welcome any contribution, e.g. documentation, bug reports, new features, etc., as both pull requests and issues. More information for developers and documenters is here, and our wishlist is here.

License

license

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

Improvements from urlwatch

This fork is optimized for HTML:

  • Links are clickable!

  • Formatting such as bolding / headers, italics, underlining, list bullets (•) and indentation is preserved

  • Added and deleted lines are highlighted with color and strikethrough

  • Long lines wrap around

  • HTML is rendered correctly by email clients such as Gmail who override stylesheets

  • Other legibility improvements

It also has a new additions_only filter that makes it easier to track content that was added without the distractions of the content that was deleted (and a similar deletions_only one) as well as many other refinements (see changelog).

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

webchanges-3.2.4-py3-none-any.whl (58.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: webchanges-3.2.4-py3-none-any.whl
  • Upload date:
  • Size: 58.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/53.0.0 requests-toolbelt/0.9.1 tqdm/4.59.0 CPython/3.9.2

File hashes

Hashes for webchanges-3.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 6e7a7784d17e5d30e4a43915802e383b479bbf7d7157fcece3beb37fcb2f4863
MD5 ea54863fa3c9291e05523150f2aa4f7b
BLAKE2b-256 b2954f6579bcad0034a61a4eefe55ee035b03fc1b7ac1b48031d8bd8ee7e9f7c

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