prospector 1.10.0__py3-none-any.whl → 1.13.2__py3-none-any.whl

prospector/tools/vulture/__init__.py

@@ -1,19 +1,27 @@
+from collections.abc import Iterable
+from pathlib import Path
+from typing import TYPE_CHECKING, Any, Optional
+
 from vulture import Vulture
 
 from prospector.encoding import CouldNotHandleEncoding, read_py_file
+from prospector.finder import FileFinder
 from prospector.message import Location, Message, make_tool_error_message
 from prospector.tools.base import ToolBase
 
+if TYPE_CHECKING:
+    from prospector.config import ProspectorConfig
+
 
 class ProspectorVulture(Vulture):
-    def __init__(self, found_files):
+    def __init__(self, found_files: FileFinder) -> None:
         Vulture.__init__(self, verbose=False)
         self._files = found_files
-        self._internal_messages = []
-        self.file = None
-        self.filename = None
+        self._internal_messages: list[Message] = []
+        self.file: Optional[Path] = None
+        self.filename: Optional[Path] = None
 
-    def scavenge(self, _=None, __=None):
+    def scavenge(self, _: Any = None, __: Any = None) -> None:
         # The argument is a list of paths, but we don't care
         # about that as we use the found_files object. The
         # argument is here to explicitly acknowledge that we
@@ -27,7 +35,9 @@ class ProspectorVulture(Vulture):
                         module,
                         "vulture",
                         "V000",
-                        message=f"Could not handle the encoding of this file: {err.encoding}",
+                        message=(
+                            f"Could not handle the encoding of this file: {err.encoding}"  # type: ignore[attr-defined]
+                        ),
                     )
                 )
                 continue
@@ -38,7 +48,7 @@ class ProspectorVulture(Vulture):
             except TypeError:
                 self.scan(module_string)
 
-    def get_messages(self):
+    def get_messages(self) -> list[Message]:
         all_items = (
             ("unused-function", "Unused function %s", self.unused_funcs),
             ("unused-property", "Unused property %s", self.unused_props),
@@ -53,10 +63,7 @@ class ProspectorVulture(Vulture):
                     filename = item.file
                 except AttributeError:
                     filename = item.filename
-                if hasattr(item, "lineno"):
-                    lineno = item.lineno  # for older versions of vulture
-                else:
-                    lineno = item.first_lineno
+                lineno = item.lineno if hasattr(item, "lineno") else item.first_lineno
                 loc = Location(filename, None, None, lineno, -1)
                 message_text = template % item
                 message = Message("vulture", code, loc, message_text)
@@ -66,15 +73,18 @@ class ProspectorVulture(Vulture):
 
 
 class VultureTool(ToolBase):
-    def __init__(self):
+    def __init__(self) -> None:
         ToolBase.__init__(self)
         self._vulture = None
-        self.ignore_codes = ()
+        self.ignore_codes: list[str] = []
 
-    def configure(self, prospector_config, found_files):
+    def configure(  # pylint: disable=useless-return
+        self, prospector_config: "ProspectorConfig", found_files: FileFinder
+    ) -> Optional[tuple[Optional[str], Optional[Iterable[Message]]]]:
         self.ignore_codes = prospector_config.get_disabled_messages("vulture")
+        return None
 
-    def run(self, found_files):
+    def run(self, found_files: FileFinder) -> list[Message]:
         vulture = ProspectorVulture(found_files)
         vulture.scavenge()
         return [message for message in vulture.get_messages() if message.code not in self.ignore_codes]

{prospector-1.10.0.dist-info → prospector-1.13.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: prospector
-Version: 1.10.0
+Version: 1.13.2
 Summary: Prospector is a tool to analyse Python code by aggregating the result of other tools.
 Home-page: http://prospector.readthedocs.io
 License: GPLv2+
@@ -9,7 +9,7 @@ Author: Carl Crowder
 Author-email: git@carlcrowder.com
 Maintainer: Carl Crowder
 Maintainer-email: git@carlcrowder.com
-Requires-Python: >=3.7.2,<4.0
+Requires-Python: >=3.9,<4.0
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -17,13 +17,12 @@ Classifier: License :: OSI Approved :: GNU General Public License v2 or later (G
 Classifier: License :: Other/Proprietary License
 Classifier: Operating System :: Unix
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.7
-Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Topic :: Software Development :: Quality Assurance
 Provides-Extra: with_bandit
@@ -31,27 +30,27 @@ Provides-Extra: with_everything
 Provides-Extra: with_mypy
 Provides-Extra: with_pyright
 Provides-Extra: with_pyroma
+Provides-Extra: with_ruff
 Provides-Extra: with_vulture
 Requires-Dist: GitPython (>=3.1.27,<4.0.0)
 Requires-Dist: PyYAML
 Requires-Dist: bandit (>=1.5.1); extra == "with_bandit" or extra == "with_everything"
 Requires-Dist: dodgy (>=0.2.1,<0.3.0)
-Requires-Dist: flake8 (<6.0.0)
 Requires-Dist: mccabe (>=0.7.0,<0.8.0)
 Requires-Dist: mypy (>=0.600); extra == "with_mypy" or extra == "with_everything"
 Requires-Dist: packaging
 Requires-Dist: pep8-naming (>=0.3.3,<=0.10.0)
 Requires-Dist: pycodestyle (>=2.9.0)
 Requires-Dist: pydocstyle (>=2.0.0)
-Requires-Dist: pyflakes (>=2.2.0,<3)
-Requires-Dist: pylint (>=2.8.3)
+Requires-Dist: pyflakes (>=2.2.0)
+Requires-Dist: pylint (>=3.0)
 Requires-Dist: pylint-celery (==0.3)
-Requires-Dist: pylint-django (>=2.5,<2.6)
+Requires-Dist: pylint-django (>=2.6.1)
 Requires-Dist: pylint-flask (==0.6)
-Requires-Dist: pylint-plugin-utils (>=0.7,<0.8)
 Requires-Dist: pyright (>=1.1.3); extra == "with_pyright" or extra == "with_everything"
 Requires-Dist: pyroma (>=2.4); extra == "with_pyroma" or extra == "with_everything"
-Requires-Dist: requirements-detector (>=1.2.0)
+Requires-Dist: requirements-detector (>=1.3.2)
+Requires-Dist: ruff; extra == "with_ruff" or extra == "with_everything"
 Requires-Dist: setoptconf-tmp (>=0.3.1,<0.4.0)
 Requires-Dist: toml (>=0.10.2,<0.11.0)
 Requires-Dist: vulture (>=1.5); extra == "with_vulture" or extra == "with_everything"
@@ -208,7 +207,7 @@ text to your repositories' ``.pre-commit-config.yaml``::
 
     repos:
     -   repo: https://github.com/PyCQA/prospector
-        rev: 1.7.5 # The version of Prospector to use, if not 'master' for latest
+        rev: 1.10.0 # The version of Prospector to use, if not 'master' for latest
         hooks:
         -   id: prospector
 
@@ -217,7 +216,7 @@ them to the hook configuration like so::
 
     repos:
     -   repo: https://github.com/PyCQA/prospector
-        rev: 1.7.5
+        rev: 1.10.0
         hooks:
         -   id: prospector
             additional_dependencies:
@@ -249,7 +248,7 @@ added as command line arguments to the hook. For example::
 
     repos:
     -   repo: https://github.com/PyCQA/prospector
-        rev: 1.7.5
+        rev: 1.10.0
         hooks:
         -   id: prospector
             additional_dependencies:

prospector-1.13.2.dist-info/RECORD

@@ -0,0 +1,71 @@
+prospector/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+prospector/__main__.py,sha256=-gdHYZxwq_P8er7HuZEBImY0pwaFq8uIa78dQdJsTTQ,71
+prospector/autodetect.py,sha256=Ok8S6jpDiGyhQlnRCMWpsLpSAIXWxA-NQphQuPaOm6o,3112
+prospector/blender.py,sha256=ldQSkfoEKv6pd72B9YCYdapeGUzgfhGzieAu7To3l6Y,4926
+prospector/blender_combinations.yaml,sha256=yN7BOUCDomDZVRZzYxsRdxQPLpzxm9TDhv18B_GdLPU,6551
+prospector/compat.py,sha256=p_2BOebzUcKbUAd7mW8rn6tIc10R96gJuZS71QI0XY4,360
+prospector/config/__init__.py,sha256=4nYshBncKUvZrwNKmp2bQ2mQ8uRS7GU20xPbiC-nJ9g,14793
+prospector/config/configuration.py,sha256=sNYR5Jc3P7tfIDXQoDMrOX4i2Yde0o9bc21ZXZNn6rw,14046
+prospector/config/datatype.py,sha256=u2i3YxtFKXkeGKzrYnc8koI-Xq-Owl74e_XveNhFY8Y,658
+prospector/encoding.py,sha256=67sbqzcUoQqi3PRm_P3GNGwcL1N56RZ3T_YHmSrICEE,1549
+prospector/exceptions.py,sha256=3P58RNF7j1n4CUIZ8VM5BVhB4Q6UtVs-dQRG8TRCZ7o,1248
+prospector/finder.py,sha256=-gqGVEv6c6FEyKWZIcQ7FquSlVKvpVWsJK9-HkTeg3c,4778
+prospector/formatters/__init__.py,sha256=ixMDeM27mmaLBxHmcRYoC1tPPi17SBXS91Rc2dMv30s,467
+prospector/formatters/base.py,sha256=SMRvrX1xAQ1aaM8S-wPSH7cbs-x8QEXmLW0PeSf6PIg,1436
+prospector/formatters/base_summary.py,sha256=C2O6XAU4l-rOHL1q4rA56jO9sU7Sf0sHRvqgiY6PQgw,1410
+prospector/formatters/emacs.py,sha256=FwMqdDxCKA51B76ORuSJE1E2xy-glNpORIzAQaw7LUM,807
+prospector/formatters/grouped.py,sha256=-vD8I3unoO0FBISoUPHZPCa0p-btWMvt1D_UxzmcGDA,1357
+prospector/formatters/json.py,sha256=_DbZ_Eb0fmZf6qZMXCU__QRXv_awkBisZ-jvGfOr4aw,1000
+prospector/formatters/pylint.py,sha256=WAdD9tMYkk4BWfhoqJJBRc2d3xxQ0bJdQXOZU0ZzYTE,2871
+prospector/formatters/text.py,sha256=5czha8YfdJ9SD6vWLHE85LgB3-d0lHOsxpYhtokRmTU,1611
+prospector/formatters/vscode.py,sha256=ffP-JmrgZhhdirTj1ldV5fG10hdDiHjRfekSqQpQmx0,1643
+prospector/formatters/xunit.py,sha256=e5ObAWSLm-ekvWs8xsi-OaIL2yoYedlxuJdUhLZ8gkk,2464
+prospector/formatters/yaml.py,sha256=0RAL5BaaL9A0DfWZ-bdpK1mwgr8zJ_ULVwlnSXVPlDU,684
+prospector/message.py,sha256=ty_e5T7fpZcZb69sAUIgvV-9qHuAx6-Nkq3bP6IVAqw,3279
+prospector/pathutils.py,sha256=CyZIj4WXGill8OfnqRvcVqZYX0lzL3QcIxpkxCz-dkE,1219
+prospector/postfilter.py,sha256=rJ37Zb-dqzKSwpzgpePZR-AIEgRdOTc2C5LbxGNDVm0,2225
+prospector/profiles/__init__.py,sha256=q9zPLVEwo7qoouYFrmENsmByFrKKkr27Dd_Wo9btTJI,683
+prospector/profiles/exceptions.py,sha256=MDky4KXVwfOlW1yCbyp8Y07D8Kfz76jL3z-8T3WQIFI,1062
+prospector/profiles/profile.py,sha256=U8vDdyfka0_Ht9cYT2i_c-xbMcktSpS1h53cU7tGerk,17828
+prospector/profiles/profiles/default.yaml,sha256=tMy-G49ZdV7gkfBoN2ngtIWha3n7JVr_rEeNkLzpKsk,100
+prospector/profiles/profiles/doc_warnings.yaml,sha256=K_cBhUeKnSvOCwgwXE2tMZ-Fr5cJovC1XSholWglzN4,48
+prospector/profiles/profiles/flake8.yaml,sha256=wC-TJYuVobo9zPm4Yc_Ocd4Wwfemx0IufmAnfiuKkHk,156
+prospector/profiles/profiles/full_pep8.yaml,sha256=Y01UuDKsk-3akQGIM05aDjGM99x91CXOTeLcYPed3po,873
+prospector/profiles/profiles/member_warnings.yaml,sha256=RpDCUcg6Nki77T5Ov2s1QlalOLX8soPtp_8CK20xbic,82
+prospector/profiles/profiles/no_doc_warnings.yaml,sha256=6Q_g5xNKJlEhM6PvtE1Wb6Jlq_gq_HKkIGfgqXTozqc,271
+prospector/profiles/profiles/no_member_warnings.yaml,sha256=1ImTwpubSHXEwq76aO3jVSE7VvjzZG6BGudAv9reccw,83
+prospector/profiles/profiles/no_pep8.yaml,sha256=cnjvmO-0kcul-URYJv-kJsaob2Zc4bCUJLiYiIVzN84,348
+prospector/profiles/profiles/no_test_warnings.yaml,sha256=vDlRgnOr1YhEAwGW2fmTydHYq10k9nrMyQdM-K6H9EA,175
+prospector/profiles/profiles/strictness_high.yaml,sha256=4IHE07_JMjZdAz5w_mRFt-kP1sTbQuz5rrPJ3InGm2I,818
+prospector/profiles/profiles/strictness_low.yaml,sha256=QONar05NOI_cidCoRASmDFzd7CSk_JC-KVjwDzcPU_8,1066
+prospector/profiles/profiles/strictness_medium.yaml,sha256=z8LNJTbACa2L24TCNVfkGA-PUvnZgzJk7yDiDFRj8eo,1836
+prospector/profiles/profiles/strictness_none.yaml,sha256=_Yf-eEl4cVXw6ePqx3V4mvG80JksH9ggkUqbuAdR5iI,151
+prospector/profiles/profiles/strictness_veryhigh.yaml,sha256=m93J1OzGCRVTWrIQbzhYJux9BCC7amdp5e9ePxIkbDY,594
+prospector/profiles/profiles/strictness_verylow.yaml,sha256=YxZowcBtA3tAaHJGz2htTdAJ-AXmlHB-o4zEYKPRfJg,833
+prospector/profiles/profiles/test_warnings.yaml,sha256=arUcV9MnqiZJEHURH9bVRSYDhYUegNc-ltFYe_yQW44,23
+prospector/run.py,sha256=hjNyzY-wyedGwJspT80jCz4usk-HqL6FmqDcinASJZA,8403
+prospector/suppression.py,sha256=5VPSvw1ECIR1_4spf0Q2jUx04GygEoptA4LDFaErYVU,4954
+prospector/tools/__init__.py,sha256=9tDmxL_kn5jmAACeSi1jtSvT-9tI468Ccn1Up2wUFi0,2956
+prospector/tools/bandit/__init__.py,sha256=oQZANkiQh3MI2HjtLNXbW-yWrtzlbdq2oaGl2_7B4dM,2711
+prospector/tools/base.py,sha256=T1F-vq4rNcaToA4fXjZmcozkABpeiz0odFAMVMEJM1w,1838
+prospector/tools/dodgy/__init__.py,sha256=howLCjFEheW_6ZoyQ15gLbiNNNUr0Pm2qNpLg3kleFY,1648
+prospector/tools/exceptions.py,sha256=Q-u4n6YzZuoMu17XkeKac1o1gBY36JK4MnvWaYrVYL0,170
+prospector/tools/mccabe/__init__.py,sha256=80-aYPqKCREeBqxiIUgsDvxc_GqYxHb5R0JduKHPRaE,3277
+prospector/tools/mypy/__init__.py,sha256=rv4FVOT0ry7E3DlInjKO1_fa01T7IyrxxC3-weL4RuQ,3504
+prospector/tools/profile_validator/__init__.py,sha256=bAkVG-fKtm3WaEv-We36wqzvtqWv4s06Z7YnRVG7UQ4,8326
+prospector/tools/pycodestyle/__init__.py,sha256=uMpUxqsPsryEsfyfGxpLzwoWUjIvfxIQke4Xvkfbi9A,5970
+prospector/tools/pydocstyle/__init__.py,sha256=WB-AT-c1FeUUUWATUzJbBLeREtu-lxT03bChh4nablo,2776
+prospector/tools/pyflakes/__init__.py,sha256=53NQFODU416KO991NxW14gChjagbSAhhfErx1ll7VUQ,5631
+prospector/tools/pylint/__init__.py,sha256=WoI23QXmGlumgZMRg1-tQJ8Tpzl9_KpLUQIKlb7vEkE,11108
+prospector/tools/pylint/collector.py,sha256=_PEV_8nV77_87m8rA2Td4WOqO9F2UaIQ4Bb_aUv_WQg,1377
+prospector/tools/pylint/linter.py,sha256=YQ9SOna4WjbbauqSgUio6Ss8zN08PCr3aKdK9rMi7Ag,2143
+prospector/tools/pyright/__init__.py,sha256=USqauZofh-8ZSKGwXRXoaM2ItzfSFo2nGwPtLGEWICU,3346
+prospector/tools/pyroma/__init__.py,sha256=GPQRJZfbs_SI0RBTyySz-4SIuM__YoLfXAm7uYVXAS8,3151
+prospector/tools/ruff/__init__.py,sha256=HRj2S-I45DCg3y4T6035PvHyRutTPU9Boeh3IWU9_pw,3300
+prospector/tools/utils.py,sha256=4wj7Lz-mYs6QIdvP-kCLlXs-ZRSkrwLpSKn9xHvDpgw,1585
+prospector/tools/vulture/__init__.py,sha256=eaTh4X5onNlBMuz1x0rmcRn7x5XDVDgqftjIEd47eWI,3583
+prospector-1.13.2.dist-info/entry_points.txt,sha256=SxvCGt8MJTEZefHAvwnUc6jDetgCaaYY1Zpifuk8tqU,50
+prospector-1.13.2.dist-info/LICENSE,sha256=WoTRadDy8VbcIKoVzl5Q1QipuD_cexAf3ul4MaVLttc,18044
+prospector-1.13.2.dist-info/WHEEL,sha256=gSF7fibx4crkLz_A-IKR6kcuq0jJ64KNCkG8_bcaEao,88
+prospector-1.13.2.dist-info/METADATA,sha256=M45kwECENnOkBYWyx6v5887c_iujb4Mu554svWtnsbU,9962
+prospector-1.13.2.dist-info/RECORD,,

README.rst

@@ -1,208 +0,0 @@
-prospector
-==========
-
-.. image:: https://img.shields.io/pypi/v/prospector.svg
-   :target: https://pypi.python.org/pypi/prospector
-   :alt: Latest Version of Prospector
-.. image:: https://github.com/PyCQA/prospector/actions/workflows/tests.yml/badge.svg
-   :target: https://github.com/PyCQA/prospector/actions/workflows/tests.yml
-   :alt: Build Status
-.. image:: https://img.shields.io/coveralls/PyCQA/prospector.svg?style=flat
-   :target: https://coveralls.io/r/PyCQA/prospector
-   :alt: Test Coverage
-.. image:: https://readthedocs.org/projects/prospector/badge/?version=latest
-   :target: https://prospector.readthedocs.io/
-   :alt: Documentation
-
-
-About
------
-
-Prospector is a tool to analyse Python code and output information about
-errors, potential problems, convention violations and complexity.
-
-It brings together the functionality of other Python analysis tools such as
-`Pylint <https://docs.pylint.org/>`_,
-`pycodestyle <https://pycodestyle.pycqa.org/>`_,
-and `McCabe complexity <https://pypi.python.org/pypi/mccabe>`_.
-See the `Supported Tools <https://prospector.readthedocs.io/en/latest/supported_tools.html>`_
-documentation section for a complete list.
-
-The primary aim of Prospector is to be useful 'out of the box'. A common complaint of other
-Python analysis tools is that it takes a long time to filter through which errors are relevant
-or interesting to your own coding style. Prospector provides some default profiles, which
-hopefully will provide a good starting point and will be useful straight away, and adapts
-the output depending on the libraries your project uses.
-
-Installation
-------------
-
-Prospector can be installed from PyPI using ``pip`` by running the following command::
-
-    pip install prospector
-
-Optional dependencies for Prospector, such as ``pyroma`` can also be installed by running::
-
-    pip install prospector[with_pyroma]
-
-Some shells (such as ``Zsh``, the default shell of macOS Catalina) require brackets to be escaped::
-
-    pip install prospector\[with_pyroma\]
-
-For a list of all of the optional dependencies, see the optional extras section on the ReadTheDocs
-page on `Supported Tools Extras <https://prospector.readthedocs.io/en/latest/supported_tools.html#optional-extras>`_.
-
-For local development, `poetry <https://python-poetry.org/>`_ is used. Check out the code, then run::
-
-    poetry install
-
-And for extras::
-
-    poetry install -E with_everything
-
-For more detailed information on installing the tool, see the
-`installation section <https://prospector.readthedocs.io/en/latest/#installation>`_ of the tool's main page
-on ReadTheDocs.
-
-Documentation
--------------
-
-Full `documentation is available at ReadTheDocs <https://prospector.readthedocs.io>`_.
-
-Usage
------
-
-Simply run prospector from the root of your project::
-
-    prospector
-
-This will output a list of messages pointing out potential problems or errors, for example::
-
-    prospector.tools.base (prospector/tools/base.py):
-        L5:0 ToolBase: pylint - R0922
-        Abstract class is only referenced 1 times
-
-Options
-```````
-
-Run ``prospector --help`` for a full list of options and their effects.
-
-Output Format
-~~~~~~~~~~~~~
-
-The default output format of ``prospector`` is designed to be human readable. For parsing
-(for example, for reporting), you can use the ``--output-format json`` flag to get JSON-formatted
-output.
-
-Profiles
-~~~~~~~~
-
-Prospector is configurable using "profiles". These are composable YAML files with directives to
-disable or enable tools or messages. For more information, read
-`the documentation about profiles <https://prospector.readthedocs.io/en/latest/profiles.html>`_.
-
-If your code uses frameworks and libraries
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Often tools such as pylint find errors in code which is not an error, for example due to attributes of classes being
-created at run time by a library or framework used by your project.
-For example, by default, pylint will generate an error for Django models when accessing ``objects``, as the
-``objects`` attribute is not part of the ``Model`` class definition.
-
-Prospector mitigates this by providing an understanding of these frameworks to the underlying tools.
-
-Prospector will try to intuit which libraries your project uses by
-`detecting dependencies <https://github.com/landscapeio/requirements-detector>`_ and automatically turning on
-support for the requisite libraries. You can see which adaptors were run in the metadata section of the report.
-
-If Prospector does not correctly detect your project's dependencies, you can specify them manually from the commandline::
-
-    prospector --uses django celery
-
-Additionally, if Prospector is automatically detecting a library that you do not in fact use, you can turn
-off autodetection completely::
-
-    prospector --no-autodetect
-
-Note that as far as possible, these adaptors have been written as plugins or augmentations for the underlying
-tools so that they can be used without requiring Prospector. For example, the Django support is available as a pylint plugin.
-
-Strictness
-~~~~~~~~~~
-
-Prospector has a configurable 'strictness' level which will determine how harshly it searches for errors::
-
-    prospector --strictness high
-
-Possible values are ``verylow``, ``low``, ``medium``, ``high``, ``veryhigh``.
-
-Prospector does not include documentation warnings by default, but you can turn
-this on using the ``--doc-warnings`` flag.
-
-pre-commit
-----------
-
-If you'd like Prospector to be run automatically when making changes to files in your Git
-repository, you can install `pre-commit <https://pre-commit.com/>`_ and add the following
-text to your repositories' ``.pre-commit-config.yaml``::
-
-    repos:
-    -   repo: https://github.com/PyCQA/prospector
-        rev: 1.7.5 # The version of Prospector to use, if not 'master' for latest
-        hooks:
-        -   id: prospector
-
-This only installs base prospector - if you also use optional tools, for example bandit and/or mypy, then you can add
-them to the hook configuration like so::
-
-    repos:
-    -   repo: https://github.com/PyCQA/prospector
-        rev: 1.7.5
-        hooks:
-        -   id: prospector
-            additional_dependencies:
-            - ".[with_mypy,with_bandit]"
-          - args: [
-            '--with-tool=mypy',
-            '--with-tool=bandit',
-            ]
-
-Additional dependencies can be `individually configured <https://prospector.landscape.io/en/master/profiles.html#individual-configuration-options>`_ in your `prospector.yml` file ::
-
-    # https://bandit.readthedocs.io/en/latest/config.html
-    bandit:
-    options:
-        skips:
-        - B201
-        - B601
-        - B610
-        - B611
-        - B703
-
-    # https://mypy.readthedocs.io/en/stable/command_line.html
-    mypy:
-    options:
-        ignore-missing-imports: true
-
-For prospector options which affect display only - those which are not configurable using a profile - these can be
-added as command line arguments to the hook. For example::
-
-    repos:
-    -   repo: https://github.com/PyCQA/prospector
-        rev: 1.7.5
-        hooks:
-        -   id: prospector
-            additional_dependencies:
-            -   ".[with_mypy,with_bandit]"
-            args:
-            -   --with-tool=mypy
-            -   --with-tool=bandit
-            -   --summary-only
-            -   --zero-exit
-
-
-
-License
--------
-
-Prospector is available under the GPLv2 License.