Skip to content

Latest commit

 

History

History
45 lines (25 loc) · 1.3 KB

pycharm.md

File metadata and controls

45 lines (25 loc) · 1.3 KB

PyCharm Integration

Instructions on integrating Pipsync into PyCharm.

FileWatcher

Custom Scope

Enable Pipsync to run every time your Pipfile.lock is modified.

  1. In PyCharm's menu go to PyCharm -> Appearance & Behavior -> Scopes and click "+":

    PyCharm Custom Scope

  2. Label the new scope ("Pipfile" is used in the screenshot").

  3. Select the Pipfile.lock file and click Include.

  4. Click Apply to save your changes.

Add File Watcher

  1. Install Pipsync and copy the path to its installation:

    % which pipsync
/Library/Frameworks/Python.framework/Versions/3.8/bin/pipsync

  2. In PyCharm's menu go to PyCharm -> Preferences -> Tools -> File Watchers and click "+":

    PyCharm File Watcher

  3. Set the File Type to Any (the only file in scope is Pipfile.lock).

  4. Set the Scope to the custom scope created in the previous section (e.g. the "Pipfile" scope).

  5. Paste the path to Pipsync in the Program field.

  6. Set the Arguments to $FilePath$.

    • It is here you can customize the remaining arguments to use with Pipsync.

  7. Under Advanced Options enabled Trigger watcher on external changes.

  8. Click OK and then Apply to save your changes.