Check web (or commands) for changes since last run 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.
webchanges enables anonymous notifications.
Requirements
You should use the latest version of Python if possible. If you’re using an older version, be aware that for each minor version (3.x), only the latest bugfix release (3.x.y) is officially supported. Older Python versions are supported for 3 years after being obsoleted by a new major release.
Installation
pip install webchanges
Documentation
The documentation is hosted on Read the Docs .
Quick Start
Initialize
Create the default config.yaml configuration and an empty jobs.yaml jobs files, opening an editor to add your jobs to the latter:
webchanges --edit
If you want to change the default configuration, e.g. to receive notifications (reports) by e-mail and/or one of many other methods, run:
webchanges --edit-config
Run
webchanges
This checks the sources in your jobs, and will report on (e.g. display) any changes from the previous run.
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; 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.
Code
The code and issues tracker are hosted on GitHub.
Contributing
We welcome any contribution, e.g. documentation, bug reports, new features, etc., as both pull requests and issues. More information for developers and documentation editors is here, and our wishlist is here.
License
Released under the MIT License, but including code licensed under the BSD 3-Clause License. See the license here.
Improvements from urlwatch
You can seamlessly upgrade from urlwatch 2.23 (see here) and benefit from many HTML-focused improvements including:
Links are clickable!
Formatting such as bolding / headers, italics, underlining, list bullets (•) and indentation is preserved
Uses color and strikethrough to highlight added and deleted lines, and long lines wrap around
HTML is rendered correctly by email clients who override stylesheets (e.g. Gmail)
Other legibility improvements
Multiple changes to how Pyppeteer is run (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
Better documentation
More reliability and stability, including a 33 percentage point increase in testing coverage
Many other additions, refinements and fixes (see detailed information)
Examples:
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file webchanges-3.6.0-py3-none-any.whl
.
File metadata
- Download URL: webchanges-3.6.0-py3-none-any.whl
- Upload date:
- Size: 70.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.9.5
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8d822f80a4d719835137e68d19b9d0a21298a95a89b0fe5026a1ebc71609efb4 |
|
MD5 | e59ee1c87e8ca2937900ec82dc85bdf5 |
|
BLAKE2b-256 | 33b7a1c15f40262614669b416323bc3ee0714aa1cc868871a5266f383dd29e9c |