{ "info": { "author": "landscape.io", "author_email": "code@landscape.io", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v2 or later (GPLv2+)", "Operating System :: MacOS :: MacOS X", "Operating System :: Microsoft :: Windows :: Windows 10", "Operating System :: Unix", "Programming Language :: Python :: 2.7", "Topic :: Software Development :: Quality Assurance" ], "description": "prospector\n==========\n\n.. image:: https://img.shields.io/pypi/v/prospector2.svg\n :target: https://pypi.python.org/pypi/prospector2\n :alt: Latest Version of Prospector\n.. image:: https://travis-ci.org/landscapeio/prospector2.png?branch=master\n :target: https://travis-ci.org/landscapeio/prospector2\n :alt: Build Status\n.. image:: https://landscape.io/github/landscapeio/prospector/master/landscape.png?style=flat\n :target: https://landscape.io/github/landscapeio/prospector/master\n :alt: Code Health\n.. image:: https://img.shields.io/coveralls/landscapeio/prospector2.svg?style=flat\n :target: https://coveralls.io/r/PyCQA/prospector\n :alt: Test Coverage\n.. image:: https://readthedocs.org/projects/prospector2/badge/?version=latest\n :target: http://prospector2.readthedocs.io/\n :alt: Documentation\n\n\nRead This First!\n----------------\n\nProspector was originally written as part of https://landscape.io and has been moved across\nto the PyCQA group of python code analysis tools to enable it to have more maintainers and\nmore frequent bug fixes and updates.\n\nThe official version (which is still supported by myself, @carlio) is at https://github.com/PyCQA/prospector.\n\nThis fork is to keep a version which will continue to run under Python2, as various dependencies and libraries\nthat prospector uses or tests - such as pylint, astroid, and Django - have stopped supporting python2.\n\nThis version of prospector will use older versions of those libraries in order to keep Python2 compatability,\nhowever, the main reason for this is to allow Landscape.io to continue checking python-2-based codebases. You\nare welcome to use this in your own projects and I will do my best to keep it working however the recommended\nuse case in personal projects or your own CI setup is to migrate to using Python3 and the PyCQA version of prospector.\n\nAdditionally this fork will not support Python3 but instead be only supporting Python2.\n\nAbout\n-----\n\nProspector is a tool to analyse Python code and output information about\nerrors, potential problems, convention violations and complexity.\n\nIt brings together the functionality of other Python analysis tools such as\n`Pylint `_,\n`pep8 `_,\nand `McCabe complexity `_.\nSee the `Supported Tools `_\ndocumentation section for a complete list.\n\nThe primary aim of Prospector is to be useful 'out of the box'. A common complaint of other\nPython analysis tools is that it takes a long time to filter through which errors are relevant\nor interesting to your own coding style. Prospector provides some default profiles, which\nhopefully will provide a good starting point and will be useful straight away, and adapts\nthe output depending on the libraries your project uses.\n\nInstallation\n------------\n\nProspector can be installed using ``pip`` by running the following command::\n\n pip install prospector\n\n\nOptional dependencies for Prospector, such as ``pyroma`` can also be installed by running::\n\n pip install prospector[with_pyroma]\n\n\nFor a list of all of the optional dependencies, see the optional extras section on the ReadTheDocs\npage on `Supported Tools Extras `_.\n\nFor more detailed information on installing the tool, see the\n`installation section `_ of the tool's main page\non ReadTheDocs.\n\nDocumentation\n-------------\n\nFull `documentation is available at ReadTheDocs `_.\n\nUsage\n-----\n\nSimply run prospector from the root of your project::\n\n prospector\n\nThis will output a list of messages pointing out potential problems or errors, for example::\n\n prospector.tools.base (prospector/tools/base.py):\n L5:0 ToolBase: pylint - R0922\n Abstract class is only referenced 1 times\n\nOptions\n```````\n\nRun ``prospector --help`` for a full list of options and their effects.\n\nOutput Format\n~~~~~~~~~~~~~\n\nThe default output format of ``prospector`` is designed to be human readable. For parsing\n(for example, for reporting), you can use the ``--output-format json`` flag to get JSON-formatted\noutput.\n\nProfiles\n~~~~~~~~\n\nProspector is configurable using \"profiles\". These are composable YAML files with directives to\ndisable or enable tools or messages. For more information, read\n`the documentation about profiles `_.\n\nIf your code uses frameworks and libraries\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\nOften tools such as pylint find errors in code which is not an error, for example due to attributes of classes being\ncreated at run time by a library or framework used by your project.\nFor example, by default, pylint will generate an error for Django models when accessing ``objects``, as the\n``objects`` attribute is not part of the ``Model`` class definition.\n\nProspector mitigates this by providing an understanding of these frameworks to the underlying tools.\n\nProspector will try to intuit which libraries your project uses by\n`detecting dependencies `_ and automatically turning on\nsupport for the requisite libraries. You can see which adaptors were run in the metadata section of the report.\n\nIf Prospector does not correctly detect your project's dependencies, you can specify them manually from the commandline::\n\n prospector --uses django celery\n\nAdditionally, if Prospector is automatically detecting a library that you do not in fact use, you can turn\noff autodetection completely::\n\n prospector --no-autodetect\n\nNote that as far as possible, these adaptors have been written as plugins or augmentations for the underlying\ntools so that they can be used without requiring Prospector. For example, the Django support is available as a pylint plugin.\n\nStrictness\n~~~~~~~~~~\n\nProspector has a configurable 'strictness' level which will determine how harshly it searches for errors::\n\n prospector --strictness high\n\nPossible values are ``verylow``, ``low``, ``medium``, ``high``, ``veryhigh``.\n\nProspector does not include documentation warnings by default, but you can turn\nthis on using the ``--doc-warnings`` flag.\n\n\nLicense\n-------\n\nProspector is available under the GPLv2 License.\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://prospector.readthedocs.io", "keywords": "pylint pyflakes pep8 mccabe frosted prospector static code analysis", "license": "GPLv2", "maintainer": "", "maintainer_email": "", "name": "prospector2", "package_url": "https://pypi.org/project/prospector2/", "platform": "", "project_url": "https://pypi.org/project/prospector2/", "project_urls": { "Homepage": "http://prospector.readthedocs.io" }, "release_url": "https://pypi.org/project/prospector2/0.1/", "requires_dist": null, "requires_python": "", "summary": "Prospector: python static analysis tool", "version": "0.1" }, "last_serial": 4120138, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "83f9f3b55302df318aeb79b6bcc125f1", "sha256": "8f0483ced5a6fdc909bc6e86b3324e453dc883b055b0cd45136818a97b6d3cb4" }, "downloads": -1, "filename": "prospector2-0.1.tar.gz", "has_sig": false, "md5_digest": "83f9f3b55302df318aeb79b6bcc125f1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 50012, "upload_time": "2018-07-31T12:59:38", "url": "https://files.pythonhosted.org/packages/68/2e/546089f0e4245b4a83c51a95bf6a5d256809b2fa3bcd0240193ea7f60103/prospector2-0.1.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "83f9f3b55302df318aeb79b6bcc125f1", "sha256": "8f0483ced5a6fdc909bc6e86b3324e453dc883b055b0cd45136818a97b6d3cb4" }, "downloads": -1, "filename": "prospector2-0.1.tar.gz", "has_sig": false, "md5_digest": "83f9f3b55302df318aeb79b6bcc125f1", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 50012, "upload_time": "2018-07-31T12:59:38", "url": "https://files.pythonhosted.org/packages/68/2e/546089f0e4245b4a83c51a95bf6a5d256809b2fa3bcd0240193ea7f60103/prospector2-0.1.tar.gz" } ] }