Skip to main content

Code Analysis Application (coala)

Project description

.. Start ignoring LineLengthBear

::

.o88Oo._
d8P .ooOO8bo._
88 '*Y8bo.
__ YA '*Y8b __
,dPYb, YA 68o68**8Oo.
IP'`Yb "8D *"' "Y8o
I8 8I Y8 'YB .8D
I8 8P '8 d8' 8D
I8 8' 8 d8888b d AY
,gggo, ,ggggo, ,gggo,gg I8 dP ,gggo,gg Y, d888888 d' _.oP"
dP" "Yb dP" "Y8go*8P" "Y8I I8dP dP" "Y8I q. Y8888P' d8
i8' i8' ,8P i8' ,8I I8P i8' ,8I "q. `Y88P' d8"
,d8,_ _,d8, ,d8' d8, ,d8b,,d8b,_ ,d8, ,d8b, Y ,o8P
ooP""Y8888PP*"Y8888P" "Y8888P"`Y88P'"Y88P"Y8888P"`Y8 oooo888P"

.. Stop ignoring LineLengthBear

Get coala to lint all your languages in your project with one tool and config!

About
-----

coala is a simple COde AnaLysis Application. Its goal is to make static
code analysis easy while remaining completely modular and therefore
extendable and language independent. coala is written with a lower case
"c".

Read more at our `documentation <http://coala.rtfd.org/>`__.

Why use coala?
--------------

- coala provides **built-in checking routines** (named bears in coala).
- **Serves your requirement**: You can easily write your own checks (using
bears).
- coala provides **user-friendly interfaces** like json, formatted and
interactive output in the CLI and *plugins for various editors* are
available as well.
- **Optimal performance**: coala manages parallelizing the checking-routines
without you having to worry.
- **Unified interface**: One tool for all programming languages.

If you want to learn more about coala, its functionality and its usage,
please take a look at our
`tutorial <http://coala.rtfd.org/en/latest/Users/Tutorials/Tutorial.html>`__.

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

To install coala with the official set of analysis routines you can simply run
``pip3 install coala-bears``.

coala only, without the official bears, can be installed with
``pip3 install coala``. If you need more information about the installation and
+dependencies, take a look at our `installation documentation
<http://coala.rtfd.org/en/latest/Users/Install.html>`_.

The latest code from master is automatically deployed to PyPI as a
development version. Get it with ``pip3 install coala --pre``.

|PyPI|

Authors
-------

coala is maintained by a growing community. Please take a look at the
meta information in `setup.py <setup.py>`__ for current maintainers.

Project Status
--------------

|Linux Build Status| |Windows Build status| |OSX Build status|

|Scrutinizer Code Quality| |codecov.io|

|Documentation Status| |Gitmate|

Getting Involved
----------------

If you want to contribute to coala, please take a look at the `Getting
Involved Information
<http://coala.readthedocs.org/en/latest/Getting_Involved/README.html>`__.

We appreciate any help!

|https://gitter.im/coala-analyzer/coala|

License
-------

|AGPL|

This code falls under the GNU Affero General Public License as published
by the Free Software Foundation, either version 3 of the License, or (at
your option) any later version.

Please note that some files or content may be copied from other places.
Most of them are GPL compatible. There is a small portion of code in the
tests that falls under the Creative Commons license, see
https://creativecommons.org/licenses/by-sa/3.0/deed.de for more
information.

.. |PyPI| image:: https://img.shields.io/pypi/pyversions/coala.svg
:target: https://pypi-hypernode.com/pypi/coala
.. |Linux Build Status| image:: https://img.shields.io/circleci/project/coala-analyzer/coala/master.svg?label=linux%20build
:target: https://circleci.com/gh/coala-analyzer/coala
.. |Windows Build status| image:: https://img.shields.io/appveyor/ci/coala/coala/master.svg?label=windows%20build
:target: https://ci.appveyor.com/project/coala/coala/branch/master
.. |OSX Build status| image:: https://img.shields.io/travis/coala-analyzer/coala/master.svg?label=osx%20build
:target: https://travis-ci.org/coala-analyzer/coala
.. |Scrutinizer Code Quality| image:: https://img.shields.io/scrutinizer/g/coala-analyzer/coala.svg?label=scrutinizer%20quality
:target: https://scrutinizer-ci.com/g/coala-analyzer/coala/?branch=master
.. |codecov.io| image:: https://img.shields.io/codecov/c/github/coala-analyzer/coala/master.svg?label=branch%20coverage
:target: https://codecov.io/github/coala-analyzer/coala?branch=master
.. |Documentation Status| image:: https://readthedocs.org/projects/coala/badge/?version=latest
:target: http://coala.rtfd.org/
.. |https://gitter.im/coala-analyzer/coala| image:: https://img.shields.io/badge/gitter-join%20chat%20%E2%86%92-brightgreen.svg
:target: https://gitter.im/coala-analyzer/coala
.. |AGPL| image:: https://img.shields.io/github/license/coala-analyzer/coala.svg
:target: https://www.gnu.org/licenses/agpl-3.0.html
.. |Gitmate| image:: https://img.shields.io/badge/Gitmate-0%20issues-brightgreen.svg
:target: http://gitmate.com/

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coala-0.6.0.dev20160326155911.tar.gz (155.4 kB view details)

Uploaded Source

Built Distribution

coala-0.6.0.dev20160326155911-py3-none-any.whl (136.6 kB view details)

Uploaded Python 3

File details

Details for the file coala-0.6.0.dev20160326155911.tar.gz.

File metadata

File hashes

Hashes for coala-0.6.0.dev20160326155911.tar.gz
Algorithm Hash digest
SHA256 5455a4d8769ca7a9c5d4b8fc385e60833f684632cfb74be707200645634845aa
MD5 862c4a5e4e9c89755757592614f480c1
BLAKE2b-256 0ffab4931cb01969c23e8eae942f39dcb4018f86506ba46ced4c56386a0beee8

See more details on using hashes here.

File details

Details for the file coala-0.6.0.dev20160326155911-py3-none-any.whl.

File metadata

File hashes

Hashes for coala-0.6.0.dev20160326155911-py3-none-any.whl
Algorithm Hash digest
SHA256 36f705949fb4ede86dc54284e855c7ebacd6817fad78a0b83e2cc42ae4f78821
MD5 fbaacdacbc935f0efaebe6153bcd4c2b
BLAKE2b-256 fbbccfa298c5e856282a754f72aac4240ecbdbc5a9af1ab2c783cc2e9b687d48

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page