]> git.madduck.net Git - etc/vim.git/blob - README.md

madduck's git repository

Every one of the projects in this repository is available at the canonical URL git://git.madduck.net/madduck/pub/<projectpath> — see each project's metadata for the exact URL.

All patches and comments are welcome. Please squash your changes to logical commits before using git-format-patch and git-send-email to patches@git.madduck.net. If you'd read over the Git project's submission guidelines and adhered to them, I'd be especially grateful.

SSH access, as well as push access can be individually arranged.

If you use my repositories frequently, consider adding the following snippet to ~/.gitconfig and using the third clone URL listed for each project:

[url "git://git.madduck.net/madduck/"]
  insteadOf = madduck:

00218b63c3d5c2bb1110f6d70939d47c4010c947
[etc/vim.git] / README.md
1 ![Black Logo](https://raw.githubusercontent.com/ambv/black/master/docs/_static/logo2-readme.png)
2 <h2 align="center">The Uncompromising Code Formatter</h2>
3
4 <p align="center">
5 <a href="https://travis-ci.org/ambv/black"><img alt="Build Status" src="https://travis-ci.org/ambv/black.svg?branch=master"></a>
6 <a href="https://black.readthedocs.io/en/stable/?badge=stable"><img alt="Documentation Status" src="https://readthedocs.org/projects/black/badge/?version=stable"></a>
7 <a href="https://coveralls.io/github/ambv/black?branch=master"><img alt="Coverage Status" src="https://coveralls.io/repos/github/ambv/black/badge.svg?branch=master"></a>
8 <a href="https://github.com/ambv/black/blob/master/LICENSE"><img alt="License: MIT" src="https://black.readthedocs.io/en/stable/_static/license.svg"></a>
9 <a href="https://pypi.org/project/black/"><img alt="PyPI" src="https://black.readthedocs.io/en/stable/_static/pypi.svg"></a>
10 <a href="https://pepy.tech/project/black"><img alt="Downloads" src="https://pepy.tech/badge/black"></a>
11 <a href="https://github.com/ambv/black"><img alt="Code style: black" src="https://img.shields.io/badge/code%20style-black-000000.svg"></a>
12 </p>
13
14 > “Any color you like.”
15
16
17 *Black* is the uncompromising Python code formatter.  By using it, you
18 agree to cede control over minutiae of hand-formatting.  In return,
19 *Black* gives you speed, determinism, and freedom from `pycodestyle`
20 nagging about formatting.  You will save time and mental energy for
21 more important matters.
22
23 Blackened code looks the same regardless of the project you're reading.
24 Formatting becomes transparent after a while and you can focus on the
25 content instead.
26
27 *Black* makes code review faster by producing the smallest diffs
28 possible.
29
30 Try it out now using the [Black Playground](https://black.now.sh).
31
32 ---
33
34 *Contents:* **[Installation and usage](#installation-and-usage)** |
35 **[Code style](#the-black-code-style)** |
36 **[pyproject.toml](#pyprojecttoml)** |
37 **[Editor integration](#editor-integration)** |
38 **[blackd](#blackd)** |
39 **[Version control integration](#version-control-integration)** |
40 **[Ignoring unmodified files](#ignoring-unmodified-files)** |
41 **[Testimonials](#testimonials)** |
42 **[Show your style](#show-your-style)** |
43 **[Contributing](#contributing-to-black)** |
44 **[Change Log](#change-log)** |
45 **[Authors](#authors)**
46
47 ---
48
49 ## Installation and usage
50
51 ### Installation
52
53 *Black* can be installed by running `pip install black`.  It requires
54 Python 3.6.0+ to run but you can reformat Python 2 code with it, too.
55
56
57 ### Usage
58
59 To get started right away with sensible defaults:
60
61 ```
62 black {source_file_or_directory}
63 ```
64
65 ### Command line options
66
67 *Black* doesn't provide many options.  You can list them by running
68 `black --help`:
69
70 ```text
71 black [OPTIONS] [SRC]...
72
73 Options:
74   -l, --line-length INTEGER       How many characters per line to allow.
75                                   [default: 88]
76   -t, --target-version [py27|py33|py34|py35|py36|py37|py38]
77                                   Python versions that should be supported by
78                                   Black's output. [default: per-file auto-
79                                   detection]
80   --pyi                           Format all input files like typing stubs
81                                   regardless of file extension (useful when
82                                   piping source on standard input).
83   -S, --skip-string-normalization
84                                   Don't normalize string quotes or prefixes.
85   --check                         Don't write the files back, just return the
86                                   status.  Return code 0 means nothing would
87                                   change.  Return code 1 means some files
88                                   would be reformatted.  Return code 123 means
89                                   there was an internal error.
90   --diff                          Don't write the files back, just output a
91                                   diff for each file on stdout.
92   --fast / --safe                 If --fast given, skip temporary sanity
93                                   checks. [default: --safe]
94   --include TEXT                  A regular expression that matches files and
95                                   directories that should be included on
96                                   recursive searches.  An empty value means
97                                   all files are included regardless of the
98                                   name.  Use forward slashes for directories
99                                   on all platforms (Windows, too).  Exclusions
100                                   are calculated first, inclusions later.
101                                   [default: \.pyi?$]
102   --exclude TEXT                  A regular expression that matches files and
103                                   directories that should be excluded on
104                                   recursive searches.  An empty value means no
105                                   paths are excluded. Use forward slashes for
106                                   directories on all platforms (Windows, too).
107                                   Exclusions are calculated first, inclusions
108                                   later.  [default: /(\.eggs|\.git|\.hg|\.mypy
109                                   _cache|\.nox|\.tox|\.venv|_build|buck-
110                                   out|build|dist)/]
111   -q, --quiet                     Don't emit non-error messages to stderr.
112                                   Errors are still emitted, silence those with
113                                   2>/dev/null.
114   -v, --verbose                   Also emit messages to stderr about files
115                                   that were not changed or were ignored due to
116                                   --exclude=.
117   --version                       Show the version and exit.
118   --config PATH                   Read configuration from PATH.
119   -h, --help                      Show this message and exit.
120 ```
121
122 *Black* is a well-behaved Unix-style command-line tool:
123 * it does nothing if no sources are passed to it;
124 * it will read from standard input and write to standard output if `-`
125   is used as the filename;
126 * it only outputs messages to users on standard error;
127 * exits with code 0 unless an internal error occurred (or `--check` was
128   used).
129
130
131 ### NOTE: This is a beta product
132
133 *Black* is already successfully used by several projects, small and big.
134 It also sports a decent test suite.  However, it is still very new.
135 Things will probably be wonky for a while. This is made explicit by the
136 "Beta" trove classifier, as well as by the "b" in the version number.
137 What this means for you is that **until the formatter becomes stable,
138 you should expect some formatting to change in the future**.  That being
139 said, no drastic stylistic changes are planned, mostly responses to bug
140 reports.
141
142 Also, as a temporary safety measure, *Black* will check that the
143 reformatted code still produces a valid AST that is equivalent to the
144 original.  This slows it down.  If you're feeling confident, use
145 ``--fast``.
146
147
148 ## The *Black* code style
149
150 *Black* reformats entire files in place.  It is not configurable.  It
151 doesn't take previous formatting into account.  It doesn't reformat
152 blocks that start with `# fmt: off` and end with `# fmt: on`. `# fmt: on/off`
153 have to be on the same level of indentation. It also
154 recognizes [YAPF](https://github.com/google/yapf)'s block comments to
155 the same effect, as a courtesy for straddling code.
156
157
158 ### How *Black* wraps lines
159
160 *Black* ignores previous formatting and applies uniform horizontal
161 and vertical whitespace to your code.  The rules for horizontal
162 whitespace can be summarized as: do whatever makes `pycodestyle` happy.
163 The coding style used by *Black* can be viewed as a strict subset of
164 PEP 8.
165
166 As for vertical whitespace, *Black* tries to render one full expression
167 or simple statement per line.  If this fits the allotted line length,
168 great.
169 ```py3
170 # in:
171
172 l = [1,
173      2,
174      3,
175 ]
176
177 # out:
178
179 l = [1, 2, 3]
180 ```
181
182 If not, *Black* will look at the contents of the first outer matching
183 brackets and put that in a separate indented line.
184 ```py3
185 # in:
186
187 ImportantClass.important_method(exc, limit, lookup_lines, capture_locals, extra_argument)
188
189 # out:
190
191 ImportantClass.important_method(
192     exc, limit, lookup_lines, capture_locals, extra_argument
193 )
194 ```
195
196 If that still doesn't fit the bill, it will decompose the internal
197 expression further using the same rule, indenting matching brackets
198 every time.  If the contents of the matching brackets pair are
199 comma-separated (like an argument list, or a dict literal, and so on)
200 then *Black* will first try to keep them on the same line with the
201 matching brackets.  If that doesn't work, it will put all of them in
202 separate lines.
203 ```py3
204 # in:
205
206 def very_important_function(template: str, *variables, file: os.PathLike, engine: str, header: bool = True, debug: bool = False):
207     """Applies `variables` to the `template` and writes to `file`."""
208     with open(file, 'w') as f:
209         ...
210
211 # out:
212
213 def very_important_function(
214     template: str,
215     *variables,
216     file: os.PathLike,
217     engine: str,
218     header: bool = True,
219     debug: bool = False,
220 ):
221     """Applies `variables` to the `template` and writes to `file`."""
222     with open(file, "w") as f:
223         ...
224 ```
225
226 You might have noticed that closing brackets are always dedented and
227 that a trailing comma is always added.  Such formatting produces smaller
228 diffs; when you add or remove an element, it's always just one line.
229 Also, having the closing bracket dedented provides a clear delimiter
230 between two distinct sections of the code that otherwise share the same
231 indentation level (like the arguments list and the docstring in the
232 example above).
233
234 If a data structure literal (tuple, list, set, dict) or a line of "from"
235 imports cannot fit in the allotted length, it's always split into one
236 element per line.  This minimizes diffs as well as enables readers of
237 code to find which commit introduced a particular entry.  This also
238 makes *Black* compatible with [isort](https://pypi.org/p/isort/) with
239 the following configuration.
240
241 <details>
242 <summary>A compatible `.isort.cfg`</summary>
243
244 ```
245 [settings]
246 multi_line_output=3
247 include_trailing_comma=True
248 force_grid_wrap=0
249 use_parentheses=True
250 line_length=88
251 ```
252
253 The equivalent command line is:
254 ```
255 $ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=88 [ file.py ]
256 ```
257 </details>
258
259 ### Line length
260
261 You probably noticed the peculiar default line length.  *Black* defaults
262 to 88 characters per line, which happens to be 10% over 80.  This number
263 was found to produce significantly shorter files than sticking with 80
264 (the most popular), or even 79 (used by the standard library).  In
265 general, [90-ish seems like the wise choice](https://youtu.be/wf-BqAjZb8M?t=260).
266
267 If you're paid by the line of code you write, you can pass
268 `--line-length` with a lower number.  *Black* will try to respect that.
269 However, sometimes it won't be able to without breaking other rules.  In
270 those rare cases, auto-formatted code will exceed your allotted limit.
271
272 You can also increase it, but remember that people with sight disabilities
273 find it harder to work with line lengths exceeding 100 characters.
274 It also adversely affects side-by-side diff review  on typical screen
275 resolutions.  Long lines also make it harder to present code neatly
276 in documentation or talk slides.
277
278 If you're using Flake8, you can bump `max-line-length` to 88 and forget
279 about it.  Alternatively, use [Bugbear](https://github.com/PyCQA/flake8-bugbear)'s
280 B950 warning instead of E501 and keep the max line length at 80 which
281 you are probably already using.  You'd do it like this:
282 ```ini
283 [flake8]
284 max-line-length = 80
285 ...
286 select = C,E,F,W,B,B950
287 ignore = E501
288 ```
289
290 You'll find *Black*'s own .flake8 config file is configured like this.
291 If you're curious about the reasoning behind B950, 
292 [Bugbear's documentation](https://github.com/PyCQA/flake8-bugbear#opinionated-warnings)
293 explains it.  The tl;dr is "it's like highway speed limits, we won't
294 bother you if you overdo it by a few km/h".
295
296
297 ### Empty lines
298
299 *Black* avoids spurious vertical whitespace.  This is in the spirit of
300 PEP 8 which says that in-function vertical whitespace should only be
301 used sparingly.
302
303 *Black* will allow single empty lines inside functions, and single and
304 double empty lines on module level left by the original editors, except
305 when they're within parenthesized expressions.  Since such expressions
306 are always reformatted to fit minimal space, this whitespace is lost.
307
308 It will also insert proper spacing before and after function definitions.
309 It's one line before and after inner functions and two lines before and
310 after module-level functions and classes.  *Black* will not put empty
311 lines between function/class definitions and standalone comments that
312 immediately precede the given function/class.
313
314 *Black* will enforce single empty lines between a class-level docstring
315 and the first following field or method.  This conforms to
316 [PEP 257](https://www.python.org/dev/peps/pep-0257/#multi-line-docstrings).
317
318 *Black* won't insert empty lines after function docstrings unless that
319 empty line is required due to an inner function starting immediately
320 after.
321
322
323 ### Trailing commas
324
325 *Black* will add trailing commas to expressions that are split
326 by comma where each element is on its own line.  This includes function
327 signatures.
328
329 Unnecessary trailing commas are removed if an expression fits in one
330 line.  This makes it 1% more likely that your line won't exceed the
331 allotted line length limit.  Moreover, in this scenario, if you added
332 another argument to your call, you'd probably fit it in the same line
333 anyway.  That doesn't make diffs any larger.
334
335 One exception to removing trailing commas is tuple expressions with
336 just one element.  In this case *Black* won't touch the single trailing
337 comma as this would unexpectedly change the underlying data type.  Note
338 that this is also the case when commas are used while indexing.  This is
339 a tuple in disguise: ```numpy_array[3, ]```.
340
341 One exception to adding trailing commas is function signatures
342 containing `*`, `*args`, or `**kwargs`.  In this case a trailing comma
343 is only safe to use on Python 3.6.  *Black* will detect if your file is
344 already 3.6+ only and use trailing commas in this situation.  If you
345 wonder how it knows, it looks for f-strings and existing use of trailing
346 commas in function signatures that have stars in them.  In other words,
347 if you'd like a trailing comma in this situation and *Black* didn't
348 recognize it was safe to do so, put it there manually and *Black* will
349 keep it.
350
351
352 ### Strings
353
354 *Black* prefers double quotes (`"` and `"""`) over single quotes (`'`
355 and `'''`).  It will replace the latter with the former as long as it
356 does not result in more backslash escapes than before.
357
358 *Black* also standardizes string prefixes, making them always lowercase.
359 On top of that, if your code is already Python 3.6+ only or it's using
360 the `unicode_literals` future import, *Black* will remove `u` from the
361 string prefix as it is meaningless in those scenarios.
362
363 The main reason to standardize on a single form of quotes is aesthetics.
364 Having one kind of quotes everywhere reduces reader distraction.
365 It will also enable a future version of *Black* to merge consecutive
366 string literals that ended up on the same line (see
367 [#26](https://github.com/ambv/black/issues/26) for details).
368
369 Why settle on double quotes?  They anticipate apostrophes in English
370 text.  They match the docstring standard described in [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring).
371 An empty string in double quotes (`""`) is impossible to confuse with
372 a one double-quote regardless of fonts and syntax highlighting used.
373 On top of this, double quotes for strings are consistent with C which
374 Python interacts a lot with.
375
376 On certain keyboard layouts like US English, typing single quotes is
377 a bit easier than double quotes.  The latter requires use of the Shift
378 key.  My recommendation here is to keep using whatever is faster to type
379 and let *Black* handle the transformation.
380
381 If you are adopting *Black* in a large project with pre-existing string
382 conventions (like the popular ["single quotes for data, double quotes for
383 human-readable strings"](https://stackoverflow.com/a/56190)), you can
384 pass `--skip-string-normalization` on the command line.  This is meant as
385 an adoption helper, avoid using this for new projects.
386
387 ### Numeric literals
388
389 *Black* standardizes most numeric literals to use lowercase letters for the
390 syntactic parts and uppercase letters for the digits themselves: `0xAB`
391 instead of `0XAB` and `1e10` instead of `1E10`. Python 2 long literals are
392 styled as `2L` instead of `2l` to avoid confusion between `l` and `1`.
393
394
395 ### Line breaks & binary operators
396
397 *Black* will break a line before a binary operator when splitting a block
398 of code over multiple lines. This is so that *Black* is compliant with the
399 recent changes in the [PEP 8](https://www.python.org/dev/peps/pep-0008/#should-a-line-break-before-or-after-a-binary-operator)
400 style guide, which emphasizes that this approach improves readability.
401
402 This behaviour may raise ``W503 line break before binary operator`` warnings in
403 style guide enforcement tools like Flake8. Since ``W503`` is not PEP 8 compliant,
404 you should tell Flake8 to ignore these warnings.
405
406
407 ### Slices
408
409 PEP 8 [recommends](https://www.python.org/dev/peps/pep-0008/#whitespace-in-expressions-and-statements)
410 to treat ``:`` in slices as a binary operator with the lowest priority, and to
411 leave an equal amount of space on either side, except if a parameter is omitted
412 (e.g. ``ham[1 + 1 :]``). It also states that for extended slices, both ``:``
413 operators have to have the same amount of spacing, except if a parameter is
414 omitted (``ham[1 + 1 ::]``). *Black* enforces these rules consistently.
415
416 This behaviour may raise ``E203 whitespace before ':'`` warnings in style guide
417 enforcement tools like Flake8. Since ``E203`` is not PEP 8 compliant, you should
418 tell Flake8 to ignore these warnings.
419
420
421 ### Parentheses
422
423 Some parentheses are optional in the Python grammar.  Any expression can
424 be wrapped in a pair of parentheses to form an atom.  There are a few
425 interesting cases:
426
427 - `if (...):`
428 - `while (...):`
429 - `for (...) in (...):`
430 - `assert (...), (...)`
431 - `from X import (...)`
432 - assignments like:
433   - `target = (...)`
434   - `target: type = (...)`
435   - `some, *un, packing = (...)`
436   - `augmented += (...)`
437
438 In those cases, parentheses are removed when the entire statement fits
439 in one line, or if the inner expression doesn't have any delimiters to
440 further split on.  If there is only a single delimiter and the expression
441 starts or ends with a bracket, the parenthesis can also be successfully
442 omitted since the existing bracket pair will organize the expression
443 neatly anyway.  Otherwise, the parentheses are added.
444
445 Please note that *Black* does not add or remove any additional nested
446 parentheses that you might want to have for clarity or further
447 code organization.  For example those parentheses are not going to be
448 removed:
449 ```py3
450 return not (this or that)
451 decision = (maybe.this() and values > 0) or (maybe.that() and values < 0)
452 ```
453
454
455 ### Call chains
456
457 Some popular APIs, like ORMs, use call chaining.  This API style is known
458 as a [fluent interface](https://en.wikipedia.org/wiki/Fluent_interface).
459 *Black* formats those by treating dots that follow a call or an indexing
460 operation like a very low priority delimiter.  It's easier to show the
461 behavior than to explain it.  Look at the example:
462 ```py3
463 def example(session):
464     result = (
465         session.query(models.Customer.id)
466         .filter(
467             models.Customer.account_id == account_id,
468             models.Customer.email == email_address,
469         )
470         .order_by(models.Customer.id.asc())
471         .all()
472     )
473 ```
474
475
476 ### Typing stub files
477
478 PEP 484 describes the syntax for type hints in Python.  One of the
479 use cases for typing is providing type annotations for modules which
480 cannot contain them directly (they might be written in C, or they might
481 be third-party, or their implementation may be overly dynamic, and so on).
482
483 To solve this, [stub files with the `.pyi` file
484 extension](https://www.python.org/dev/peps/pep-0484/#stub-files) can be
485 used to describe typing information for an external module.  Those stub
486 files omit the implementation of classes and functions they
487 describe, instead they only contain the structure of the file (listing
488 globals, functions, and classes with their members).  The recommended
489 code style for those files is more terse than PEP 8:
490
491 * prefer `...` on the same line as the class/function signature;
492 * avoid vertical whitespace between consecutive module-level functions,
493   names, or methods and fields within a single class;
494 * use a single blank line between top-level class definitions, or none
495   if the classes are very small.
496
497 *Black* enforces the above rules.  There are additional guidelines for
498 formatting `.pyi` file that are not enforced yet but might be in
499 a future version of the formatter:
500
501 * all function bodies should be empty (contain `...` instead of the body);
502 * do not use docstrings;
503 * prefer `...` over `pass`;
504 * for arguments with a default, use `...` instead of the actual default;
505 * avoid using string literals in type annotations, stub files support
506   forward references natively (like Python 3.7 code with `from __future__
507   import annotations`);
508 * use variable annotations instead of type comments, even for stubs that
509   target older versions of Python;
510 * for arguments that default to `None`, use `Optional[]` explicitly;
511 * use `float` instead of `Union[int, float]`.
512
513
514 ## pyproject.toml
515
516 *Black* is able to read project-specific default values for its
517 command line options from a `pyproject.toml` file.  This is
518 especially useful for specifying custom `--include` and `--exclude`
519 patterns for your project.
520
521 **Pro-tip**: If you're asking yourself "Do I need to configure anything?"
522 the answer is "No".  *Black* is all about sensible defaults.
523
524
525 ### What on Earth is a `pyproject.toml` file?
526
527 [PEP 518](https://www.python.org/dev/peps/pep-0518/) defines
528 `pyproject.toml` as a configuration file to store build system
529 requirements for Python projects.  With the help of tools
530 like [Poetry](https://poetry.eustace.io/) or
531 [Flit](https://flit.readthedocs.io/en/latest/) it can fully replace the
532 need for `setup.py` and `setup.cfg` files.
533
534
535 ### Where *Black* looks for the file
536
537 By default *Black* looks for `pyproject.toml` starting from the common
538 base directory of all files and directories passed on the command line.
539 If it's not there, it looks in parent directories.  It stops looking
540 when it finds the file, or a `.git` directory, or a `.hg` directory,
541 or the root of the file system, whichever comes first.
542
543 If you're formatting standard input, *Black* will look for configuration
544 starting from the current working directory.
545
546 You can also explicitly specify the path to a particular file that you
547 want with `--config`.  In this situation *Black* will not look for any
548 other file.
549
550 If you're running with `--verbose`, you will see a blue message if
551 a file was found and used.
552
553 Please note `blackd` will not use `pyproject.toml` configuration.
554
555
556 ### Configuration format
557
558 As the file extension suggests, `pyproject.toml` is a [TOML](https://github.com/toml-lang/toml) file.  It contains separate
559 sections for different tools.  *Black* is using the `[tool.black]`
560 section.  The option keys are the same as long names of options on
561 the command line.
562
563 Note that you have to use single-quoted strings in TOML for regular
564 expressions. It's the equivalent of r-strings in Python.  Multiline
565 strings are treated as verbose regular expressions by Black.  Use `[ ]`
566 to denote a significant space character.
567
568 <details>
569 <summary>Example `pyproject.toml`</summary>
570
571 ```toml
572 [tool.black]
573 line-length = 88
574 target_version = ['py37']
575 include = '\.pyi?$'
576 exclude = '''
577
578 (
579   /(
580       \.eggs         # exclude a few common directories in the
581     | \.git          # root of the project
582     | \.hg
583     | \.mypy_cache
584     | \.tox
585     | \.venv
586     | _build
587     | buck-out
588     | build
589     | dist
590   )/
591   | foo.py           # also separately exclude a file named foo.py in
592                      # the root of the project
593 )
594 '''
595 ```
596
597 </details>
598
599 ### Lookup hierarchy
600
601 Command-line options have defaults that you can see in `--help`.
602 A `pyproject.toml` can override those defaults.  Finally, options
603 provided by the user on the command line override both.
604
605 *Black* will only ever use one `pyproject.toml` file during an entire
606 run. It doesn't look for multiple files, and doesn't compose
607 configuration from different levels of the file hierarchy.
608
609
610 ## Editor integration
611
612 ### Emacs
613
614 Use [proofit404/blacken](https://github.com/proofit404/blacken).
615
616
617 ### PyCharm
618
619 1. Install `black`.
620
621 ```console
622 $ pip install black
623 ```
624
625 2. Locate your `black` installation folder.
626
627   On macOS / Linux / BSD:
628
629 ```console
630 $ which black
631 /usr/local/bin/black  # possible location
632 ```
633
634   On Windows:
635
636 ```console
637 $ where black
638 %LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe  # possible location
639 ```
640
641 3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`.
642
643 4. Click the + icon to add a new external tool with the following values:
644     - Name: Black
645     - Description: Black is the uncompromising Python code formatter.
646     - Program: <install_location_from_step_2>
647     - Arguments: `$FilePath$`
648
649 5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
650     - Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap -> External Tools -> External Tools - Black`.
651
652 6. Optionally, run Black on every file save:
653
654     1. Make sure you have the [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin installed.
655     2. Go to `Preferences -> Tools -> File Watchers` and click `+` to add a new watcher:
656         - Name: Black
657         - File type: Python
658         - Scope: Project Files
659         - Program: <install_location_from_step_2>
660         - Arguments: `$FilePath$`
661         - Output paths to refresh: `$FilePath$`
662         - Working directory: `$ProjectFileDir$`
663         - Uncheck "Auto-save edited files to trigger the watcher"
664
665 ### Vim
666
667 Commands and shortcuts:
668
669 * `:Black` to format the entire file (ranges not supported);
670 * `:BlackUpgrade` to upgrade *Black* inside the virtualenv;
671 * `:BlackVersion` to get the current version of *Black* inside the
672   virtualenv.
673
674 Configuration:
675 * `g:black_fast` (defaults to `0`)
676 * `g:black_linelength` (defaults to `88`)
677 * `g:black_skip_string_normalization` (defaults to `0`)
678 * `g:black_virtualenv` (defaults to `~/.vim/black`)
679
680 To install with [vim-plug](https://github.com/junegunn/vim-plug):
681
682 ```
683 Plug 'ambv/black'
684 ```
685
686 or with [Vundle](https://github.com/VundleVim/Vundle.vim):
687
688 ```
689 Plugin 'ambv/black'
690 ```
691
692 or you can copy the plugin from [plugin/black.vim](https://github.com/ambv/black/tree/master/plugin/black.vim).
693 Let me know if this requires any changes to work with Vim 8's builtin
694 `packadd`, or Pathogen, and so on.
695
696 This plugin **requires Vim 7.0+ built with Python 3.6+ support**.  It
697 needs Python 3.6 to be able to run *Black* inside the Vim process which
698 is much faster than calling an external command.
699
700 On first run, the plugin creates its own virtualenv using the right
701 Python version and automatically installs *Black*. You can upgrade it later
702 by calling `:BlackUpgrade` and restarting Vim.
703
704 If you need to do anything special to make your virtualenv work and
705 install *Black* (for example you want to run a version from master),
706 create a virtualenv manually and point `g:black_virtualenv` to it.
707 The plugin will use it.
708
709 To run *Black* on save, add the following line to `.vimrc` or `init.vim`:
710
711 ```
712 autocmd BufWritePre *.py execute ':Black'
713 ```
714
715 **How to get Vim with Python 3.6?**
716 On Ubuntu 17.10 Vim comes with Python 3.6 by default.
717 On macOS with Homebrew run: `brew install vim --with-python3`.
718 When building Vim from source, use:
719 `./configure --enable-python3interp=yes`. There's many guides online how
720 to do this.
721
722
723 ### Visual Studio Code
724
725 Use the [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
726 ([instructions](https://code.visualstudio.com/docs/python/editing#_formatting)).
727
728
729 ### SublimeText 3
730
731 Use [sublack plugin](https://github.com/jgirardet/sublack).
732
733
734 ### Jupyter Notebook Magic
735
736 Use [blackcellmagic](https://github.com/csurfer/blackcellmagic).
737
738
739 ### Python Language Server
740
741 If your editor supports the [Language Server Protocol](https://langserver.org/)
742 (Atom, Sublime Text, Visual Studio Code and many more), you can use
743 the [Python Language Server](https://github.com/palantir/python-language-server) with the
744 [pyls-black](https://github.com/rupert/pyls-black) plugin.
745
746
747 ### Atom/Nuclide
748
749 Use [python-black](https://atom.io/packages/python-black).
750
751
752 ### Other editors
753
754 Other editors will require external contributions.
755
756 Patches welcome! ✨ 🍰 ✨
757
758 Any tool that can pipe code through *Black* using its stdio mode (just
759 [use `-` as the file name](https://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)).
760 The formatted code will be returned on stdout (unless `--check` was
761 passed).  *Black* will still emit messages on stderr but that shouldn't
762 affect your use case.
763
764 This can be used for example with PyCharm's [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).
765
766 ## blackd
767
768 `blackd` is a small HTTP server that exposes *Black*'s functionality over
769 a simple protocol. The main benefit of using it is to avoid paying the
770 cost of starting up a new *Black* process every time you want to blacken
771 a file.
772
773 ### Usage
774
775 `blackd` is not packaged alongside *Black* by default because it has additional
776 dependencies. You will need to do `pip install black[d]` to install it.
777
778 You can start the server on the default port, binding only to the local interface
779 by running `blackd`. You will see a single line mentioning the server's version,
780 and the host and port it's listening on. `blackd` will then print an access log
781 similar to most web servers on standard output, merged with any exception traces
782 caused by invalid formatting requests.
783
784 `blackd` provides even less options than *Black*. You can see them by running
785 `blackd --help`:
786
787 ```text
788 Usage: blackd [OPTIONS]
789
790 Options:
791   --bind-host TEXT                Address to bind the server to.
792   --bind-port INTEGER             Port to listen on
793   --version                       Show the version and exit.
794   -h, --help                      Show this message and exit.
795 ```
796
797 ### Protocol
798
799 `blackd` only accepts `POST` requests at the `/` path. The body of the request
800 should contain the python source code to be formatted, encoded
801 according to the `charset` field in the `Content-Type` request header. If no
802 `charset` is specified, `blackd` assumes `UTF-8`.
803
804 There are a few HTTP headers that control how the source is formatted. These
805 correspond to command line flags for *Black*. There is one exception to this:
806 `X-Protocol-Version` which if present, should have the value `1`, otherwise the
807 request is rejected with `HTTP 501` (Not Implemented).
808
809 The headers controlling how code is formatted are:
810
811  - `X-Line-Length`: corresponds to the `--line-length` command line flag.
812  - `X-Skip-String-Normalization`: corresponds to the `--skip-string-normalization`
813     command line flag. If present and its value is not the empty string, no string
814     normalization will be performed.
815  - `X-Fast-Or-Safe`: if set to `fast`, `blackd` will act as *Black* does when
816     passed the `--fast` command line flag.
817  - `X-Python-Variant`: if set to `pyi`, `blackd` will act as *Black* does when
818     passed the `--pyi` command line flag. Otherwise, its value must correspond to
819     a Python version or a set of comma-separated Python versions, optionally
820     prefixed with `py`. For example, to request code that is compatible
821     with Python 3.5 and 3.6, set the header to `py3.5,py3.6`.
822
823 If any of these headers are set to invalid values, `blackd` returns a `HTTP 400`
824 error response, mentioning the name of the problematic header in the message body.
825
826 Apart from the above, `blackd` can produce the following response codes:
827
828  - `HTTP 204`: If the input is already well-formatted. The response body is
829         empty.
830  - `HTTP 200`: If formatting was needed on the input. The response body
831         contains the blackened Python code, and the `Content-Type` header is set
832         accordingly.
833  - `HTTP 400`: If the input contains a syntax error. Details of the error are
834         returned in the response body.
835  - `HTTP 500`: If there was any kind of error while trying to format the input.
836         The response body contains a textual representation of the error.
837
838 ## Version control integration
839
840 Use [pre-commit](https://pre-commit.com/). Once you [have it
841 installed](https://pre-commit.com/#install), add this to the
842 `.pre-commit-config.yaml` in your repository:
843 ```yaml
844 repos:
845 -   repo: https://github.com/ambv/black
846     rev: stable
847     hooks:
848     - id: black
849       language_version: python3.6
850 ```
851 Then run `pre-commit install` and you're ready to go.
852
853 Avoid using `args` in the hook.  Instead, store necessary configuration
854 in `pyproject.toml` so that editors and command-line usage of Black all
855 behave consistently for your project.  See *Black*'s own `pyproject.toml`
856 for an example.
857
858 If you're already using Python 3.7, switch the `language_version`
859 accordingly. Finally, `stable` is a tag that is pinned to the latest
860 release on PyPI.  If you'd rather run on master, this is also an option.
861
862
863 ## Ignoring unmodified files
864
865 *Black* remembers files it has already formatted, unless the `--diff` flag is used or
866 code is passed via standard input. This information is stored per-user. The exact
867 location of the file depends on the *Black* version and the system on which *Black*
868 is run. The file is non-portable. The standard location on common operating systems
869 is:
870
871 * Windows: `C:\\Users\<username>\AppData\Local\black\black\Cache\<version>\cache.<line-length>.<file-mode>.pickle`
872 * macOS: `/Users/<username>/Library/Caches/black/<version>/cache.<line-length>.<file-mode>.pickle`
873 * Linux: `/home/<username>/.cache/black/<version>/cache.<line-length>.<file-mode>.pickle`
874
875 `file-mode` is an int flag that determines whether the file was formatted as 3.6+ only,
876 as .pyi, and whether string normalization was omitted.
877
878
879 ## Testimonials
880
881 **Dusty Phillips**, [writer](https://smile.amazon.com/s/ref=nb_sb_noss?url=search-alias%3Daps&field-keywords=dusty+phillips):
882
883 > *Black* is opinionated so you don't have to be.
884
885 **Hynek Schlawack**, [creator of `attrs`](https://www.attrs.org/), core
886 developer of Twisted and CPython:
887
888 > An auto-formatter that doesn't suck is all I want for Xmas!
889
890 **Carl Meyer**, [Django](https://www.djangoproject.com/) core developer:
891
892 > At least the name is good.
893
894 **Kenneth Reitz**, creator of [`requests`](http://python-requests.org/)
895 and [`pipenv`](https://docs.pipenv.org/):
896
897 > This vastly improves the formatting of our code. Thanks a ton!
898
899
900 ## Show your style
901
902 Use the badge in your project's README.md:
903
904 ```markdown
905 [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
906 ```
907
908 Using the badge in README.rst:
909 ```
910 .. image:: https://img.shields.io/badge/code%20style-black-000000.svg
911     :target: https://github.com/ambv/black
912 ```
913
914 Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black)
915
916
917 ## License
918
919 MIT
920
921
922 ## Contributing to *Black*
923
924 In terms of inspiration, *Black* is about as configurable as *gofmt*.
925 This is deliberate.
926
927 Bug reports and fixes are always welcome!  However, before you suggest a
928 new feature or configuration knob, ask yourself why you want it.  If it
929 enables better integration with some workflow, fixes an inconsistency,
930 speeds things up, and so on - go for it!  On the other hand, if your
931 answer is "because I don't like a particular formatting" then you're not
932 ready to embrace *Black* yet. Such changes are unlikely to get accepted.
933 You can still try but prepare to be disappointed.
934
935 More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
936
937
938 ## Change Log
939
940 ### 19.3b0
941
942 * new option `--target-version` to control which Python versions
943   *Black*-formatted code should target (#618)
944
945 * removed `--py36` (use `--target-version=py36` instead) (#724)
946
947 * *Black* no longer normalizes numeric literals to include `_` separators (#696)
948
949 * long `del` statements are now split into multiple lines (#698)
950
951 * improved performance of formatting deeply nested data structures (#509)
952
953 * `blackd` now supports CORS (#622)
954
955 ### 18.9b0
956
957 * numeric literals are now formatted by *Black* (#452, #461, #464, #469):
958
959   * numeric literals are normalized to include `_` separators on Python 3.6+ code
960
961   * added `--skip-numeric-underscore-normalization` to disable the above behavior and
962     leave numeric underscores as they were in the input
963
964   * code with `_` in numeric literals is recognized as Python 3.6+
965
966   * most letters in numeric literals are lowercased (e.g., in `1e10`, `0x01`)
967
968   * hexadecimal digits are always uppercased (e.g. `0xBADC0DE`)
969
970 * added `blackd`, see [its documentation](#blackd) for more info (#349)
971
972 * adjacent string literals are now correctly split into multiple lines (#463)
973
974 * trailing comma is now added to single imports that don't fit on a line (#250)
975
976 * cache is now populated when `--check` is successful for a file which speeds up
977   consecutive checks of properly formatted unmodified files (#448)
978
979 * whitespace at the beginning of the file is now removed (#399)
980
981 * fixed mangling [pweave](http://mpastell.com/pweave/) and
982   [Spyder IDE](https://pythonhosted.org/spyder/) special comments (#532)
983
984 * fixed unstable formatting when unpacking big tuples (#267)
985
986 * fixed parsing of `__future__` imports with renames (#389)
987
988 * fixed scope of `# fmt: off` when directly preceding `yield` and other nodes (#385)
989
990 * fixed formatting of lambda expressions with default arguments (#468)
991
992 * fixed ``async for`` statements: *Black* no longer breaks them into separate
993   lines (#372)
994
995 * note: the Vim plugin stopped registering ``,=`` as a default chord as it turned out
996   to be a bad idea (#415)
997
998
999 ### 18.6b4
1000
1001 * hotfix: don't freeze when multiple comments directly precede `# fmt: off` (#371)
1002
1003
1004 ### 18.6b3
1005
1006 * typing stub files (`.pyi`) now have blank lines added after constants (#340)
1007
1008 * `# fmt: off` and `# fmt: on` are now much more dependable:
1009
1010   * they now work also within bracket pairs (#329)
1011
1012   * they now correctly work across function/class boundaries (#335)
1013
1014   * they now work when an indentation block starts with empty lines or misaligned
1015     comments (#334)
1016
1017 * made Click not fail on invalid environments; note that Click is right but the
1018   likelihood we'll need to access non-ASCII file paths when dealing with Python source
1019   code is low (#277)
1020
1021 * fixed improper formatting of f-strings with quotes inside interpolated
1022   expressions (#322)
1023
1024 * fixed unnecessary slowdown when long list literals where found in a file
1025
1026 * fixed unnecessary slowdown on AST nodes with very many siblings
1027
1028 * fixed cannibalizing backslashes during string normalization
1029
1030 * fixed a crash due to symbolic links pointing outside of the project directory (#338)
1031
1032
1033 ### 18.6b2
1034
1035 * added `--config` (#65)
1036
1037 * added `-h` equivalent to `--help` (#316)
1038
1039 * fixed improper unmodified file caching when `-S` was used
1040
1041 * fixed extra space in string unpacking (#305)
1042
1043 * fixed formatting of empty triple quoted strings (#313)
1044
1045 * fixed unnecessary slowdown in comment placement calculation on lines without
1046   comments
1047
1048
1049 ### 18.6b1
1050
1051 * hotfix: don't output human-facing information on stdout (#299)
1052
1053 * hotfix: don't output cake emoji on non-zero return code (#300)
1054
1055
1056 ### 18.6b0
1057
1058 * added `--include` and `--exclude` (#270)
1059
1060 * added `--skip-string-normalization` (#118)
1061
1062 * added `--verbose` (#283)
1063
1064 * the header output in `--diff` now actually conforms to the unified diff spec
1065
1066 * fixed long trivial assignments being wrapped in unnecessary parentheses (#273)
1067
1068 * fixed unnecessary parentheses when a line contained multiline strings (#232)
1069
1070 * fixed stdin handling not working correctly if an old version of Click was
1071   used (#276)
1072
1073 * *Black* now preserves line endings when formatting a file in place (#258)
1074
1075
1076 ### 18.5b1
1077
1078 * added `--pyi` (#249)
1079
1080 * added `--py36` (#249)
1081
1082 * Python grammar pickle caches are stored with the formatting caches, making
1083   *Black* work in environments where site-packages is not user-writable (#192)
1084
1085 * *Black* now enforces a PEP 257 empty line after a class-level docstring
1086   (and/or fields) and the first method
1087
1088 * fixed invalid code produced when standalone comments were present in a trailer
1089   that was omitted from line splitting on a large expression (#237)
1090
1091 * fixed optional parentheses being removed within `# fmt: off` sections (#224)
1092
1093 * fixed invalid code produced when stars in very long imports were incorrectly
1094   wrapped in optional parentheses (#234)
1095
1096 * fixed unstable formatting when inline comments were moved around in
1097   a trailer that was omitted from line splitting on a large expression
1098   (#238)
1099
1100 * fixed extra empty line between a class declaration and the first
1101   method if no class docstring or fields are present (#219)
1102
1103 * fixed extra empty line between a function signature and an inner
1104   function or inner class (#196)
1105
1106
1107 ### 18.5b0
1108
1109 * call chains are now formatted according to the
1110   [fluent interfaces](https://en.wikipedia.org/wiki/Fluent_interface)
1111   style (#67)
1112
1113 * data structure literals (tuples, lists, dictionaries, and sets) are
1114   now also always exploded like imports when they don't fit in a single
1115   line (#152)
1116
1117 * slices are now formatted according to PEP 8 (#178)
1118
1119 * parentheses are now also managed automatically on the right-hand side
1120   of assignments and return statements (#140)
1121
1122 * math operators now use their respective priorities for delimiting multiline
1123   expressions (#148)
1124
1125 * optional parentheses are now omitted on expressions that start or end
1126   with a bracket and only contain a single operator (#177)
1127
1128 * empty parentheses in a class definition are now removed (#145, #180)
1129
1130 * string prefixes are now standardized to lowercase and `u` is removed
1131   on Python 3.6+ only code and Python 2.7+ code with the `unicode_literals`
1132   future import (#188, #198, #199)
1133
1134 * typing stub files (`.pyi`) are now formatted in a style that is consistent
1135   with PEP 484 (#207, #210)
1136
1137 * progress when reformatting many files is now reported incrementally
1138
1139 * fixed trailers (content with brackets) being unnecessarily exploded
1140   into their own lines after a dedented closing bracket (#119)
1141
1142 * fixed an invalid trailing comma sometimes left in imports (#185)
1143
1144 * fixed non-deterministic formatting when multiple pairs of removable parentheses
1145   were used (#183)
1146
1147 * fixed multiline strings being unnecessarily wrapped in optional
1148   parentheses in long assignments (#215)
1149
1150 * fixed not splitting long from-imports with only a single name
1151
1152 * fixed Python 3.6+ file discovery by also looking at function calls with
1153   unpacking. This fixed non-deterministic formatting if trailing commas
1154   where used both in function signatures with stars and function calls
1155   with stars but the former would be reformatted to a single line.
1156
1157 * fixed crash on dealing with optional parentheses (#193)
1158
1159 * fixed "is", "is not", "in", and "not in" not considered operators for
1160   splitting purposes
1161
1162 * fixed crash when dead symlinks where encountered
1163
1164
1165 ### 18.4a4
1166
1167 * don't populate the cache on `--check` (#175)
1168
1169
1170 ### 18.4a3
1171
1172 * added a "cache"; files already reformatted that haven't changed on disk
1173   won't be reformatted again (#109)
1174
1175 * `--check` and `--diff` are no longer mutually exclusive (#149)
1176
1177 * generalized star expression handling, including double stars; this
1178   fixes multiplication making expressions "unsafe" for trailing commas (#132)
1179
1180 * *Black* no longer enforces putting empty lines behind control flow statements
1181   (#90)
1182
1183 * *Black* now splits imports like "Mode 3 + trailing comma" of isort (#127)
1184
1185 * fixed comment indentation when a standalone comment closes a block (#16, #32)
1186
1187 * fixed standalone comments receiving extra empty lines if immediately preceding
1188   a class, def, or decorator (#56, #154)
1189
1190 * fixed `--diff` not showing entire path (#130)
1191
1192 * fixed parsing of complex expressions after star and double stars in
1193   function calls (#2)
1194
1195 * fixed invalid splitting on comma in lambda arguments (#133)
1196
1197 * fixed missing splits of ternary expressions (#141)
1198
1199
1200 ### 18.4a2
1201
1202 * fixed parsing of unaligned standalone comments (#99, #112)
1203
1204 * fixed placement of dictionary unpacking inside dictionary literals (#111)
1205
1206 * Vim plugin now works on Windows, too
1207
1208 * fixed unstable formatting when encountering unnecessarily escaped quotes
1209   in a string (#120)
1210
1211
1212 ### 18.4a1
1213
1214 * added `--quiet` (#78)
1215
1216 * added automatic parentheses management (#4)
1217
1218 * added [pre-commit](https://pre-commit.com) integration (#103, #104)
1219
1220 * fixed reporting on `--check` with multiple files (#101, #102)
1221
1222 * fixed removing backslash escapes from raw strings (#100, #105)
1223
1224
1225 ### 18.4a0
1226
1227 * added `--diff` (#87)
1228
1229 * add line breaks before all delimiters, except in cases like commas, to
1230   better comply with PEP 8 (#73)
1231
1232 * standardize string literals to use double quotes (almost) everywhere
1233   (#75)
1234
1235 * fixed handling of standalone comments within nested bracketed
1236   expressions; *Black* will no longer produce super long lines or put all
1237   standalone comments at the end of the expression (#22)
1238
1239 * fixed 18.3a4 regression: don't crash and burn on empty lines with
1240   trailing whitespace (#80)
1241
1242 * fixed 18.3a4 regression: `# yapf: disable` usage as trailing comment
1243   would cause *Black* to not emit the rest of the file (#95)
1244
1245 * when CTRL+C is pressed while formatting many files, *Black* no longer
1246   freaks out with a flurry of asyncio-related exceptions
1247
1248 * only allow up to two empty lines on module level and only single empty
1249   lines within functions (#74)
1250
1251
1252 ### 18.3a4
1253
1254 * `# fmt: off` and `# fmt: on` are implemented (#5)
1255
1256 * automatic detection of deprecated Python 2 forms of print statements
1257   and exec statements in the formatted file (#49)
1258
1259 * use proper spaces for complex expressions in default values of typed
1260   function arguments (#60)
1261
1262 * only return exit code 1 when --check is used (#50)
1263
1264 * don't remove single trailing commas from square bracket indexing
1265   (#59)
1266
1267 * don't omit whitespace if the previous factor leaf wasn't a math
1268   operator (#55)
1269
1270 * omit extra space in kwarg unpacking if it's the first argument (#46)
1271
1272 * omit extra space in [Sphinx auto-attribute comments](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#directive-autoattribute)
1273   (#68)
1274
1275
1276 ### 18.3a3
1277
1278 * don't remove single empty lines outside of bracketed expressions
1279   (#19)
1280
1281 * added ability to pipe formatting from stdin to stdin (#25)
1282
1283 * restored ability to format code with legacy usage of `async` as
1284   a name (#20, #42)
1285
1286 * even better handling of numpy-style array indexing (#33, again)
1287
1288
1289 ### 18.3a2
1290
1291 * changed positioning of binary operators to occur at beginning of lines
1292   instead of at the end, following [a recent change to PEP 8](https://github.com/python/peps/commit/c59c4376ad233a62ca4b3a6060c81368bd21e85b)
1293   (#21)
1294
1295 * ignore empty bracket pairs while splitting. This avoids very weirdly
1296   looking formattings (#34, #35)
1297
1298 * remove a trailing comma if there is a single argument to a call
1299
1300 * if top level functions were separated by a comment, don't put four
1301   empty lines after the upper function
1302
1303 * fixed unstable formatting of newlines with imports
1304
1305 * fixed unintentional folding of post scriptum standalone comments
1306   into last statement if it was a simple statement (#18, #28)
1307
1308 * fixed missing space in numpy-style array indexing (#33)
1309
1310 * fixed spurious space after star-based unary expressions (#31)
1311
1312
1313 ### 18.3a1
1314
1315 * added `--check`
1316
1317 * only put trailing commas in function signatures and calls if it's
1318   safe to do so. If the file is Python 3.6+ it's always safe, otherwise
1319   only safe if there are no `*args` or `**kwargs` used in the signature
1320   or call. (#8)
1321
1322 * fixed invalid spacing of dots in relative imports (#6, #13)
1323
1324 * fixed invalid splitting after comma on unpacked variables in for-loops
1325   (#23)
1326
1327 * fixed spurious space in parenthesized set expressions (#7)
1328
1329 * fixed spurious space after opening parentheses and in default
1330   arguments (#14, #17)
1331
1332 * fixed spurious space after unary operators when the operand was
1333   a complex expression (#15)
1334
1335
1336 ### 18.3a0
1337
1338 * first published version, Happy 🍰 Day 2018!
1339
1340 * alpha quality
1341
1342 * date-versioned (see: https://calver.org/)
1343
1344
1345 ## Authors
1346
1347 Glued together by [Łukasz Langa](mailto:lukasz@langa.pl).
1348
1349 Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
1350 [Carl Meyer](mailto:carl@oddbird.net),
1351 [Jelle Zijlstra](mailto:jelle.zijlstra@gmail.com),
1352 [Mika Naylor](mailto:mail@autophagy.io), and
1353 [Zsolt Dollenstein](mailto:zsol.zsol@gmail.com).
1354
1355 Multiple contributions by:
1356 * [Anthony Sottile](mailto:asottile@umich.edu)
1357 * [Artem Malyshev](mailto:proofit404@gmail.com)
1358 * [Christian Heimes](mailto:christian@python.org)
1359 * [Daniel M. Capella](mailto:polycitizen@gmail.com)
1360 * [Eli Treuherz](mailto:eli@treuherz.com)
1361 * hauntsaninja
1362 * Hugo van Kemenade
1363 * [Ivan Katanić](mailto:ivan.katanic@gmail.com)
1364 * [Jonas Obrist](mailto:ojiidotch@gmail.com)
1365 * [Luka Sterbic](mailto:luka.sterbic@gmail.com)
1366 * [Miguel Gaiowski](mailto:miggaiowski@gmail.com)
1367 * [Miroslav Shubernetskiy](mailto:miroslav@miki725.com)
1368 * [Neraste](mailto:neraste.herr10@gmail.com)
1369 * [Osaetin Daniel](mailto:osaetindaniel@gmail.com)
1370 * [Peter Bengtsson](mailto:mail@peterbe.com)
1371 * [Stavros Korokithakis](mailto:hi@stavros.io)
1372 * [Sunil Kapil](mailto:snlkapil@gmail.com)
1373 * [Vishwas B Sharma](mailto:sharma.vishwas88@gmail.com)
1374 * [Chuck Wooters](mailto:chuck.wooters@microsoft.com)