Metadata-Version: 2.1
Name: duplicate-url-discarder-rules
Version: 2024.11.5
Summary: The rules for duplicate-url-discarder.
Author-email: Zyte Group Ltd <info@zyte.com>
License: The MIT License (MIT)
        
        Copyright (c) 2024 Zyte Group Ltd
        
        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.
        
Project-URL: Source, https://github.com/zytedata/duplicate-url-discarder-rules
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
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 :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE

=============================
duplicate-url-discarder-rules
=============================

.. image:: https://img.shields.io/pypi/v/duplicate-url-discarder-rules.svg
   :target: https://pypi.python.org/pypi/duplicate-url-discarder-rules
   :alt: PyPI Version

.. image:: https://img.shields.io/pypi/pyversions/duplicate-url-discarder-rules.svg
   :target: https://pypi.python.org/pypi/duplicate-url-discarder-rules
   :alt: Supported Python Versions

.. image:: https://github.com/zytedata/duplicate-url-discarder-rules/workflows/tox/badge.svg
   :target: https://github.com/zytedata/duplicate-url-discarder-rules/actions
   :alt: Build Status:

This contains rules for https://github.com/zytedata/duplicate-url-discarder.

Quick Start
***********

Installation
============

.. code-block::

    pip install duplicate-url-discarder-rules

Using
=====

The rules can be imported via:

.. code-block:: python

    from duplicate_url_discarder_rules import RULE_PATHS

It can then be used to configure the ``DUD_LOAD_RULE_PATHS`` setting of
``duplicate-url-discarder``.

``RULE_PATHS`` contains all files shipped in this package. If you want to
reduce the number of loaded rules to improve performance you can instead
use one or more of the following variables:

* ``RULE_PATHS_COMMON``: rules not specific to any data type.
* ``RULE_PATHS_ARTICLE``: rules for article websites.
* ``RULE_PATHS_PRODUCT``: rules for e-commerce websites.

As all of them are lists, you can combine them (e.g.
``RULE_PATHS_COMMON + RULE_PATHS_PRODUCT``).
