Skip to content

How To: Use the PyCharm Plugin

The PyLocket PyCharm plugin integrates protection directly into your IDE, letting you protect applications without leaving the editor.

Installation

  1. Open PyCharm → Settings (or Preferences on macOS)
  2. Navigate to Plugins → Marketplace
  3. Search for PyLocket
  4. Click Install
  5. Restart PyCharm when prompted

Setup

Login

  1. Open the PyLocket tool window (appears in the bottom panel after installation)
  2. Click Login
  3. Enter your PyLocket email and password
  4. If 2FA is enabled, enter your TOTP code

Your session persists until the token expires or you log out.

Configure API URL (optional)

By default, the plugin connects to https://api.pylocket.com. To use a custom endpoint:

  1. Go to Settings → Tools → PyLocket
  2. Enter your API URL
  3. Click Apply

Artifact Detection

The plugin automatically detects packaging configurations in your project:

File Packaging Tool
*.spec PyInstaller
setup.py with cx_Freeze cx_Freeze
pyproject.toml with Briefcase BeeWare Briefcase

Detected configurations appear in the PyLocket tool window under Artifacts.

Protecting an Application

  1. In the PyLocket tool window, select an artifact from the Artifacts list
  2. Click Protect
  3. Configure options in the dialog:
  4. App: Select your registered app (or create a new one)
  5. Platform: Target platform
  6. Python Version: Python version used for building
  7. Click Start Protection

The build status appears in the tool window with a progress indicator.

Monitoring Builds

The Builds tab shows:

  • Build ID, status, and timestamp
  • Platform
  • Download button (available when status is READY)

Click Refresh to update the status.

Downloading Protected Output

  1. Find the build with status READY in the Builds tab
  2. Click Download
  3. Choose the output directory
  4. The protected files are saved to the selected directory

Managing Apps and Licenses

The plugin provides tabs for:

  • Apps: View and create registered applications
  • Licenses: View license keys, activation counts, and statuses
  • Settings: API URL, authentication, and preferences

Keyboard Shortcuts

Action Shortcut
Open PyLocket tool window Alt+L (Windows/Linux) / Option+L (macOS)
Protect selected artifact Ctrl+Shift+P (Windows/Linux) / Cmd+Shift+P (macOS)
Refresh build status F5

Troubleshooting

Problem Solution
Plugin not visible Check View → Tool Windows → PyLocket
Login fails Verify credentials work with pylocket login in the terminal
No artifacts detected Ensure your project contains a PyInstaller .spec file, setup.py, or Briefcase pyproject.toml
Build stuck at QUEUED Check your internet connection. The protection queue may be under load.

See Also