X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/129ebd53a66b4a8069321742aeecfafb44c76fd9..77b6ed1b70bd07f058bc551906bc880022847964:/README.md?ds=sidebyside
diff --git a/README.md b/README.md
index 2574c55..ddb160d 100644
--- a/README.md
+++ b/README.md
@@ -1,14 +1,14 @@
-
+
The Uncompromising Code Formatter
-
+
-
-
+
+
-
+
> âAny color you like.â
@@ -28,6 +28,7 @@ content instead.
possible.
Try it out now using the [Black Playground](https://black.now.sh).
+Watch the [PyCon 2019 talk](https://youtu.be/esZLCuWs_2Y) to learn more.
---
@@ -38,6 +39,7 @@ Try it out now using the [Black Playground](https://black.now.sh).
**[blackd](#blackd)** |
**[Version control integration](#version-control-integration)** |
**[Ignoring unmodified files](#ignoring-unmodified-files)** |
+**[Used by](#used-by)** |
**[Testimonials](#testimonials)** |
**[Show your style](#show-your-style)** |
**[Contributing](#contributing-to-black)** |
@@ -71,6 +73,7 @@ black {source_file_or_directory}
black [OPTIONS] [SRC]...
Options:
+ -c, --code TEXT Format the code passed in as a string.
-l, --line-length INTEGER How many characters per line to allow.
[default: 88]
-t, --target-version [py27|py33|py34|py35|py36|py37|py38]
@@ -136,7 +139,7 @@ Options:
### NOTE: This is a beta product
-*Black* is already successfully used by several projects, small and big.
+*Black* is already [successfully used](#used-by) by many projects, small and big.
It also sports a decent test suite. However, it is still very new.
Things will probably be wonky for a while. This is made explicit by the
"Beta" trove classifier, as well as by the "b" in the version number.
@@ -290,7 +293,7 @@ you are probably already using. You'd do it like this:
max-line-length = 80
...
select = C,E,F,W,B,B950
-ignore = E501
+ignore = E501,W503,E203
```
You'll find *Black*'s own .flake8 config file is configured like this.
@@ -370,7 +373,7 @@ The main reason to standardize on a single form of quotes is aesthetics.
Having one kind of quotes everywhere reduces reader distraction.
It will also enable a future version of *Black* to merge consecutive
string literals that ended up on the same line (see
-[#26](https://github.com/ambv/black/issues/26) for details).
+[#26](https://github.com/psf/black/issues/26) for details).
Why settle on double quotes? They anticipate apostrophes in English
text. They match the docstring standard described in [PEP 257](https://www.python.org/dev/peps/pep-0257/#what-is-a-docstring).
@@ -577,7 +580,7 @@ to denote a significant space character.
```toml
[tool.black]
line-length = 88
-target_version = ['py37']
+target-version = ['py37']
include = '\.pyi?$'
exclude = '''
@@ -617,7 +620,8 @@ configuration from different levels of the file hierarchy.
### Emacs
-Use [proofit404/blacken](https://github.com/proofit404/blacken).
+Use [proofit404/blacken](https://github.com/proofit404/blacken) or
+[Elpy](https://github.com/jorgenschaefer/elpy).
### PyCharm/IntelliJ IDEA
@@ -647,11 +651,11 @@ $ where black
3. Open External tools in PyCharm/IntelliJ IDEA
On macOS:
-
+
```PyCharm -> Preferences -> Tools -> External Tools```
On Windows / Linux / BSD:
-
+
```File -> Settings -> Tools -> External Tools```
4. Click the + icon to add a new external tool with the following values:
@@ -663,7 +667,7 @@ $ where black
5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
- Alternatively, you can set a keyboard shortcut by navigating to `Preferences or Settings -> Keymap -> External Tools -> External Tools - Black`.
-6. Optionally, run Black on every file save:
+6. Optionally, run *Black* on every file save:
1. Make sure you have the [File Watcher](https://plugins.jetbrains.com/plugin/7177-file-watchers) plugin installed.
2. Go to `Preferences or Settings -> Tools -> File Watchers` and click `+` to add a new watcher:
@@ -676,6 +680,38 @@ $ where black
- Working directory: `$ProjectFileDir$`
- Uncheck "Auto-save edited files to trigger the watcher"
+
+
+### Wing IDE
+
+Wing supports black via the OS Commands tool, as explained in the Wing documentation on [pep8 formatting](https://wingware.com/doc/edit/pep8). The detailed procedure is:
+
+1. Install `black`.
+
+```console
+$ pip install black
+```
+
+2. Make sure it runs from the command line, e.g.
+
+```console
+$ black --help
+```
+
+3. In Wing IDE, activate the **OS Commands** panel and define the command **black** to execute black on the currently selected file:
+
+- Use the Tools -> OS Commands menu selection
+- click on **+** in **OS Commands** -> New: Command line..
+ - Title: black
+ - Command Line: black %s
+ - I/O Encoding: Use Default
+ - Key Binding: F1
+ - [x] Raise OS Commands when executed
+ - [x] Auto-save files before execution
+ - [x] Line mode
+
+4. Select a file in the editor and press **F1** , or whatever key binding you selected in step 3, to reformat the file.
+
### Vim
Commands and shortcuts:
@@ -694,16 +730,16 @@ Configuration:
To install with [vim-plug](https://github.com/junegunn/vim-plug):
```
-Plug 'ambv/black'
+Plug 'python/black'
```
or with [Vundle](https://github.com/VundleVim/Vundle.vim):
```
-Plugin 'ambv/black'
+Plugin 'python/black'
```
-or you can copy the plugin from [plugin/black.vim](https://github.com/ambv/black/tree/master/plugin/black.vim).
+or you can copy the plugin from [plugin/black.vim](https://github.com/psf/black/tree/master/plugin/black.vim).
Let me know if this requires any changes to work with Vim 8's builtin
`packadd`, or Pathogen, and so on.
@@ -808,6 +844,14 @@ Options:
-h, --help Show this message and exit.
```
+There is no official blackd client tool (yet!). You can test that blackd is
+working using `curl`:
+
+```
+blackd --bind-port 9090 & # or let blackd choose a port
+curl -s -XPOST "localhost:9090" -d "print('valid')"
+```
+
### Protocol
`blackd` only accepts `POST` requests at the `/` path. The body of the request
@@ -856,7 +900,7 @@ installed](https://pre-commit.com/#install), add this to the
`.pre-commit-config.yaml` in your repository:
```yaml
repos:
-- repo: https://github.com/ambv/black
+- repo: https://github.com/psf/black
rev: stable
hooks:
- id: black
@@ -866,7 +910,7 @@ Then run `pre-commit install` and you're ready to go.
Avoid using `args` in the hook. Instead, store necessary configuration
in `pyproject.toml` so that editors and command-line usage of Black all
-behave consistently for your project. See *Black*'s own `pyproject.toml`
+behave consistently for your project. See *Black*'s own [pyproject.toml](/pyproject.toml)
for an example.
If you're already using Python 3.7, switch the `language_version`
@@ -889,6 +933,20 @@ is:
`file-mode` is an int flag that determines whether the file was formatted as 3.6+ only,
as .pyi, and whether string normalization was omitted.
+To override the location of these files on macOS or Linux, set the environment variable
+`XDG_CACHE_HOME` to your preferred location. For example, if you want to put the cache in
+the directory you're running *Black* from, set `XDG_CACHE_HOME=.cache`. *Black* will then
+write the above files to `.cache/black//`.
+
+## Used by
+
+The following notable open-source projects trust *Black* with enforcing
+a consistent code style: pytest, tox, Pyramid, Django Channels, Hypothesis,
+attrs, SQLAlchemy, Poetry, PyPA applications (Warehouse, Pipenv, virtualenv),
+every Datadog Agent Integration.
+
+Are we missing anyone? Let us know.
+
## Testimonials
@@ -916,16 +974,16 @@ and [`pipenv`](https://docs.pipenv.org/):
Use the badge in your project's README.md:
```markdown
-[](https://github.com/ambv/black)
+[](https://github.com/psf/black)
```
Using the badge in README.rst:
```
.. image:: https://img.shields.io/badge/code%20style-black-000000.svg
- :target: https://github.com/ambv/black
+ :target: https://github.com/psf/black
```
-Looks like this: [](https://github.com/ambv/black)
+Looks like this: [](https://github.com/psf/black)
## License
@@ -951,6 +1009,43 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
## Change Log
+### unreleased
+
+* added `black -c` as a way to format code passed from the command line
+ (#761)
+
+* --safe now works with Python 2 code (#840)
+
+* fixed grammar selection for Python 2-specific code (#765)
+
+* fixed feature detection for trailing commas in function definitions
+ and call sites (#763)
+
+* *Black* can now format async generators (#593)
+
+* *Black* no longer crashes on Windows machines with more than 61 cores
+ (#838)
+
+* *Black* no longer crashes on standalone comments prepended with
+ a backslash (#767)
+
+* *Black* no longer crashes on `from` ... `import` blocks with comments
+ (#829)
+
+* removed unnecessary parentheses around `yield` expressions (#834)
+
+* added parentheses around long tuples in unpacking assignments (#832)
+
+* fixed bug that led *Black* format some code with a line length target
+ of 1 (#762)
+
+* *Black* no longer introduces quotes in f-string subexpressions on string
+ boundaries (#863)
+
+* if *Black* puts parenthesis around a single expression, it moves comments
+ to the wrapped expression instead of after the brackets (#872)
+
+
### 19.3b0
* new option `--target-version` to control which Python versions
@@ -977,6 +1072,7 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md).
* `blackd` now supports CORS (#622)
+
### 18.9b0
* numeric literals are now formatted by *Black* (#452, #461, #464, #469):
@@ -1380,12 +1476,14 @@ Maintained with [Carol Willing](mailto:carolcode@willingconsulting.com),
Multiple contributions by:
* [Anthony Sottile](mailto:asottile@umich.edu)
* [Artem Malyshev](mailto:proofit404@gmail.com)
+* [Benjamin Woodruff](mailto:github@benjam.info)
* [Christian Heimes](mailto:christian@python.org)
* [Daniel M. Capella](mailto:polycitizen@gmail.com)
* [Eli Treuherz](mailto:eli@treuherz.com)
* hauntsaninja
* Hugo van Kemenade
* [Ivan KataniÄ](mailto:ivan.katanic@gmail.com)
+* [Jason Fried](mailto:me@jasonfried.info)
* [Jonas Obrist](mailto:ojiidotch@gmail.com)
* [Luka Sterbic](mailto:luka.sterbic@gmail.com)
* [Miguel Gaiowski](mailto:miggaiowski@gmail.com)