From 9a8d85d22f3a0eb49d75b259ca7fcf332fbef7ac Mon Sep 17 00:00:00 2001 From: Florent Xicluna Date: Wed, 20 Feb 2013 22:50:12 +0100 Subject: [PATCH] Move the changelog to CHANGES.rst --- CHANGES.rst | 132 ++++++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 135 ---------------------------------------------------- setup.py | 13 ++++- 3 files changed, 143 insertions(+), 137 deletions(-) create mode 100644 CHANGES.rst diff --git a/CHANGES.rst b/CHANGES.rst new file mode 100644 index 0000000..fcddf7b --- /dev/null +++ b/CHANGES.rst @@ -0,0 +1,132 @@ +CHANGES +======= + +2.0.0 - 2013-01-xx +------------------ + +- Fixes #13: pep8 and pyflakes are now external dependencies +- Split run.py into main.py and hooks.py for better logic +- Expose our parser for our users +- New feature: Install git and hg hooks automagically +- By relying on pyflakes (0.6.1), we also fixed #45 and #35 + +1.7.0 - 2012-12-21 +------------------ + +- Fixes part of #35: Exception for no WITHITEM being an attribute of Checker + for python 3.3 +- Support stdin +- Incorporate @phd's builtins pull request +- Fix the git hook +- Update pep8.py to the latest version + +1.6.2 - 2012-11-25 +------------------ + +- fixed the NameError: global name 'message' is not defined (#46) + + +1.6.1 - 2012-11-24 +------------------ + +- fixed the mercurial hook, a change from a previous patch was not properly + applied +- fixed an assumption about warnings/error messages that caused an exception + to be thrown when McCabe is used + +1.6 - 2012-11-16 +---------------- + +- changed the signatures of the ``check_file`` function in flake8/run.py, + ``skip_warning`` in flake8/util.py and the ``check``, ``checkPath`` + functions in flake8/pyflakes.py. +- fix ``--exclude`` and ``--ignore`` command flags (#14, #19) +- fix the git hook that wasn't catching files not already added to the index + (#29) +- pre-emptively includes the addition to pep8 to ignore certain lines. Add ``# + nopep8`` to the end of a line to ignore it. (#37) +- ``check_file`` can now be used without any special prior setup (#21) +- unpacking exceptions will no longer cause an exception (#20) +- fixed crash on non-existant file (#38) + + + +1.5 - 2012-10-13 +---------------- + +- fixed the stdin +- make sure mccabe catches the syntax errors as warnings +- pep8 upgrade +- added max_line_length default value +- added Flake8Command and entry points is setuptools is around +- using the setuptools console wrapper when available + + +1.4 - 2012-07-12 +---------------- + +- git_hook: Only check staged changes for compliance +- use pep8 1.2 + + +1.3.1 - 2012-05-19 +------------------ + +- fixed support for Python 2.5 + + +1.3 - 2012-03-12 +---------------- + +- fixed false W402 warning on exception blocks. + + +1.2 - 2012-02-12 +---------------- + +- added a git hook +- now python 3 compatible +- mccabe and pyflakes have warning codes like pep8 now + + +1.1 - 2012-02-14 +---------------- + +- fixed the value returned by --version +- allow the flake8: header to be more generic +- fixed the "hg hook raises 'physical lines'" bug +- allow three argument form of raise +- now uses setuptools if available, for 'develop' command + +1.0 - 2011-11-29 +---------------- + +- Deactivates by default the complexity checker +- Introduces the complexity option in the HG hook and the command line. + + +0.9 - 2011-11-09 +---------------- + +- update pep8 version to 0.6.1 +- mccabe check: gracefully handle compile failure + +0.8 - 2011-02-27 +---------------- + +- fixed hg hook +- discard unexisting files on hook check + + +0.7 - 2010-02-18 +---------------- + +- Fix pep8 intialization when run through Hg +- Make pep8 short options work when run throug the command line +- skip duplicates when controlling files via Hg + + +0.6 - 2010-02-15 +---------------- + +- Fix the McCabe metric on some loops diff --git a/README.rst b/README.rst index 7b415d2..f6b5cc4 100644 --- a/README.rst +++ b/README.rst @@ -225,138 +225,3 @@ flakey: McCabe: - W901: '' is too complex ('') - -CHANGES -======= - -2.0.0 - 2013-01-xx ------------------- - -- Fixes #13: pep8 and pyflakes are now external dependencies -- Split run.py into main.py and hooks.py for better logic -- Expose our parser for our users -- New feature: Install git and hg hooks automagically -- By relying on pyflakes (0.6.1), we also fixed #45 and #35 - -1.7.0 - 2012-12-21 ------------------- - -- Fixes part of #35: Exception for no WITHITEM being an attribute of Checker - for python 3.3 -- Support stdin -- Incorporate @phd's builtins pull request -- Fix the git hook -- Update pep8.py to the latest version - -1.6.2 - 2012-11-25 ------------------- - -- fixed the NameError: global name 'message' is not defined (#46) - - -1.6.1 - 2012-11-24 ------------------- - -- fixed the mercurial hook, a change from a previous patch was not properly - applied -- fixed an assumption about warnings/error messages that caused an exception - to be thrown when McCabe is used - -1.6 - 2012-11-16 ----------------- - -- changed the signatures of the ``check_file`` function in flake8/run.py, - ``skip_warning`` in flake8/util.py and the ``check``, ``checkPath`` - functions in flake8/pyflakes.py. -- fix ``--exclude`` and ``--ignore`` command flags (#14, #19) -- fix the git hook that wasn't catching files not already added to the index - (#29) -- pre-emptively includes the addition to pep8 to ignore certain lines. Add ``# - nopep8`` to the end of a line to ignore it. (#37) -- ``check_file`` can now be used without any special prior setup (#21) -- unpacking exceptions will no longer cause an exception (#20) -- fixed crash on non-existant file (#38) - - - -1.5 - 2012-10-13 ----------------- - -- fixed the stdin -- make sure mccabe catches the syntax errors as warnings -- pep8 upgrade -- added max_line_length default value -- added Flake8Command and entry points is setuptools is around -- using the setuptools console wrapper when available - - -1.4 - 2012-07-12 ----------------- - -- git_hook: Only check staged changes for compliance -- use pep8 1.2 - - -1.3.1 - 2012-05-19 ------------------- - -- fixed support for Python 2.5 - - -1.3 - 2012-03-12 ----------------- - -- fixed false W402 warning on exception blocks. - - -1.2 - 2012-02-12 ----------------- - -- added a git hook -- now python 3 compatible -- mccabe and pyflakes have warning codes like pep8 now - - -1.1 - 2012-02-14 ----------------- - -- fixed the value returned by --version -- allow the flake8: header to be more generic -- fixed the "hg hook raises 'physical lines'" bug -- allow three argument form of raise -- now uses setuptools if available, for 'develop' command - -1.0 - 2011-11-29 ----------------- - -- Deactivates by default the complexity checker -- Introduces the complexity option in the HG hook and the command line. - - -0.9 - 2011-11-09 ----------------- - -- update pep8 version to 0.6.1 -- mccabe check: gracefully handle compile failure - -0.8 - 2011-02-27 ----------------- - -- fixed hg hook -- discard unexisting files on hook check - - -0.7 - 2010-02-18 ----------------- - -- Fix pep8 intialization when run through Hg -- Make pep8 short options work when run throug the command line -- skip duplicates when controlling files via Hg - - -0.6 - 2010-02-15 ----------------- - -- Fix the McCabe metric on some loops - - diff --git a/setup.py b/setup.py index d19e3a2..054073b 100644 --- a/setup.py +++ b/setup.py @@ -1,15 +1,24 @@ +# -*- coding: utf-8 -*- +from __future__ import with_statement from setuptools import setup from flake8 import __version__ -README = open('README.rst').read() + +def get_long_description(): + descr = [] + for fname in ('README.rst', 'CHANGES.rst'): + with open(fname) as f: + descr.append(f.read()) + return '\n\n'.join(descr) + setup( name="flake8", license="MIT", version=__version__, description="the modular source code checker: pep8, pyflakes and co", - long_description=README, + long_description=get_long_description(), author="Tarek Ziade", author_email="tarek@ziade.org", maintainer="Ian Cordasco",