Metadata-Version: 2.4
Name: scrapy-lint
Version: 0.1.1
Summary: A linter for Scrapy projects
Project-URL: Source, https://github.com/scrapy/scrapy-lint
Project-URL: Tracker, https://github.com/scrapy/scrapy-lint/issues
Project-URL: Release notes, https://scrapy-lint.readthedocs.io/en/latest/changes.html
Author-email: Valdir Stumm Junior <stummjr@gmail.com>
Maintainer-email: Zyte Group Ltd <info@zyte.com>
License-Expression: MIT
License-File: LICENSE
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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 :: 3.14
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Quality Assurance
Requires-Python: >=3.10
Requires-Dist: packaging>=22
Requires-Dist: pathspec>=0.10.1
Requires-Dist: ruamel-yaml>=0.17.5
Requires-Dist: tomli>=1.0.0; python_version < '3.11'
Description-Content-Type: text/x-rst

===========
scrapy-lint
===========

|version| |python_version| |ci| |codecov|

.. |version| image:: https://img.shields.io/pypi/v/scrapy-lint.svg
   :target: https://pypi.org/pypi/scrapy-lint
   :alt: PyPI version

.. |python_version| image:: https://img.shields.io/pypi/pyversions/scrapy-lint.svg
   :target: https://pypi.org/pypi/scrapy-lint
   :alt: Supported Python versions

.. |ci| image:: https://github.com/scrapy/scrapy-lint/workflows/CI/badge.svg
   :target: https://github.com/scrapy/scrapy-lint/actions?query=workflow%3ACI
   :alt: CI

.. |codecov| image:: https://codecov.io/gh/scrapy/scrapy-lint/branch/master/graph/badge.svg
    :target: https://codecov.io/gh/scrapy/scrapy-lint
    :alt: Coverage

.. readme-start

**scrapy-lint** is a linter for `Scrapy <https://scrapy.org/>`_ projects.

To install::

    pip install scrapy-lint

To run::

    scrapy-lint

To use with `pre-commit <https://pre-commit.com/>`__, add the following to your
``.pre-commit-config.yaml``:

.. code-block:: yaml

    - repo: https://github.com/scrapy/scrapy-lint
      rev: v0.1.1
      hooks:
      - id: scrapy-lint

Can be combined with `ruff <https://docs.astral.sh/ruff/>`_,
`mypy <https://mypy.readthedocs.io/en/stable/>`_,
`pylint <https://pylint.readthedocs.io/en/stable/>`_ and
`flake8-requirements <https://pypi.org/project/flake8-requirements/>`_.

.. readme-end

Documentation
=============

See the documentation_ for more.

.. _documentation: https://scrapy-lint.readthedocs.io/en/latest/
