Ian Cordasco
1ec83033e9
Update the copyright in the LICENSE
2016-06-25 10:49:32 -05:00
Ian Cordasco
7b31ecf7d5
Update the MANIFEST.in for sdists
...
Let's include our documentation, tests, and src code appropriately
2016-06-25 10:48:52 -05:00
Ian Cordasco
1a2c68f5da
Move flake8 into src
...
This is an emerging best practice and there is little reason to not
follow it
2016-06-25 10:12:13 -05:00
Ian Cordasco
5c8d767626
Rename dev subdirectory to plugin-development
...
This should make the contents clearer
2016-06-25 09:51:15 -05:00
Ian Cordasco
14ce512b9a
Add extra information to plugin dev index
2016-06-25 09:49:06 -05:00
Ian Cordasco
87b331c552
Add some notes for users about how to use plugins
2016-06-25 09:45:08 -05:00
Ian Cordasco
c2111656a6
Add descriptions of pycodestyle and mccable
2016-06-24 14:54:48 -05:00
Ian Cordasco
cae943bd44
Add missing - to sub-directories
2016-06-22 19:27:23 -05:00
Ian Cordasco
1de5da8a7f
Add more definitions to glossary
2016-06-22 19:27:10 -05:00
Ian Cordasco
478d5620d8
Correct example register_options method
2016-06-22 19:13:20 -05:00
Ian Cordasco
88d1dd280a
Start a glossary of terms
2016-06-22 14:34:14 -05:00
Ian Cordasco
601696d564
Trim whitespace from cross-compat plugin docs
2016-06-22 10:07:16 -05:00
Ian Cordasco
04bceeceb5
Remove historical files from the repository
...
The old/ directory was the archive of flake8 2.0. DESIGN.rst was the
place I kept my initial 3.0 notes for design purposes.
2016-06-22 08:42:30 -05:00
Ian Cordasco
6c0d900a38
Write plugin cross-compatibility documentation
2016-06-22 08:40:53 -05:00
Ian Cordasco
9526e061a7
Add more detail about types of releases
2016-06-22 08:10:07 -05:00
Ian Cordasco
60b67f4ef3
Trim trailing whitespace
...
I need to get better at following my own contrib documentation
2016-06-22 08:05:47 -05:00
Ian Cordasco
9fe82d7be0
Update version string to beta
...
Add a version info tuple for plugins to use
2016-06-21 07:37:08 -05:00
Ian Cordasco
f3cd7ee6fb
Update FAQ to be a bit clearer
2016-06-21 07:36:40 -05:00
Ian Cordasco
a4c1edb03e
Add FAQ
2016-06-20 20:54:31 -05:00
Ian Cordasco
b67d1d633e
Add documentation about release versioning and process
2016-06-20 20:53:47 -05:00
Ian Cordasco
6ac4d16522
Switch to pycodestyle and start constraining versions again
2016-06-20 20:20:48 -05:00
Ian Cordasco
ba5bf0c57a
Add missing docstring to Application#report_benchmarks
2016-06-20 13:49:17 -05:00
Ian Cordasco
590e15cb4c
Trim trailing whitespace in docs
2016-06-20 13:42:48 -05:00
Ian Cordasco
3cbad557ea
Remove mypy from list of tox environments
2016-06-20 13:29:53 -05:00
Ian Cordasco
3e8bbc50dc
Add documentation ... for writing documentation
2016-06-20 09:26:01 -05:00
Ian Cordasco
41277ff965
Use |Flake8| consistently throughout documentation
2016-06-20 08:13:50 -05:00
Ian Cordasco
57ac6ab699
Add |Flake8| substitution to the epilog
...
The rst_epilog config value in Sphinx allows you to maintain a global
list of replaces or includes that are appended to the text of each
document in your documentation. This allows us to use |Flake8| everywhere
without redefining the replace in every document.
2016-06-20 08:04:33 -05:00
Ian Cordasco
16f58005bf
Add --benchmark option documentation
2016-06-19 20:41:19 -05:00
Ian Cordasco
adedd6c5cf
Add --benchmark and formatting for its values
2016-06-19 20:37:32 -05:00
Ian Cordasco
1f7a8081ad
Merge branch '3.0-doc-wording' into 'proposed/3.0'
...
Grammar and clarity improvements.
Improve grammar and clarity throughout the documentation.
See merge request !62
2016-06-20 01:34:44 +00:00
Cea Stapleton
330fdb5b56
Grammar and clarity improvements.
2016-06-19 14:06:26 -05:00
Ian Cordasco
fd5c7d009d
Update Travis to run the linters individually
2016-06-17 11:10:16 -05:00
Ian Cordasco
8bc76f79de
Configure flake8-import-order to use Google Style
...
This relies on two things:
1. Properly configuring flake8-import-order to use that style
2. Properly configuring flake8-import-order to know that flake8 is our
application name.
2016-06-17 10:26:36 -05:00
Ian Cordasco
3f434f7d1c
Add broken config file to test error handling
...
ConfigFileFinder should absolutely handle broken/invalid config files
by refusing to try to parse them. Here we catch the ParsingError,
log the exception, and then return normally. The RawConfigParser
instance is perfectly valid still and will behave as if nothing had
been read and we just need to indicate that we didn't find any files
worthy of reading.
Related to: https://github.com/PyCQA/pycodestyle/issues/506
2016-06-16 16:19:09 -05:00
Ian Cordasco
9a9bcdfb52
Add setuptools integration
...
This proved simpler because I realized something important: Most of the
code that the old integration was using was in fact doing nothing of
value. Since we can't meaningfully allow users to use command-line
options as parameters to `python setup.py flake8`, we just remove the
work that we do to set up those attributes and parse them.
2016-06-16 10:59:16 -05:00
Ian Cordasco
1de71fbe89
Set a default value for --select
...
This allows us to add --append-to-select and --append-to-ignore at a
later date that will work as expected and in a consistent manner.
2016-06-16 08:27:28 -05:00
Ian Cordasco
023de21fe2
Find filenames for mercurial hook
...
Extract the files changed in a particular commit or set of commits
for the commit and qrefresh mercurial hooks.
2016-06-16 07:20:09 -05:00
Ian Cordasco
eff77e2bc2
Set a lower-limit on flake8-docstrings
...
flake8-docstrings is broken on 0.2.6 with flake8 2.6.0, 0.2.7 was
released today which fixes the problem. Let's avoid that version if at
all possible.
2016-06-16 06:35:51 -05:00
Ian Cordasco
29896e648a
Use a template for git pre-commit hook
...
Previously, we forced Flake8 to be installed in whatever Python
environment that the user was using. This allows someone to use Flake8
from a virtual environment, e.g., if you use the tox.ini from this
commit, you can do:
tox -e venv -- flake8 --install-hook git
And that will allow you to use the Python and Flake8 from
./.tox/venv/bin/python. This means that you can avoid installing
Flake8 globally and still have a working commit hook.
2016-06-16 06:30:07 -05:00
Ian Cordasco
07101231d9
Ensure that the directories exist
...
If we create our temporary directory structure for our files, we need
to ensure that all the directories (including the ones in the filename)
exist before we copy the contents to that location.
2016-06-16 06:29:04 -05:00
Ian Cordasco
27eb975411
Properly unpack stdout and stdin
...
subprocess.Popen#communicate returns (stdout, stdin) but we were only
unpacking stdout from it causing an exception.
2016-06-16 06:27:45 -05:00
Ian Cordasco
a4b0793bf7
Use correct stat module constant
...
Previously we were using stat.IROTH instead of stat.S_IROTH. I must
have been thinking about retirement. ;-)
2016-06-16 06:26:02 -05:00
Ian Cordasco
b1f039a476
Add information about new --verbose behaviour
2016-06-15 09:20:26 -05:00
Ian Cordasco
25502f6ade
Add note about # noqa: <errors>
2016-06-15 07:48:46 -05:00
Ian Cordasco
3af48abac6
Remove CHANGES.rst
2016-06-14 20:48:44 -05:00
Ian Cordasco
29419b0ac3
Start a changelog entry for 3.0.0
2016-06-14 20:48:04 -05:00
Ian Cordasco
e2ef07fe80
Copied one too many lines from template
2016-06-14 20:47:35 -05:00
Ian Cordasco
8bb3048775
Add documentation for --install-hook
2016-06-14 20:43:00 -05:00
Ian Cordasco
8a18cfa4a3
Add documentation around specifying a format string
2016-06-14 20:10:09 -05:00
Ian Cordasco
18d6e6264c
Revert silliness around setting choices for --format
...
If we restrict the user's ability to specify a format string, we break
existing workflows.
2016-06-14 20:04:52 -05:00
