Skip to content
VVV provides easy to integrate validation and linting tools to prevent bad stuff committed in your software project
Python Other
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
demo
docs
ghettoci
scripts
tests
vvv
.gitignore
.travis.yml
MANIFEST.in
README.rst
setup.py
validation-files.yaml
validation-options.yaml

README.rst

VVV - validation and linting integrator

VVV is a tool for easy validation and linting integration for your software project. With a single command validate all files, no matter in which programming language, in a source tree against a policy you specify in a simple configuration file. VVV prevents bad stuff to be committed in your software source control or makes cleaning it up easier.

Installation

Please read reading installation instructions before proceeding.

Currently this package is known to be compatible with

  • Python 3.2+
  • Python 2.7

Benefits

  • Enforce coding conventions across multiple developers
  • Enable linting and validators support for your software project with a single command
  • Automatically guide committers to policy guidelines and let them fix errors themselves, instead of having post-commit personal coaching.
  • Provide sane default validation and linting options for all popular programming languages and file formats
  • Run VVV as continuous integration service with systems like Travis CI or Jenkins and shoot down bad code push-ins

What VVV doesn't do

  • This is not automated testing tool. We just scan files against a policy, not for programming errors. Linting tools tend to pick up programming errors, too though, like mistyped names.

Features

  • Set-up for your software repository with two files validation-options.yaml (configuration) and validation-files.yaml (whitelist/blacklist)
  • VVV automatically downloads and locally installs required software - you don't need to spend time hunting downloads or distribution packages
  • Check file against hard tabs and whitespace policies - no more different tab width ever
  • Prevent committing hard source code breakpoints, like Python's import pdb ; pdb.set_trace()
  • Support (on its way) for Subversion, Git, Github, Travis CI, Jenkings and other popular version control and continuous integration systems

Documentation and code

Please see the VVV documentation.

Source code is available on Github. Please use Github issue tracker to contact the authors.

Explore different linting and validators available.

Continuous integration status

Current trunk continuous integration status with Travis CI

https://secure.travis-ci.org/miohtama/vvv.png

Author

Mikko Ohtamaa (blog, Twitter)

Please use Github issue tracker to contact the authors in the project related matters.

Something went wrong with that request. Please try again.