X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/475179a53af1948ca726de1b11d4cdbe2aa90e58..5c6a0dd03f7f6d8694d1b9a62f9770be44f0b809:/README.md?ds=inline diff --git a/README.md b/README.md index 5d3b118..d74d436 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,16 @@ -# black +![Black Logo](https://raw.githubusercontent.com/ambv/black/master/docs/_static/logo2-readme.png) +

The Uncompromising Code Formatter

-[![Build Status](https://travis-ci.org/ambv/black.svg?branch=master)](https://travis-ci.org/ambv/black) ![License: MIT](https://img.shields.io/github/license/ambv/black.svg) ![PyPI](https://img.shields.io/pypi/v/black.svg) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) +

+Build Status +Documentation Status +Coverage Status +License: MIT +PyPI +Code style: black +

-> Any color you like. +> “Any color you like.” *Black* is the uncompromising Python code formatter. By using it, you @@ -34,9 +42,16 @@ original. This slows it down. If you're feeling confident, use ``--fast``. +## Installation + +*Black* can be installed by running `pip install black`. It requires +Python 3.6.0+ to run but you can reformat Python 2 code with it, too. +*Black* is able to parse all of the new syntax supported on Python 3.6 +but also *effectively all* the Python 2 syntax at the same time. + + ## Usage -*Black* can be installed by running `pip install black`. ``` black [OPTIONS] [SRC]... @@ -54,7 +69,7 @@ Options: --help Show this message and exit. ``` -`Black` is a well-behaved Unix-style command-line tool: +*Black* is a well-behaved Unix-style command-line tool: * it does nothing if no sources are passed to it; * it will read from standard input and write to standard output if `-` is used as the filename; @@ -216,6 +231,7 @@ body. ### Editor integration * Visual Studio Code: [joslarson.black-vscode](https://marketplace.visualstudio.com/items?itemName=joslarson.black-vscode) +* Emacs: [proofit404/blacken](https://github.com/proofit404/blacken) Any tool that can pipe code through *Black* using its stdio mode (just [use `-` as the file name](http://www.tldp.org/LDP/abs/html/special-chars.html#DASHREF2)). @@ -223,9 +239,8 @@ The formatted code will be returned on stdout (unless `--check` was passed). *Black* will still emit messages on stderr but that shouldn't affect your use case. -There is currently no integration with any other text editors. Vim and -Atom/Nuclide integration is planned by the author, others will require -external contributions. +Vim and Atom/Nuclide integration is planned by the author, others will +require external contributions. Patches welcome! ✨ 🍰 ✨ @@ -262,27 +277,6 @@ Use the badge in your project's README.md: Looks like this: [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/ambv/black) - -## Tests - -Just run: - -``` -python setup.py test -``` - -## This tool requires Python 3.6.0+ to run - -But you can reformat Python 2 code with it, too. *Black* is able to parse -all of the new syntax supported on Python 3.6 but also *effectively all* -the Python 2 syntax at the same time. - -By making the code exclusively Python 3.6+, I'm able to focus on the -quality of the formatting and re-use all the nice features of the new -releases (check out [pathlib](https://docs.python.org/3/library/pathlib.html) or -f-strings) instead of wasting cycles on Unicode compatibility, and so on. - - ## License MIT @@ -306,7 +300,9 @@ More details can be found in [CONTRIBUTING](CONTRIBUTING.md). ## Change Log -### 18.3a4 (unreleased) +### 18.3a4 + +* `# fmt: off` and `# fmt: on` are implemented (#5) * automatic detection of deprecated Python 2 forms of print statements and exec statements in the formatted file (#49)