Metadata-Version: 2.4
Name: webchanges
Version: 3.31.1
Summary: Web Changes Delivered. AI-Summarized. Totally Anonymous.
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 :: System :: Monitoring
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.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Typing :: Typed
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: colorama; sys_platform == "win32"
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; sys_platform == "win32"
Requires-Dist: zstandard
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"
Dynamic: license-file

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

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

**webchanges** *anonymously* checks web content (including images) and commands for changes, delivering instant
notifications and AI-powered summaries to your favorite `platform
<https://webchanges.readthedocs.io/en/stable/introduction.html#reporters-list>`__.


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

For the best experience, use the current version of `Python <https://www.python.org/downloads/>`__. We also support
older Python versions for 3 years after they're replaced by a newer one; we just ask that you use the most up-to-date
bug and security fix release from that older version.

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
============
|pypi_version| |format| |status|

Install **webchanges**  with ``uv`` (recommended):

.. code-block:: bash

   uv pip install webchanges
   
or with ``pip``:

.. code-block:: bash

   pip install webchanges

Running in Docker
-----------------
**webchanges** can easily run in a `Docker <https://www.docker.com/>`__ container! You will find a minimal
implementation (no browser) `here <https://github.com/yubiuser/webchanges-docker>`__, and one with a browser
`here <https://github.com/jhedlund/webchanges-docker>`__.


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 last time the
program ran, just run:

.. code-block:: bash

   webchanges


Schedule
--------
**webchanges** leverages the power of a system scheduler:

- On Linux you can use cron, with the help of a tool like `crontab.guru <https://crontab.guru>`__ (help `here
  <https://www.computerhope.com/unix/ucrontab.htm>`__);
- On Windows you can use `Windows Task Scheduler <https://en.wikipedia.org/wiki/Windows_Task_Scheduler>`__;
- On macOS you can use `launchd <https://developer.apple
  .com/library/archive/documentation/MacOSX/Conceptual/BPSystemStartup/Chapters/ScheduledJobs.html>`__ (help `here
  <https://launchd.info/>`__).


Code
====
|coveralls| |snyk| |issues| |code_style|

The code, issues tracker, and discussions 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|

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


Compatibility **urlwatch**
===========================

This project is based on code from `urlwatch 2.21
<https://github.com/thp/urlwatch/tree/346b25914b0418342ffe2fb0529bed702fddc01f>`__ dated 30 July 2020.

For upgrading from **urlwatch** to **webchanges** (using the same job and
configuration files), see `here <https://webchanges.readthedocs.io/en/stable/upgrading.html>`__). 


.. |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://img.shields.io/pypi/dm/webchanges.svg
    :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
.. |old_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
.. |CI| image:: https://img.shields.io/github/check-runs/mborsetti/webchanges/main
    :target: https://github.com/mborsetti/webchanges/actions
    :alt: CI testing status
.. |old_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
.. |coveralls| image:: https://img.shields.io/coverallsCoverage/github/mborsetti/webchanges.svg
    :target: https://coveralls.io/github/mborsetti/webchanges?branch=main
    :alt: Code coverage by Coveralls
.. |code_style| image:: https://img.shields.io/badge/code%20style-ruff-000000.svg
    :target: https://github.com/astral-sh/ruff
    :alt: Code style ruff
.. |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-green.svg
..     :target: https://github.com/PyCQA/bandit
..     :alt: Security Status
.. |snyk| image:: https://snyk.io/advisor/python/holidays/badge.svg
    :target: https://snyk.io/advisor/python/holidays
    :alt: Snyk Package Health Score
