PyLocket Documentation¶
Python Application Protection & Licensing Platform
PyLocket helps Python developers ship protected desktop applications with built-in licensing. It provides whole-app encryption, method-level runtime decryption, and a complete licensing infrastructure — all from the CLI or PyCharm plugin.
Who This Documentation Is For¶
This documentation is written for Python developers who use PyLocket to protect and distribute their applications. Whether you are shipping a commercial desktop tool, a data pipeline, or a proprietary library, these docs will walk you through every step — from first install to production distribution.
Documentation Structure¶
Part 1 — Tutorials¶
Step-by-step lessons that take you from zero to a fully protected, licensed application.
| Page | Description |
|---|---|
| Getting Started | Install PyLocket and protect your first script in under 5 minutes |
| Basic Tutorial | Walk through the standard protection workflow end to end |
| Advanced Tutorial | Multi-platform builds, CI/CD integration, and advanced configuration |
| Licensing Tutorial | Set up licensing, integrate your storefront, and deliver to end-users |
| Multi-OS Publishing | Publish protected builds for Windows, macOS, and Linux |
Part 2 — How-To Guides¶
Focused recipes for specific tasks. Jump directly to the guide you need.
| Page | Description |
|---|---|
| Protect a PyInstaller App | Protect .exe / app bundles built with PyInstaller |
| Protect a cx_Freeze App | Protect cx_Freeze-built applications |
| Protect a Briefcase App | Protect BeeWare Briefcase desktop apps |
| Protect a Python Wheel | Protect .whl packages for private distribution |
| Protect a ZIP Archive | Protect generic ZIP archives containing Python code |
| Configure Licensing | Set device limits, expiration, and offline grace periods |
| Distribute Your App | Connect your storefront and deliver to end-users |
| CI/CD Integration | Automate protection in GitHub Actions, GitLab CI, and Jenkins |
| Cross-Platform Builds | Build protected artifacts for Windows, macOS, and Linux |
| PyCharm Plugin | Protect apps directly from the PyCharm IDE |
Part 3 — Reference¶
Complete technical reference for every command, endpoint, and configuration option.
| Page | Description |
|---|---|
| CLI Reference | Every pylocket command, flag, and option |
| REST API Reference | All API endpoints with request/response examples |
| Configuration Reference | Environment variables and settings fields |
| Supported Platforms | OS, architecture, Python version, and packaging format matrix |
| Error Messages | Error codes, causes, and fixes |
Part 4 — Topics¶
Deep dives into how PyLocket works under the hood.
| Page | Description |
|---|---|
| How Protection Works | The protection pipeline from upload to encrypted output |
| Licensing System | License keys, device activation, tokens, and offline use |
| Security Model | Encryption, anti-analysis, memory protection, and binary hardening |
| Performance | Runtime overhead, optimization strategies, and benchmarks |
| Billing & Pricing | Pricing tiers, metered billing, and how charges work |
| Distribution Strategies | Choosing between executables, wheels, and ZIP archives |
Part 5 — License & Support¶
| Page | Description |
|---|---|
| License Terms & Support | License agreement, support channels, and SLA |
FAQ¶
| Page | Description |
|---|---|
| Frequently Asked Questions | Common questions about protection, licensing, billing, and troubleshooting |
Quick Links¶
- Publishing for multiple OSes? See the Multi-OS Publishing Tutorial
- First time? Start with Getting Started
- Protecting a specific format? Jump to the How-To Guides
- Need a CLI flag? See the CLI Reference
- Curious how it works? Read How Protection Works
- Something broken? Check Error Messages or the FAQ
Conventions Used in This Documentation¶
| Convention | Meaning |
|---|---|
monospace |
Commands, code, file paths, and environment variables |
<placeholder> |
A value you must replace with your own |
[optional] |
An optional argument or flag |
| Bold | UI elements, important terms, or emphasis |
| > Note | Additional context or tips |
| > Warning | Actions that may cause data loss or unexpected behavior |
PyLocket v1 — Proprietary. All rights reserved.