Pyarmor 8.0 Documentation

Version:8.0.1 Homepage:https://pyarmor.dashingsoft.com/ Contact:pyarmor@163.com Authors:Jondy Copyright:This document has been placed in the public domain.

How the documentation is organized

Pyarmor has a lot of documentation. A high-level overview of how it’s organized will help you know where to look for certain things:

• Part 1: Tutorials takes you by the hand through a series of steps to obfuscate Python scripts and packages. Start here if you’re new to Pyarmor. Also look at the Getting Started
• Part 2: How To guides are recipes. They guide you through the steps involved in addressing key problems and use-cases. They are more advanced than tutorials and assume some knowledge of how Python works.
• Part 3: References guides contain key concepts, man page, configurations and other aspects of Pyarmor machinery.
• Part 4: Topics guides insight into key topics and provide useful background information and explanation. They describe how it works and how to use it but assume that you have a basic understanding of key concepts.
• Part 5: Licneses describes EULA of Pyarmor, the different Pyarmor licenses and how to purchase Pyarmor license.

Getting help

Having trouble? We’d like to help!

Try the FAQ – it’s got answers to many common questions.

Looking for specific information? Try the Index, or the detailed table of contents.

Not found anything? See asking questions in github.

Report bugs with Pyarmor in issues

Table of Contents

• 1. Tutorials
  • 1.1. Getting Started
    • 1.1.1. What’s Pyarmor
    • 1.1.2. Installation from PyPI
    • 1.1.3. Obfuscating one script
    • 1.1.4. Obfuscating one package
    • 1.1.5. Expiring obfuscated scripts
    • 1.1.6. Binding obfuscated scripts to device
    • 1.1.7. Packaging obfuscated scripts
    • 1.1.8. Something need to know
    • 1.1.9. What to read next
    • 1.1.10. How the documentation is organized
  • 1.2. Installation
    • 1.2.1. Installation from PyPI
    • 1.2.2. Using virtual environments
    • 1.2.3. Installation from source
    • 1.2.4. Run Pyarmor from Python script
    • 1.2.5. Clean uninstallation
  • 1.3. Basic Obfuscation
    • 1.3.1. More options to protect script
    • 1.3.2. More options to protect package
    • 1.3.3. Checking runtime key periodically
    • 1.3.4. Binding to many machines
    • 1.3.5. Using outer file to store runtime key
    • 1.3.6. Localization runtime error
    • 1.3.7. Packing obfuscated scripts
  • 1.4. Advanced Tutorials
    • 1.4.1. Using rftmode ^pro
    • 1.4.2. Using bccmode ^pro
    • 1.4.3. Customization error handler
    • 1.4.4. Patching source by plugin marker
    • 1.4.5. Using hooks
    • 1.4.6. Internationalization runtime error message
    • 1.4.7. Generating cross platform scripts
    • 1.4.8. Obfuscating scripts for multiple Pythons
• 2. How To
  • 2.1. Highest security and performace
  • 2.2. Packaging data files
  • 2.3. Obfuscating django app
  • 2.4. Building obfuscated wheel
  • 2.5. Packing with outer key
  • 2.6. Protecting system packages
  • 2.7. Advanced Usage
    • 2.7.1. Fix encoding error
  • 2.8. Register Pyarmor
    • 2.8.1. Initial Registration
    • 2.8.2. Registeration in other machines
    • 2.8.3. Upgrade Pyarmor from prior to 8.0
• 3. References
  • 3.1. Concepts
  • 3.2. Man Page
    • 3.2.1. pyarmor
    • 3.2.2. pyarmor gen
    • 3.2.3. pyarmor gen key
    • 3.2.4. pyarmor cfg
    • 3.2.5. pyarmor reg
    • 3.2.6. Environment Variables
  • 3.3. Environments
    • 3.3.1. Building Device
    • 3.3.2. Target Device
  • 3.4. Building Errors
  • 3.5. Runtime Errors
• 4. Topics
  • 4.1. Insight Into Obfuscation
  • 4.2. Insight Into Obfuscated Script
  • 4.3. Changed features by obfuscated scripts
  • 4.4. Localization and Internationalization
  • 4.5. Insight Into Pack Command
  • 4.6. Insight Into RFT Mode
  • 4.7. Insight Into BCC Mode
  • 4.8. Performance
• 5. Pyarmor License Types
  • 5.1. Introduction
  • 5.2. License types
    • 5.2.1. License features
  • 5.3. Purchasing license
    • 5.3.1. Refund policy
  • 5.4. Upgrading old license
    • 5.4.1. Freely to Pyarmor-Basic
    • 5.4.2. With extra fee to Pyarmor-Pro
• 6. FAQ
  • 6.1. Asking Questions In Github

Indices and tables

• Index
• Module Index
• Search Page