README: Add instructions for PyCharm #81

Stevoisiak · 2018-03-27T17:03:27Z

Instructions to add black to "External Tools" in PyCharm.

Adapted from https://kirankoduru.github.io/python/pylint-with-pycharm.html

Instructions to add `black` to "External Tools" in PyCharm. Adapted from https://kirankoduru.github.io/python/pylint-with-pycharm.html

coveralls · 2018-03-27T17:06:31Z

Pull Request Test Coverage Report for Build 114

0 of 0 (NaN%) changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 88.705%

Totals
Change from base Build 113:	0.0%
Covered Lines:	1123
Relevant Lines:	1266

💛 - Coveralls

coveralls · 2018-03-27T17:06:31Z

Pull Request Test Coverage Report for Build 114

0 of 0 (NaN%) changed or added relevant lines in 0 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage remained the same at 88.705%

Totals
Change from base Build 113:	0.0%
Covered Lines:	1123
Relevant Lines:	1266

💛 - Coveralls

coveralls · 2018-03-27T17:06:31Z

Pull Request Test Coverage Report for Build 188

0 of 0 (NaN%) changed or added relevant lines in 0 files are covered.
122 unchanged lines in 2 files lost coverage.
Overall coverage increased (+1.7%) to 90.42%

Files with Coverage Reduction	New Missed Lines	%
tests/test_black.py	3	97.72%
black.py	119	88.24%

Totals
Change from base Build 113:	1.7%
Covered Lines:	1378
Relevant Lines:	1524

💛 - Coveralls

ambv · 2018-03-27T17:24:16Z

Thanks for your contribution! It looks like your guide still says "pylint" in lots of places.

Stevoisiak · 2018-03-27T17:28:09Z

@ambv Good catch. I've fixed the instances of "pylint" (feel free to squash before merging).

ambv

Alright, this is very nice. I just have some slight wording adjustements. See comments.

ambv · 2018-03-27T20:15:27Z

README.md

@@ -325,8 +354,6 @@ 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.

-This can be used for example with PyCharm's [File Watchers](https://www.jetbrains.com/help/pycharm/file-watchers.html).


Don't remove this. File Watchers is a distinct and also useful integration if somebody wants to format on save.

ambv · 2018-03-27T20:16:13Z

README.md

@@ -268,6 +268,35 @@ keep it.
 Use [proofit404/blacken](https://github.com/proofit404/blacken).


+### PyCharm
+
+(Adapted from [*Pylinting with PyCharm*](https://kirankoduru.github.io/python/pylint-with-pycharm.html))


I understand why you want to share credit but I think the steps outlined below are generic enough that you don't have to. This just adds noise to the guide.

I agree with @ambv on this point

ambv · 2018-03-27T20:19:59Z

README.md

+
+(Adapted from [*Pylinting with PyCharm*](https://kirankoduru.github.io/python/pylint-with-pycharm.html))
+
+1. Install `black`.


nit: In all of the docs when we refer to the project, we say *Black*, not `black`.

ambv · 2018-03-27T20:20:53Z

README.md

+2. Locate your `black` installation folder.
+
+        $ which black         # MacOS/Linux
+        /usr/local/bin/black  # this is just a possible output check yours


I like the simple comment you used for the Windows version: # possible location.

ambv · 2018-03-27T20:21:04Z

README.md

+3. Open External tools in PyCharm with `File -> Settings -> Tools -> External Tools`.
+
+4. Click the + icon to add a new external tool with the following values:
+    - Name: black


ambv · 2018-03-27T20:21:32Z

README.md

+
+4. Click the + icon to add a new external tool with the following values:
+    - Name: black
+    - Description: Black is the uncompromising Python code formatter.


"Black is" is redundant. "The uncompromising Python code formatter." is enough.

MichalPodeszwa · 2018-03-29T09:27:02Z

README.md

+    - Program: <install_location_from_step_2>
+    - Arguments: $FilePath$
+
+5. Format the currently opened file by selecting `Tools -> External Tools -> black`.


I would also add instructions on how to map it as a keymap. (You can simply do it through the regular keymap settings). It'll be there in External Tools

I would simply link this guide: https://blog.jetbrains.com/webstorm/2016/08/using-external-tools/

I have added the instructions as a bullet point on the next line.

sfdye · 2018-04-09T02:34:34Z

Exactly what I am looking for, please get it merged soon!

Stevoisiak · 2018-04-09T14:49:46Z

@ambv @sfdye I have updated my PR with the requested changes.

ambv · 2018-04-09T19:00:43Z

Thanks! ✨ 🍰 ✨

README: Add instructions for PyCharm

311f2ac

Instructions to add `black` to "External Tools" in PyCharm. Adapted from https://kirankoduru.github.io/python/pylint-with-pycharm.html

README: Replace 'lint' with 'black'

d089c30

README: Fix broken URL

75aa4ce

ambv reviewed Mar 27, 2018

View reviewed changes

MichalPodeszwa reviewed Mar 29, 2018

View reviewed changes

Stevoisiak added 5 commits April 9, 2018 10:41

Remove link to external tutorial

2ab78ac

Re-add instructions for file watchers

8619a42

Capitalize Black in external tools info

188b9b4

Shorter comment for "Possible location"

0f9d866

Explain how to add a keyboard shortcut

533bc49

ambv merged commit ecc2947 into psf:master Apr 9, 2018

Stevoisiak deleted the readme-pycharm branch April 10, 2018 13:47

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README: Add instructions for PyCharm #81

README: Add instructions for PyCharm #81

Stevoisiak commented Mar 27, 2018

coveralls commented Mar 27, 2018

coveralls commented Mar 27, 2018

coveralls commented Mar 27, 2018 •

edited

Loading

ambv commented Mar 27, 2018

Stevoisiak commented Mar 27, 2018 •

edited

Loading

ambv left a comment

ambv Mar 27, 2018

ambv Mar 27, 2018

sfdye Apr 9, 2018

ambv Mar 27, 2018

ambv Mar 27, 2018

ambv Mar 27, 2018

ambv Mar 27, 2018

MichalPodeszwa Mar 29, 2018

sfdye Apr 9, 2018

Stevoisiak Apr 9, 2018

sfdye commented Apr 9, 2018

Stevoisiak commented Apr 9, 2018

ambv commented Apr 9, 2018


		(Adapted from [Pylinting with PyCharm](https://kirankoduru.github.io/python/pylint-with-pycharm.html))

		1. Install `black`.

README: Add instructions for PyCharm #81

README: Add instructions for PyCharm #81

Conversation

Stevoisiak commented Mar 27, 2018

coveralls commented Mar 27, 2018

Pull Request Test Coverage Report for Build 114

💛 - Coveralls

coveralls commented Mar 27, 2018

Pull Request Test Coverage Report for Build 114

💛 - Coveralls

coveralls commented Mar 27, 2018 • edited Loading

Pull Request Test Coverage Report for Build 188

💛 - Coveralls

ambv commented Mar 27, 2018

Stevoisiak commented Mar 27, 2018 • edited Loading

ambv left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sfdye commented Apr 9, 2018

Stevoisiak commented Apr 9, 2018

ambv commented Apr 9, 2018

coveralls commented Mar 27, 2018 •

edited

Loading

Stevoisiak commented Mar 27, 2018 •

edited

Loading