coala
Linting and Fixing Code for All Languages
Browse Supported Languages
Supported Languages — Issue Tracker — Code — Docs — FAQ — Blog — Donate
why
Every static code analysis has a new user interface and other duplicated parts.
coala unifies code analysis.
coala provides a user and a developer interface, letting developers focus on logic only and users focus on content.
It is fully language independent and any analysis routine can be used for as many languages as it is fit for.
setup details
Get It Native!
sudo pip3 install coala-bears
You can install coala without any bears, just the bare framework, with
sudo pip3 install coala.
If the installation doesn’t work for you, check out common errors documentation.
Alternative: Run it in Docker
You can run coala inside docker on your source code with just one command. If you want to run it natively in your virtualenv, scroll to “Get It Native” :)
docker run -ti -v $(pwd):/app --workdir=/app coala/base coala --files="**/*.py" --bears=PEP8Bear --save
There’s a few caveats and you’ll have to have a working docker setup for this to work but if you do this might be the simpler way of installation.
Try It!
cd project && coala --files="**/*.py" --bears=PEP8Bear --save
Your configuration will be automatically saved to the .coafile in the current directory. Go to our bear documentation to see what bears are available. Bears can be installed as pip packages.
You can generate a config file to start with using coala-quickstart.
Commit It!
git add .coafile && git commit -m "Add coala configuration"
Tell Us What You Think!
Simply join our channel at Gitter! We’d love to speak to you!
Look at our tutorial for a deeper introduction.
usage
What your developers have to know:
Just Execute coala
Right where your .coafile lies. For non interactive/continuous integration, use coala --ci binary.
And of course, coala works on Linux, Windows and Mac! Just make sure to use Python 3.
You can also execute coala right from your editor. Check out our gedit, atom, sublime and other plugins!
If you want to use coala to automatically review pull requests, consider using GitMate. Please mind that GitMate is a prototype.
more info
Visit our documentation
…or checkout the latest coala related news on planet coala and twitter.
team
Join the team of more than 170 contributors.
You can contribute to coala on Github by creating pull requests or submitting issues.
get involved
Take a look at our newcomer docs!
Or just drop us a message at Gitter - we’d love to help you personally!
If you’re looking to write a bear, look at our bear writing tutorial.
calendar
Come meet us.
We’d love to share a bar of chocolate with you!
sponsors/donate
Donate at liberapay!
coala uses free software for recurrent donations. We support many projects we use upstream by code mostly written in our freetime and pay servers out of our own pocket. Any donation is deeply appreciated and helps us focusing on even better code.
For single amount donations and sponsorship opportunities contact coala.analyzer@gmail.com.
Sponsors
Partners
