PyCharm SCP

Description

It is an External Tool for PyCharm designed to transfer files between a local storage and a remote server. The purpose of this tool is similar to File Transfer from Professional Edition, but this project carries less functionality.

Installation

1. Activate a virtual environment if necessary and install this library to your current Python environment:

pip install git+ssh://git@github.com/ok-42/pycharm-scp.git

2. Add the external tool to PyCharm:

Via GUI

• Open Settings — Tools — External Tools.
• Click Add button.
• Fill in the following fields:
  • Name: SCP (or any other name)
  • Program: $ModuleSdkPath$
  • Arguments: -m pcscp $FilePathRelativeToProjectRoot$ $ProjectFileDir$
  • Working directory: $ProjectFileDir$
• Click OK.

Via PyCharm settings file

• Replace USERNAME and PYCHARM with actual values and open C:\Users\USERNAME\AppData\Roaming\JetBrains\PYCHARM\settingsRepository\repository\tools\External Tools.xml.
• Incorporate <tool> tag from this file into settings file or paste the whole <toolSet> tag if the settings file is empty. The final structure should contain single <toolSet> tag with <tool> tag(s) nested:

<toolSet name="External Tools">
<tool> </tool>
<tool> </tool>
</toolSet> 

• Reload PyCharm.

3. (Optional) Assign a shortcut to the tool:

• Open Settings — Keymap.
• Expand External Tools / External Tools sections.
• Click twice on SCP tool (or another name if you chose it in the 2^nd step).
• Select Add Keyboard Shortcut.
• Press the desired key combination. If it contains Enter, Escape or Tab, click Plus button and select one.

4. Create a file named pcscp.json in the project root using this template. The file should be excluded from version control as it is intended for storing information on the local path on your machine, and could disclose user and host names.