Release 1.7.0

CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.7.0] - 2018-08-25
+
+### Added
+- Support to pycodestyle >= 2.4.0
+
+### Removed
+- Radon (to support pycodestyle >= 2.4.0)
+- Unused code to parse pyflakes and radon
+- dev: dependency management via requirements file (use pipenv)
+
+[Unreleased]: https://github.com/cemsbr/yala/compare/v1.7.0...HEAD
+[1.7.0]: https://github.com/cemsbr/yala/compare/v1.6.0...v1.7.0

README.rst

@@ -6,21 +6,19 @@ YALA - Yet Another Linter Aggregator
 YALA combines many linters to improve the quality of your code. Other projects may come to your mind, but does anyone have all the features below?
 
 Works with latest linters
-    Yala uses linters' outputs and doesn't break on API changes.
+    Yala uses linters' outputs and doesn't break when their APIs change.
 Same defaults
     No changes to linters' default configuration.
 Easy to configure
-    Set any command-line option for any linter (even pylint!) in one INI file: setup.cfg.
-Language-agnostic
-    Add any linter to any language.
-Extensible
-    Just a few lines do add your preferred linter.
+    Set any command-line option for any linter (even pylint!) in setup.cfg.
 Fast
-    Run linters in parallel and sort output by filename and line number.
+    Run linters in parallel.
 
 Current Status
 --------------
-For now, there are some Python linters available: isort, Pylint, Pycodestyle, Pydocstyle, Pyflakes and Radon (cyclomatic complexity and maintainability index).
+For now, the supported Python linters are: isort, Pylint, Pycodestyle and Pydocstyle. There's also an optional support for mypy: if it is installed, it will be automatically detected and used.
+
+
 
 Install
 -------
@@ -34,14 +32,16 @@ If you are willing to hack yala's code, run the command below in this README's f
 
 .. code-block:: bash
 
-  sudo pip3 install -e .[dev]
+  sudo pip3 install --editable .[dev]
 
 
 Usage
 -----
 Just call ``yala`` followed by the files and/or folders to lint.
 
 
+
+
 Configuration
 -------------
 
@@ -63,9 +63,8 @@ For example, to disable a specific pylint warning and output grades C and lower
 
   [yala]
   pylint args = --disable=TODO
-  radon mi args = --min C
 
-Besides `pylint` and `radon mi`, you can define CLI options for `isort`, `pycodestyle`, `pydocstyle`, `pyflakes`, `pylint` and `radon cc` (the names are exactly as they are called in command line).
+Besides `pylint`, you can define CLI options for `isort`, `pycodestyle` and `pydocstyle` (the names are exactly as they are called in command line).
 
 
 Choosing linters

setup.py

@@ -3,6 +3,8 @@
 
 from setuptools import setup
 
+from yala import __version__
+
 HERE = path.abspath(path.dirname(__file__))
 
 # Get the long description from the README file
@@ -11,7 +13,7 @@
 
 setup(
     name='yala',
-    version='1.6.0',
+    version=__version__,
     description='Yet Another Linter Aggregator',
     long_description=LONG_DESC,
     url='https://github.com/cemsbr/yala',
@@ -40,7 +42,7 @@
         'pydocstyle',
         'pylint',
     ],
-    # $ pip install -e .[dev,test]
+    # $ pip install -e .[dev]
     extras_require={
         'dev': [
             # https://bitbucket.org/ned/coveragepy/issues/578/

yala/__init__.py

@@ -2,5 +2,7 @@
 from pathlib import Path
 import logging.config
 
+__version__ = '1.7.0'
+
 CONFIG_PATH = Path(__file__).parent / 'logging.ini'
 logging.config.fileConfig(str(CONFIG_PATH), disable_existing_loggers=False)

yala/main.py

@@ -21,6 +21,7 @@
 
 from docopt import docopt
 
+from . import __version__
 from .config import Config
 from .linters import LINTERS
 
@@ -153,5 +154,5 @@ def _print_stdout(stdout):
 
 def main():
     """Entry point for the console script."""
-    args = docopt(__doc__, version='1.6.0')
+    args = docopt(__doc__, version=__version__)
     Main().run_from_cli(args)