Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README: Add instructions for PyCharm #81

Merged
merged 8 commits into from
Apr 9, 2018
Merged

README: Add instructions for PyCharm #81

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
311f2ac
README: Add instructions for PyCharm
Stevoisiak Mar 27, 2018
d089c30
README: Replace 'lint' with 'black'
Stevoisiak Mar 27, 2018
75aa4ce
README: Fix broken URL
Stevoisiak Mar 27, 2018
2ab78ac
Remove link to external tutorial
Stevoisiak Apr 9, 2018
8619a42
Re-add instructions for file watchers
Stevoisiak Apr 9, 2018
188b9b4
Capitalize Black in external tools info
Stevoisiak Apr 9, 2018
0f9d866
Shorter comment for "Possible location"
Stevoisiak Apr 9, 2018
533bc49
Explain how to add a keyboard shortcut
Stevoisiak Apr 9, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -268,6 +268,34 @@ keep it.
Use [proofit404/blacken](https://github.com/proofit404/blacken).


### PyCharm

1. Install `black`.

$ pip install black

2. Locate your `black` installation folder.

$ which black # MacOS/Linux
/usr/local/bin/black # possible location

<!-->

$ where black # Windows
%LocalAppData%\Programs\Python\Python36-32\Scripts\black.exe # possible location

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
- Description: Black is the uncompromising Python code formatter.
- Program: <install_location_from_step_2>
- Arguments: $FilePath$

5. Format the currently opened file by selecting `Tools -> External Tools -> black`.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

- Alternatively, you can set a keyboard shortcut by navigating to `Preferences -> Keymap`.


### Vim

Commands and shortcuts:
Expand Down