• Table of contents
• Installation
• Suggested PyCharm settings
  • Editor
  • Code Style > Python > Wrapping and Braces
  • Code Style > Python > Tab Imports
  • Code Style > HTML -> Tabs and Indents
  • (PyCharm Professional) Code Style > JavaScript -> Tabs and Indents
  • Plugins
  • Tests
• Preferences
  • Appearance and Behavior
  • Font

Installation¶

Either get it from PyCharm directly or use these instructions for Debian.

Suggested PyCharm settings¶

Under menu item File > Settings when using PyCharm IDE

Editor¶

• General
  • Remove trailing spaces on: All lines
  • Set Ensure every saved file ends with a line break
• Code Style
  • Set hardwrap to 79 columns

Code Style > Python > Wrapping and Braces¶

• Set Ensure right margin is not exceeded

Code Style > Python > Tab Imports¶

• Sort import statements
  • Sort imported names in "from" imports
  • Sort plain and "from" imports separately within a group

• Join imports with the same source

Code Style > HTML -> Tabs and Indents¶

• Tab size: 2
• Indent: 2
• Continuation indent: 2

(PyCharm Professional) Code Style > JavaScript -> Tabs and Indents¶

• Tab size: 2
• Indent: 2
• Continuation indent: 2

Plugins¶

• Mypy
• Pylint

Tests¶

To prevent PyCharm overwriting the test configuration do:

File > Settings > Advanced Settings > Python and checking the option Pytest: do not add "--no-header --no-summary -q"

Preferences¶

These are some personal preferences of Alex which don't have any effect on submitted code.

Appearance and Behavior¶

• Appearance -> Check widescreen windows layout

Font¶

• Font: DejaVu Sans Mono
• Size: 13
• Line spacing: 1.2