Metadata-Version: 2.1
Name: webchanges
Version: 3.22
Summary: Check web (or command output) for changes since last run and notify. Anonymously alerts you of web changes, with
Author-email: Mike Borsetti <mike+webchanges@borsetti.com>
Maintainer-email: Mike Borsetti <mike+webchanges@borsetti.com>
License: ========
        Licenses
        ========
        
        The MIT License (MIT)
        
        Copyright (c) 2020- Mike Borsetti <mike@borsetti.com>
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the "Software"), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
        the Software, and to permit persons to whom the Software is furnished to do so,
        subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
        FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
        COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
        IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
        CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
        
        --------------------------------------------------------------------------------
        
        SOURCE CODE REDISTRIBUTION NOTICE
        (urlwatch by Thomas Perl)
        
        This software redistributes source code of release 2.21 dated 30 July 2020 of
        urlwatch
        https://github.com/thp/urlwatch/tree/346b25914b0418342ffe2fb0529bed702fddc01f,
        which is subject to the following copyright notice and license (from
        https://raw.githubusercontent.com/thp/urlwatch/346b25914b0418342ffe2fb0529bed702fddc01f/COPYING),
        hereby retained and redistributed with the source code (of which this license
        file is part of), in binary form, and in the documentation. The appearance of
        the name of the author below does not constitute an endorsement or promotion of
        this software by such author.
        
        Copyright (c) 2008-2020 Thomas Perl <m@thp.io>
        All rights reserved.
        
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions
        are met:
        
        1. Redistributions of source code must retain the above copyright
           notice, this list of conditions and the following disclaimer.
        2. Redistributions in binary form must reproduce the above copyright
           notice, this list of conditions and the following disclaimer in the
           documentation and/or other materials provided with the distribution.
        3. The name of the author may not be used to endorse or promote products
           derived from this software without specific prior written permission.
        
        THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR
        IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
        OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
        IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
        INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
        NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
        DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
        THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
        (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
        THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
        
Project-URL: Documentation, https://webchanges.readthedocs.io/
Project-URL: Repository, https://github.com/mborsetti/webchanges/
Project-URL: Changelog, https://webchanges.readthedocs.io/en/stable/changelog.html
Project-URL: Issues, https://github.com/mborsetti/webchanges/issues
Project-URL: CI, https://github.com/mborsetti/webchanges/actions
Keywords: webmonitoring,monitoring
Classifier: Environment :: Console
Classifier: Topic :: Internet
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Indexing/Search
Classifier: Topic :: Utilities
Classifier: Development Status :: 5 - Production/Stable
Classifier: License :: OSI Approved :: MIT License
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: OS Independent
Classifier: Natural Language :: English
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Developers
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: colorama; os_name == "nt"
Requires-Dist: cssselect
Requires-Dist: h2
Requires-Dist: html2text
Requires-Dist: httpx
Requires-Dist: lxml
Requires-Dist: markdown2
Requires-Dist: msgpack
Requires-Dist: platformdirs
Requires-Dist: pyyaml
Requires-Dist: tzdata; os_name == "nt"
Provides-Extra: use-browser
Requires-Dist: playwright; extra == "use-browser"
Requires-Dist: psutil; extra == "use-browser"
Provides-Extra: beautify
Requires-Dist: beautifulsoup4; extra == "beautify"
Requires-Dist: jsbeautifier; extra == "beautify"
Requires-Dist: cssbeautifier; extra == "beautify"
Provides-Extra: bs4
Requires-Dist: beautifulsoup4; extra == "bs4"
Provides-Extra: html5lib
Requires-Dist: html5lib; extra == "html5lib"
Provides-Extra: ical2text
Requires-Dist: vobject; extra == "ical2text"
Provides-Extra: jq
Requires-Dist: jq; os_name != "nt" and extra == "jq"
Provides-Extra: ocr
Requires-Dist: pytesseract; extra == "ocr"
Requires-Dist: Pillow; extra == "ocr"
Provides-Extra: pdf2text
Requires-Dist: pdftotext; extra == "pdf2text"
Provides-Extra: pypdf
Requires-Dist: pypdf; extra == "pypdf"
Provides-Extra: pypdf-crypto
Requires-Dist: pypdf; extra == "pypdf-crypto"
Requires-Dist: cryptography; extra == "pypdf-crypto"
Provides-Extra: deepdiff
Requires-Dist: deepdiff; extra == "deepdiff"
Provides-Extra: deepdiff-xml
Requires-Dist: deepdiff; extra == "deepdiff-xml"
Requires-Dist: xmltodict; extra == "deepdiff-xml"
Provides-Extra: imagediff
Requires-Dist: Pillow; extra == "imagediff"
Provides-Extra: matrix
Requires-Dist: matrix_client; extra == "matrix"
Provides-Extra: pushbullet
Requires-Dist: pushbullet.py; extra == "pushbullet"
Provides-Extra: pushover
Requires-Dist: chump; extra == "pushover"
Provides-Extra: xmpp
Requires-Dist: aioxmpp; extra == "xmpp"
Provides-Extra: redis
Requires-Dist: redis; extra == "redis"
Provides-Extra: requests
Requires-Dist: requests; extra == "requests"
Provides-Extra: safe-password
Requires-Dist: keyring; extra == "safe-password"
Provides-Extra: all
Requires-Dist: webchanges[beautify,bs4,deepdiff_xml,html5lib,ical2text,imagediff,jq,matrix,ocr,pdf2text,pushbullet,pushover,pypdf_crypto,redis,requests,safe_password,use_browser,xmpp]; extra == "all"

.. role:: underline
    :class: underline
.. role:: additions
    :class: additions
.. role:: deletions
    :class: deletions

======================
webchanges |downloads|
======================

**webchanges** checks web content including images, and notifies you via email (or one of many other `supported
services <https://webchanges.readthedocs.io/en/stable/introduction.html#reporters-list>`__) if a change is detected.
**webchanges** can also check the output of local commands. The notification includes a detail of what has changed
("diff"), with an optional summary generated by AI (BETA).

**webchanges** *anonymously* alerts you of web changes.



Requirements
============
**webchanges** requires |support|.

You should use the latest version of `Python <https://www.python.org/downloads/>`__ 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.

For Generative AI summaries (BETA), you need a free `API Key from Google Cloud AI Studio
<https://aistudio.google.com/app/apikey>`__ (see `here
<https://webchanges.readthedocs.io/en/stable/differs.html#ai-google>`__).


Installation
============
Install **webchanges** |pypi_version| |format| |status| |security| with:

.. code-block:: bash

   pip install webchanges


Running in Docker
=================
**webchanges** can be run in a `Docker <https://www.docker.com/>`__ container. Please see `here
<https://github.com/yubiuser/webchanges-docker>`__ for one such implementation.


Documentation |readthedocs|
===========================
The documentation is hosted on `Read the Docs <https://webchanges.readthedocs.io/>`__.


Quick Start
============
Initialize
----------

#. Run the following command to create the default ``config.yaml`` (configuration) and ``jobs.yaml`` (jobs) files and
   open an editor to add your `jobs <https://webchanges.readthedocs.io/en/stable/jobs.html>`__:

   .. code-block:: bash

      webchanges --edit


#. Run the following command to change the default `configuration
   <https://webchanges.readthedocs.io/en/stable/configuration.html>`__, e.g. to receive change notifications
   ("`reports <https://webchanges.readthedocs.io/en/stable/reporters.html>`__")
   by `email <https://webchanges.readthedocs.io/en/stable/reporters.html#smtp>`__ and/or one of many other methods:

   .. code-block:: bash

      webchanges --edit-config


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

.. code-block:: bash

   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 <https://www.computerhope.com/unix/ucrontab.htm>`__); `crontab.guru <https://crontab.guru>`__ will build a
  schedule expression for you.
- On macOS, you can use `launchd <https://developer.apple
  .com/library/archive/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/ScheduledJobs.html>`__
- On Windows, you can use the built-in `Windows Task Scheduler
  <https://en.wikipedia.org/wiki/Windows_Task_Scheduler>`__.


Code
====
|coveralls| |issues|

The code and issues tracker are hosted on `GitHub <https://github.com/mborsetti/webchanges>`__.


Contributing
============
We welcome any contribution no matter how small, both as pull requests or `issue reports
<https://github.com/mborsetti/webchanges/issues>`__.

More information for code and documentation contributors is `here
<https://webchanges.readthedocs.io/en/stable/contributing.html>`__, and our wishlist is `here
<https://github.com/mborsetti/webchanges/blob/main/WISHLIST.md>`__.


License
=======
|license|

Released under the `MIT License <https://opensource.org/licenses/MIT>`__ but redistributing modified source code from
`urlwatch 2.21 <https://github.com/thp/urlwatch/tree/346b25914b0418342ffe2fb0529bed702fddc01f>`__ dated 30 July 2020
licensed under a `BSD 3-Clause License
<https://raw.githubusercontent.com/thp/urlwatch/346b25914b0418342ffe2fb0529bed702fddc01f/COPYING>`__. See the complete
license `here <https://github.com/mborsetti/webchanges/blob/main/LICENSE>`__.


Compatibility with and improvements from **urlwatch**
=====================================================

This project is based on code from `urlwatch 2.21
<https://github.com/thp/urlwatch/tree/346b25914b0418342ffe2fb0529bed702fddc01f>`__ dated 30 July 2020. You can
easily upgrade to **webchanges** from the current version of **urlwatch** using the same job and configuration files
(see `here <https://webchanges.readthedocs.io/en/stable/migration.html>`__) and benefit from many improvements,
including:

* Summary of changes in plain text using Generative AI, useful for long, boring, legal documents;
* Depicting changes to an image;
* Element-by-element changes of JSON or XML data;
* Much better `documentation <https://webchanges.readthedocs.io/>`__;
* Many improvements to HTML reports, including:

  * Links that are `clickable <https://pypi.org/project/webchanges/>`__!
  * Retaining of original formatting such as **bolding / headers**, *italics*, :underline:`underlining`, list bullets
    (•) and indentation;
  * :additions:`Added` and :deletions:`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 <https://webchanges.readthedocs.io/en/stable/diff_filters.html#additions-only>`__,
  which makes it easier to track content that was added without the distractions of the content that was deleted;
* New command line arguments such as ``--errors`` to catch jobs that no longer work;
* More reliability and stability, including a ~30 percentage point increase in testing coverage;
* Many other additions, refinements and fixes (see `detailed information
  <https://webchanges.readthedocs.io/en/stable/migration.html#upgrade-details>`__).

Examples:

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

|

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




.. |support| image:: https://img.shields.io/pypi/pyversions/webchanges.svg
    :target: https://www.python.org/downloads/
    :alt: Supported Python versions
.. |pypi_version| image:: https://img.shields.io/pypi/v/webchanges.svg?label=
    :target: https://pypi.org/project/webchanges/
    :alt: PyPI version
.. |format| image:: https://img.shields.io/pypi/format/webchanges.svg
    :target: https://pypi.org/project/webchanges/
    :alt: Kit format
.. |downloads| image:: https://static.pepy.tech/badge/webchanges
    :target: https://www.pepy.tech/project/webchanges
    :alt: PyPI downloads
.. |license| image:: https://img.shields.io/pypi/l/webchanges.svg
    :target: https://pypi.org/project/webchanges/
    :alt: License at https://pypi.org/project/webchanges/
.. |issues| image:: https://img.shields.io/github/issues-raw/mborsetti/webchanges
    :target: https://github.com/mborsetti/webchanges/issues
    :alt: Issues at https://github.com/mborsetti/webchanges/issues
.. |readthedocs| image:: https://img.shields.io/readthedocs/webchanges/stable.svg?label=
    :target: https://webchanges.readthedocs.io/
    :alt: Documentation status
.. |CI| image:: https://github.com/mborsetti/webchanges/actions/workflows/ci-cd.yaml/badge.svg?event=push
    :target: https://github.com/mborsetti/webchanges/actions
    :alt: CI testing status
.. |coveralls| image:: https://coveralls.io/repos/github/mborsetti/webchanges/badge.svg?branch=main
    :target: https://coveralls.io/github/mborsetti/webchanges?branch=main
    :alt: Code coverage by Coveralls
.. |status| image:: https://img.shields.io/pypi/status/webchanges.svg
    :target: https://pypi.org/project/webchanges/
    :alt: Package stability
.. |security| image:: https://img.shields.io/badge/security-bandit-yellow.svg
    :target: https://github.com/PyCQA/bandit
    :alt: Security Status
