Dev:PyCharm Setup - pk-hack/CoilSnake GitHub Wiki

PyCharm is a great and free Python IDE that makes CoilSnake development easy. Here's how to set it up.

Clone CoilSnake's git repository

  1. git clone [email protected]:pk-hack/CoilSnake.git

Install PyCharm

  1. Download and install JetBrains Toolbox here: https://www.jetbrains.com/toolbox-app/
  2. (Optional) In JetBrains Toolbox, go to Settings > Tools > Disable "Keep previous versions of tools to enable instant rollback" (prevents old versions of tools from taking up hard drive space)
  3. Open the "Tools" tab in JetBrains Toolbox
    1. Click the magnifying glass icon and search for PyCharm Community
    2. Install PyCharm Community

Create a CoilSnake project in PyCharm

  1. Open PyCharm Community by double clicking on it in JetBrains Toolbox
  2. Create a new project in PyCharm
    1. In PyCharm Community, click "New Project"
    2. In the "New Project" window, click the folder icon on the right of the Location field and choose the location on your computer where you git clone'd CoilSnake
    3. Click the "Create" button at the bottom-right of the "New Project" window
      • A window will pop up. Click the button to confirm that you're creating from existing sources.
    4. PyCharm will open your new project and take a minute to set everything up.
  3. In your new PyCharm project, go to PyCharm's menu at the top of the PyCharm window and open Menu > Settings > Project > Structure. Mark the coilsnake and tests folder as sources. The window should end up looking like the image below. After you're done, press the OK button at the bottom-right of the window.

Install CoilSnake's dependencies and build its native extensions

  1. Open the terminal by clicking the "Run" button at the bottom-left of PyCharm:
  2. Install CoilSnake's dependencies:
    1. Type pip install . into PyCharm's terminal, press Enter, and wait for it to complete.
  3. Build the native extensions (for compression/decompression):
    1. Type pip install setuptools into PyCharm's terminal, press Enter, and wait for it to complete.
    2. Type python setup.py build_ext --inplace clean into PyCharm's terminal, press Enter, and wait for it to complete.

Run your CoilSnake project

  1. In the left "Project" pane, find the gui.py file in the script folder.
  2. Right click on it, then click "Run 'gui'"
  3. After you've successfully run gui.py for the first time, you can more quickly do it by running it from the top of the PyCharm window: