Metadata-Version: 2.1
Name: statue
Version: 0.0.18.dev2
Summary: All your static code analysis tools, in one place
Author: Sagi Shadur
Author-email: saroad2@gmail.com
Maintainer: Sagi Shadur
Maintainer-email: saroad2@gmail.com
License: Apache License
Keywords: formatting,static,code,analysis
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Topic :: Utilities
Requires-Python: >=3.7
Description-Content-Type: text/x-rst; charset=UTF-8
License-File: LICENSE

Statue
=========

.. image:: https://img.shields.io/pypi/pyversions/statue.svg
   :target: https://pypi.python.org/pypi/statue
   :alt: Python Versions

.. image:: https://img.shields.io/pypi/v/statue.svg
   :target: https://pypi.python.org/pypi/statue
   :alt: PyPI Version

.. image:: https://img.shields.io/pypi/status/statue.svg
   :target: https://pypi.python.org/pypi/statue
   :alt: Maturity

.. image:: https://img.shields.io/pypi/l/statue.svg
   :target: https://github.com/saroad2/statue/blob/master/LICENSE
   :alt: License

.. image:: https://github.com/saroad2/statue/workflows/CI/badge.svg?branch=master
   :target: https://github.com/saroad2/statue/actions
   :alt: Build Status


*Statue* is an orchestration tool for static code analysis. It combines the overall
power of several linters and formatters into one consistent tool that prevents
unwanted conflicts. With *Statue* you can integrate tools such as *mypy*, *pylint*,
*black*, *isort* and many others.

Installation
------------

In order to install *Statue*, run:

::

    pip install statue

Quick Start
------------

In order to start working with statue, go to your project root directory and initialize a configuration file with the following command:

::

    statue config init

and follow the instructions.

Run In Context
--------------

Run *Statue* in specific contexts in order to evaluate different files in various ways.
For example, run *Statue* over a unit tests folder with the "test" context:

::

    statue run unit_tests --context=test

Contributing
------------

If you experience problems with Statue, `log them on GitHub`_.

If you want to contribute code, please `fork the code`_ and `submit a pull request`_.

.. _log them on Github: https://github.com/saroad2/statue/issues
.. _fork the code: https://github.com/saroad2/statue
.. _submit a pull request: https://github.com/saroad2/statue/pulls


