webchanges 3.30.0__tar.gz → 3.31.1__tar.gz

{webchanges-3.30.0/webchanges.egg-info → webchanges-3.31.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: webchanges
-Version: 3.30.0
+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>
@@ -108,7 +108,7 @@ Requires-Dist: cssselect
 Requires-Dist: h2
 Requires-Dist: html2text
 Requires-Dist: httpx
-Requires-Dist: lxml>=5.3.0
+Requires-Dist: lxml
 Requires-Dist: markdown2
 Requires-Dist: msgpack
 Requires-Dist: platformdirs
@@ -196,9 +196,15 @@ For Generative AI summaries (BETA), you need a free `API Key from Google Cloud A
 
 Installation
 ============
-|pypi_version| |format| |status| |security|
+|pypi_version| |format| |status|
 
-Install **webchanges**  with:
+Install **webchanges**  with ``uv`` (recommended):
+
+.. code-block:: bash
+
+   uv pip install webchanges
+   
+or with ``pip``:
 
 .. code-block:: bash
 
@@ -261,7 +267,7 @@ Schedule
 
 Code
 ====
-|coveralls| |issues| |code_style|
+|coveralls| |snyk| |issues| |code_style|
 
 The code, issues tracker, and discussions are hosted on `GitHub <https://github.com/mborsetti/webchanges>`__.
 
@@ -287,55 +293,14 @@ licensed under a `BSD 3-Clause License
 <https://raw.githubusercontent.com/thp/urlwatch/346b25914b0418342ffe2fb0529bed702fddc01f/COPYING>`__).
 
 
-Compatibility with and improvements from **urlwatch**
-=====================================================
+Compatibility **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/upgrading.html>`__) and benefit from many
-improvements, including:
-
-* :underline:`AI-Powered Summaries`: Summary of changes in plain text using generative AI, useful for long documents
-  (e.g. legal);
-* :underline:`Image Change Detection`: Monitor changes to images and receive notifications with an image highlighting
-  the differences;
-* :underline:`Structured Data Monitoring`: Track changes in JSON or XML data on an element-by-element basis;
-* :underline:`Improved Documentation`: We've revamped the `documentation <https://webchanges.readthedocs.io/>`__ to make
-  implementation easier;
-* :underline:`Enhanced HTML Reports`: HTML reports are now much clearer and include:
-
-  * Clickable links!
-  * Retention of most original formatting (**bolding / headers**, *italics*, :underline:`underlining`, lists with
-    bullets (•), and indentation;
-  * :additions:`added` and :deletions:`deleted` lines clearly highlighted with color and strikethrough;
-  * Wrapping of long lines (instead of truncation);
-  * Improved compatibility with a wider range of HTML email clients, including those that override stylesheets (e.g.,
-    Gmail);
-  * General legibility improvements.
-
-* :underline:`New Filtering Options`: New filters, like `additions_only
-  <https://webchanges.readthedocs.io/en/stable/diff_filters.html#additions-only>`__, which allows you to focus on
-  added content without the distraction of deletions;
-* :underline:`New Command Line Arguments`: New command-line arguments such as ``--errors``, which helps you identify
-  jobs that are no longer functioning correctly;
-* :underline:`Increased Reliability and Stability`: Testing coverage has increased by approximately 30 percentage
-  points;
-* :underline:`Additional Enhancements`: Numerous other additions, refinements, and bug fixes have been implemented.
-  For more information, see `here <https://webchanges.readthedocs.io/en/stable/migration.html#upgrade-details>`__.
-
-Example enhancements to HTML reporting:
-
-.. 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
-
-
+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
@@ -371,12 +336,15 @@ Example enhancements to HTML reporting:
 .. |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-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code style black
+.. |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
+.. .. |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

{webchanges-3.30.0 → webchanges-3.31.1}/README.rst

@@ -29,9 +29,15 @@ For Generative AI summaries (BETA), you need a free `API Key from Google Cloud A
 
 Installation
 ============
-|pypi_version| |format| |status| |security|
+|pypi_version| |format| |status|
 
-Install **webchanges**  with:
+Install **webchanges**  with ``uv`` (recommended):
+
+.. code-block:: bash
+
+   uv pip install webchanges
+   
+or with ``pip``:
 
 .. code-block:: bash
 
@@ -94,7 +100,7 @@ Schedule
 
 Code
 ====
-|coveralls| |issues| |code_style|
+|coveralls| |snyk| |issues| |code_style|
 
 The code, issues tracker, and discussions are hosted on `GitHub <https://github.com/mborsetti/webchanges>`__.
 
@@ -120,55 +126,14 @@ licensed under a `BSD 3-Clause License
 <https://raw.githubusercontent.com/thp/urlwatch/346b25914b0418342ffe2fb0529bed702fddc01f/COPYING>`__).
 
 
-Compatibility with and improvements from **urlwatch**
-=====================================================
+Compatibility **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/upgrading.html>`__) and benefit from many
-improvements, including:
-
-* :underline:`AI-Powered Summaries`: Summary of changes in plain text using generative AI, useful for long documents
-  (e.g. legal);
-* :underline:`Image Change Detection`: Monitor changes to images and receive notifications with an image highlighting
-  the differences;
-* :underline:`Structured Data Monitoring`: Track changes in JSON or XML data on an element-by-element basis;
-* :underline:`Improved Documentation`: We've revamped the `documentation <https://webchanges.readthedocs.io/>`__ to make
-  implementation easier;
-* :underline:`Enhanced HTML Reports`: HTML reports are now much clearer and include:
-
-  * Clickable links!
-  * Retention of most original formatting (**bolding / headers**, *italics*, :underline:`underlining`, lists with
-    bullets (•), and indentation;
-  * :additions:`added` and :deletions:`deleted` lines clearly highlighted with color and strikethrough;
-  * Wrapping of long lines (instead of truncation);
-  * Improved compatibility with a wider range of HTML email clients, including those that override stylesheets (e.g.,
-    Gmail);
-  * General legibility improvements.
-
-* :underline:`New Filtering Options`: New filters, like `additions_only
-  <https://webchanges.readthedocs.io/en/stable/diff_filters.html#additions-only>`__, which allows you to focus on
-  added content without the distraction of deletions;
-* :underline:`New Command Line Arguments`: New command-line arguments such as ``--errors``, which helps you identify
-  jobs that are no longer functioning correctly;
-* :underline:`Increased Reliability and Stability`: Testing coverage has increased by approximately 30 percentage
-  points;
-* :underline:`Additional Enhancements`: Numerous other additions, refinements, and bug fixes have been implemented.
-  For more information, see `here <https://webchanges.readthedocs.io/en/stable/migration.html#upgrade-details>`__.
-
-Example enhancements to HTML reporting:
-
-.. 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
-
-
+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
@@ -204,12 +169,15 @@ Example enhancements to HTML reporting:
 .. |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-black-000000.svg
-    :target: https://github.com/psf/black
-    :alt: Code style black
+.. |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
+.. .. |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

{webchanges-3.30.0 → webchanges-3.31.1}/pyproject.toml

@@ -111,11 +111,102 @@ dependencies = {file = 'requirements.txt'}
 'webchanges' = ['py.typed']
 
 
+# -------------------------- bandit --------------------------
+[tool.bandit]
+# Find common security issues in Python code.
+# Runs as part of pre-commit.
+# Config file documentation at https://bandit.readthedocs.io/en/latest/config.html
+
+targets = ['webchanges', 'tests']
+skips = [
+    'B101',  # Use of assert detected.
+    'B404',  # Consider possible security implications associated with subprocess module.
+    'B602',  # subprocess call with shell=True identified, security issue.
+    'B603'   # subprocess call - check for execution of untrusted input.
+]
+
+
+# -------------------------- black --------------------------
+[tool.black]
+# Uncompromising code formatting
+# Runs as part of pre-commit
+# Config file documentation
+# https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
+
+# What's in here overrides the command-line options shown by running $ black --help.
+line-length = 120
+target-version = ['py310']
+skip-string-normalization = true
+extend-exclude = '/(\.idea|\.pytest_cache|\__pycache__|\venv.*|\webchanges.egg-info)/'
+color = true
+
+
+# -------------------------- coverage --------------------------
+[tool.coverage.run]
+# Runs in Github Actions (see .github/workflows/ci-cd.yaml) and in tox (see tox.ini).
+# Config file documentation at https://coverage.readthedocs.io/en/latest/config.html
+
+branch = true
+concurrency = ['multiprocessing']
+source = ['./']
+omit = [
+    '.*/*',
+    'build/*',
+    'dist/*',
+    'docs/*',
+    'htmlcov/*',
+    'pip/*',
+    'tests/*',
+    'webchanges/_vendored/*',
+    'webchanges.egg-info/*',
+]
+relative_files = true
+command_line = '-m pytest -vv'
+plugins = ['coverage_conditional_plugin']
+
+[tool.coverage.coverage_conditional_plugin.rules]
+# Requires pip install coverage-conditional-plugin
+# Here we specify our pragma rules:
+has-b4 = "is_installed('bs4')"
+has-jq = "is_installed('jq')"
+has-pdftotext = "is_installed('pdftotext')"
+has-pytesseract = "is_installed('pytesseract')"
+
+[tool.coverage.report]
+# Regexes for lines to exclude from consideration
+exclude_lines = [
+    # Don't complain about missing debug-only code:
+    'def __repr__',
+    'if self\.debug:',
+
+    # Have to re-enable the standard pragma
+    'pragma: no cover',
+
+    # Don't complain if tests don't hit defensive assertion code:
+    'raise AssertionError',
+    'raise NotImplementedError',
+
+    # Don't complain if non-runnable code isn't run:
+    'if 0:',
+    'if __name__ == .__main__.:',
+
+    # Don't complain if module is not importable (handled by code):
+    'except ImportError:',
+
+    # Don't cover IDE code:
+    'if TYPE_CHECKING:'
+]
+# Exclude entire files if they have a custom # pragma: exclude file remark
+# exclude_also = '(?s)\A.*# pragma: exclude file.*\Z'
+# ignore_errors = true
+
+
 # -------------------------- isort --------------------------
+[tool.isort]
 # isort your imports, so you don't have to.
 # Runs as part of pre-commit.
 # Config file documentation https://pycqa.github.io/isort/docs/configuration/options.html
-[tool.isort]
+
 profile = 'black'
 # multi_line_output = 3
 # use_parentheses = True
@@ -147,25 +238,11 @@ remove_redundant_aliases = true
 color_output = true
 
 
-# -------------------------- black --------------------------
-# Uncompromising code formatting
-# Runs as part of pre-commit
-# Config file documentation
-# https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#configuration-via-a-file
-[tool.black]
-# What's in here overrides the command-line options shown by running $ black --help.
-line_length = 120
-target_version = ['py310']
-skip_string_normalization = true
-extend_exclude = '/(\.idea|\.pytest_cache|\__pycache__|\venv.*|\webchanges.egg-info)/'
-color = true
-
-
 # -------------------------- mypy --------------------------
+[tool.mypy]
 # Static Typing for Python
 # Runs as part of pre-commit
 # Config file documentation at https://mypy.readthedocs.io/en/stable/config_file.html
-[tool.mypy]
 
 # Disables import discovery of namespace packages (see PEP 420)
 namespace_packages = false
@@ -216,106 +293,155 @@ warn_unused_configs = true
 
 
 # -------------------------- rstcheck --------------------------
+[tool.rstcheck]
 # Checks syntax of reStructuredText and code blocks nested within it.
 # Runs as part of pre-commit.
 # Config file documentation at https://rstcheck.readthedocs.io/en/latest/usage/config/
-[tool.rstcheck]
 
 report_level = 'WARNING'
 # The below is needed when comments in *.rst files turn it into invalid python code
 # ignore_language = 'python'
 
 
-# -------------------------- bandit --------------------------
-[tool.bandit]
-# Find common security issues in Python code.
-# Runs as part of pre-commit.
-# Config file documentation at https://bandit.readthedocs.io/en/latest/config.html
-
-targets = ['webchanges', 'tests']
-skips = [
-    'B101',  # Use of assert detected.
-    'B404',  # Consider possible security implications associated with subprocess module.
-    'B602',  # subprocess call with shell=True identified, security issue.
-    'B603'   # subprocess call - check for execution of untrusted input.
-]
-
-
-# -------------------------- coverage --------------------------
-# Runs in Github Actions (see .github/workflows/ci-cd.yaml) and in tox (see tox.ini).
-# Config file documentation at https://coverage.readthedocs.io/en/latest/config.html
-[tool.coverage.run]
-branch = true
-concurrency = ['multiprocessing']
-source = ['./']
-omit = [
-    '.*/*',
-    'build/*',
-    'dist/*',
-    'docs/*',
-    'htmlcov/*',
-    'pip/*',
-    'tests/*',
-    'webchanges/_vendored/*',
-    'webchanges.egg-info/*',
-]
-relative_files = true
-command_line = '-m pytest -vv'
-plugins = ['coverage_conditional_plugin']
-
-[tool.coverage.coverage_conditional_plugin.rules]
-# Requires pip install coverage-conditional-plugin
-# Here we specify our pragma rules:
-has-b4 = "is_installed('bs4')"
-has-jq = "is_installed('jq')"
-has-pdftotext = "is_installed('pdftotext')"
-has-pytesseract = "is_installed('pytesseract')"
-
-[tool.coverage.report]
-# Regexes for lines to exclude from consideration
-exclude_lines = [
-    # Don't complain about missing debug-only code:
-    'def __repr__',
-    'if self\.debug:',
-
-    # Have to re-enable the standard pragma
-    'pragma: no cover',
-
-    # Don't complain if tests don't hit defensive assertion code:
-    'raise AssertionError',
-    'raise NotImplementedError',
-
-    # Don't complain if non-runnable code isn't run:
-    'if 0:',
-    'if __name__ == .__main__.:',
-
-    # Don't complain if module is not importable (handled by code):
-    'except ImportError:',
-
-    # Don't cover IDE code:
-    'if TYPE_CHECKING:'
-]
-# Exclude entire files if they have a custom # pragma: exclude file remark
-# exclude_also = '(?s)\A.*# pragma: exclude file.*\Z'
-# ignore_errors = true
-
-
 # -------------------------- pytest --------------------------
+[tool.pytest.ini_options]
 # Testing framework
 # Config file documentation at https://docs.pytest.org/en/stable/reference/reference.html#ini-options-ref
-[tool.pytest.ini_options]
+
 log_auto_indent = true
 # Enable log display during test run (aka "live logging" https://docs.pytest.org/en/stable/logging.html#live-logs)
 log_cli = true
 minversion = '8.3.3'
 testpaths = ['tests']
 
-# the below is for pytest-asyncio (required due to Playwright)
-asyncio_mode = 'auto'
-asyncio_default_fixture_loop_scope = 'function'
+# the below is for pytest-asyncio (used to be required due to Playwright)
+# asyncio_mode = 'auto'
+# asyncio_default_fixture_loop_scope = 'function'
 
 # Adds pytest-cov functionality (see https://pytest-cov.readthedocs.io/en/latest/config.html)
 # Note: --cov moved to .github/workflows/ci-cd.yaml and tox.ini due to interference with PyCharm breakpoints (see
 # https://github.com/pytest-dev/pytest-cov/issues/131) and to enable running tox --parallel
 # Instead of below, now runs with $ coverage run --parallel-mode
 # addopts = --cov=./ --cov-report=term --cov-report=html
+
+
+# -------------------------- ruff --------------------------
+[tool.ruff]
+# Config file documentation at https://docs.astral.sh/ruff/configuration/
+
+# Exclude a variety of commonly ignored directories.
+exclude = [
+    ".bzr",
+    ".direnv",
+    ".eggs",
+    ".git",
+    ".git-rewrite",
+    ".hg",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pants.d",
+    ".pyenv",
+    ".pytest_cache",
+    ".pytype",
+    ".ruff_cache",
+    ".svn",
+    ".tox",
+    ".venv",
+    ".vscode",
+    "__pypackages__",
+    "_build",
+    "buck-out",
+    "build",
+    "dist",
+    "node_modules",
+    "site-packages",
+    "venv",
+
+    "webchanges/storage_minidb.py",
+    "webchanges/_vendored",
+]
+
+# By default, Ruff will discover files matching *.py, *.pyi, *.ipynb, or pyproject.toml.
+# Include additional files
+# include = []
+
+# Set the maximum line length.
+line-length = 120
+indent-width = 4
+
+# Target Python version
+# target-version = "py311"  # Commented out to infer from [project] requires-python
+
+[tool.ruff.lint]
+# By default, Ruff enables Flake8's F rules, along with a subset of the E rules
+# Enable rules not enabled by default, and ignore specific rules.
+select = [
+    # flake8-builtins
+    "B",
+    # flake8-bandit
+    "S",
+    # flake8-datetimez
+    "DTZ",
+    # isort
+    "I",
+    # McCabe complexity 
+    # "C901",
+    # pepe8-naming
+    "N",
+    # Pyflakes
+    "F",
+    # pycodestyle errors and warnings
+    "E", "W",
+    # Ruff-specific rules
+    "RUF",
+]
+ignore = [
+    "RUF012", # Mutable class attributes should be annotated with `typing.ClassVar`
+]
+
+# Allow fix for all enabled rules (when `--fix`) is provided.
+fixable = ["ALL"]
+unfixable = []
+
+# Allow unused variables when underscore-prefixed.
+dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
+
+[tool.ruff.format]
+# Enable the formatter, which is a drop-in replacement for Black.
+# No extra configuration is needed for basic formatting.
+
+# Exclude files for formatting only
+exclude = []
+
+# Use single quotes for strings.
+quote-style = "single"
+
+# Like Black, indent with spaces, rather than tabs.
+indent-style = "space"
+
+# Like Black, respect magic trailing commas.
+skip-magic-trailing-comma = false
+
+# Like Black, automatically detect the appropriate line ending.
+line-ending = "auto"
+
+# Enable auto-formatting of code examples in docstrings. Markdown,
+# reStructuredText code/literal blocks and doctests are all supported.
+#
+# This is currently disabled by default, but it is planned for this
+# to be opt-out in the future.
+docstring-code-format = true
+
+# Set the line length limit used when formatting code snippets in
+# docstrings.
+#
+# This only has an effect when the `docstring-code-format` setting is
+# enabled.
+docstring-code-line-length = "dynamic"
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = [
+    # Use of `assert` detected
+    "S101"
+]

webchanges-3.31.1/requirements.txt

@@ -0,0 +1,12 @@
+colorama; sys_platform == 'win32'
+cssselect
+h2
+html2text
+httpx
+lxml
+markdown2
+msgpack
+platformdirs
+pyyaml
+tzdata; sys_platform == 'win32'
+zstandard

{webchanges-3.30.0 → webchanges-3.31.1}/webchanges/__init__.py

@@ -15,18 +15,16 @@ from __future__ import annotations
 __min_python_version__ = (3, 10)  # minimum version of Python required to run; supported until fall 2025
 
 
-__project_name__ = __package__
+__project_name__ = str(__package__)
 # Version numbering is PEP440-compliant https://www.python.org/dev/peps/pep-0440/
 # Release numbering largely follows Semantic Versioning https://semver.org/spec/v2.0.0.html#semantic-versioning-200
 # * MAJOR version when you make incompatible API changes,
 # * MINOR version when you add functionality in a backwards compatible manner, and
 # * MICRO or PATCH version when you make backwards compatible bug fixes. We no longer use '0'
 # If unsure on increments, use pkg_resources.parse_version to parse
-__version__ = '3.30.0'
+__version__ = '3.31.1'
 __description__ = (
-    'Check web (or command output) for changes since last run and notify.\n'
-    '\n'
-    'Anonymously alerts you of web changes.'
+    'Check web (or command output) for changes since last run and notify.\n\nAnonymously alerts you of web changes.'
 )
 __author__ = 'Mike Borsetti <mike@borsetti.com>'
 __copyright__ = 'Copyright 2020- Mike Borsetti'