Pyarmor 8.5 Documentation

Version

8.5.12

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: Licenses describes EULA of Pyarmor, the different Pyarmor licenses and how to purchase Pyarmor license.

Getting help

Having trouble?

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. Prerequisite
    • 1.2.2. Installation from PyPI
    • 1.2.3. Using virtual environments
    • 1.2.4. Installation from source
    • 1.2.5. Installation in offline device
    • 1.2.6. Termux issues
    • 1.2.7. Run Pyarmor from Python script
    • 1.2.8. Clean uninstallation
  • 1.3. Basic Tutorial
    • 1.3.1. Debug mode and trace log
    • 1.3.2. More options to protect script
    • 1.3.3. More options to protect package
    • 1.3.4. Copying package data files
    • 1.3.5. Checking runtime key periodically
    • 1.3.6. Binding to many machines
    • 1.3.7. Using outer file to store runtime key
    • 1.3.8. Localization runtime error
    • 1.3.9. Packing obfuscated scripts
  • 1.4. Advanced Tutorial
    • 1.4.1. Using rftmode ^pro
    • 1.4.2. Using bccmode ^pro
    • 1.4.3. Customization error handler
    • 1.4.4. Filter mix string
    • 1.4.5. Filter assert function and import
    • 1.4.6. Patching source by inline marker
    • 1.4.7. Internationalization runtime error message
    • 1.4.8. Generating cross platform scripts
    • 1.4.9. Obfuscating scripts for multiple Python versions
    • 1.4.10. Using shared runtime package
  • 1.5. Customization and Extension
    • 1.5.1. Changing runtime package name
    • 1.5.2. Appending assert functions and modules
    • 1.5.3. Using plugin to fix loading issue in darwin
    • 1.5.4. Using hook to bind script to docker id
    • 1.5.5. Using hook to check network time by other service
    • 1.5.6. Protecting extension module pyarmor_runtime
    • 1.5.7. Comments within outer key
• 2. How To
  • 2.1. Highest security and performance
    • 2.1.1. What’s the most security pyarmor could do?
    • 2.1.2. What’s the best performance pyarmor could do?
    • 2.1.3. Recommended options for different applications
    • 2.1.4. Reforming scripts to improve security
  • 2.2. Protecting Runtime Memory Data
  • 2.3. Packing with outer key
  • 2.4. Building obfuscated wheel
  • 2.5. Protecting system packages
  • 2.6. Fix encoding error
  • 2.7. Removing docstring
  • 2.8. Using Pyarmor in CI Pipeline
    • 2.8.1. Using Pyarmor CI Quota
  • 2.9. Work with Third-Party Libraries
    • 2.9.1. Third party libraries
  • 2.10. Using Pyarmor License
    • 2.10.1. Prerequisite
    • 2.10.2. Using Pyarmor Basic or Pro
    • 2.10.3. Using group license
    • 2.10.4. Using multiple Pyarmor Licenses in same device
    • 2.10.5. What need to do after upgrading Pyarmor
• 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 gen runtime
    • 3.2.5. pyarmor cfg
    • 3.2.6. pyarmor reg
    • 3.2.7. Environment Variables
  • 3.3. Building Environments
    • 3.3.1. Supported Python versions
    • 3.3.2. Supported platforms
    • 3.3.3. Configuration options
    • 3.3.4. Plugins
    • 3.3.5. Hooks
  • 3.4. Target Environments
    • 3.4.1. Supported Python versions and platforms
    • 3.4.2. Environment variables
    • 3.4.3. Supported Third-Party Interpreter
    • 3.4.4. Specialized builtin functions
  • 3.5. Error Messages
    • 3.5.1. Building Errors
    • 3.5.2. Runtime Errors
    • 3.5.3. Outer Errors
  • 3.6. Pyarmor Check List
    • 3.6.1. Build Device
    • 3.6.2. Target Device
    • 3.6.3. Platform Issues
• 4. Topics
  • 4.1. Insight Into Obfuscation
    • 4.1.1. Filter scripts by finder
  • 4.2. Understanding Obfuscated Script
    • 4.2.1. Restrict modes
    • 4.2.2. The differences of obfuscated scripts
    • 4.2.3. Supported Third-Party Interpreter
  • 4.3. Insight Into Pack Command
    • 4.3.1. Packing Scripts Automatically
    • 4.3.2. Packing obfuscated scripts manually
    • 4.3.3. Packing with PyInstaller Bundle
    • 4.3.4. Segment fault in Apple M1
  • 4.4. Insight Into RFT Mode
    • 4.4.1. Enable RFT Mode
    • 4.4.2. Check transformed script
    • 4.4.3. Trace rft log
    • 4.4.4. Exclude name rule
    • 4.4.5. Handle wild card form of import
    • 4.4.6. Handle module attribute __all__
    • 4.4.7. Manual ruler
  • 4.5. Insight Into BCC Mode
    • 4.5.1. Enable BCC mode
    • 4.5.2. Trace bcc log
    • 4.5.3. Ignore module or function
    • 4.5.4. Changed features
    • 4.5.5. Unsupported features
    • 4.5.6. Known issues
  • 4.6. Security and Performance
  • 4.7. Localization and Internationalization
• 5. License Types
  • 5.1. Introduction
  • 5.2. License types
    • 5.2.1. Check device for group license
    • 5.2.2. License features
  • 5.3. Purchasing license
    • 5.3.1. Refund policy
  • 5.4. Upgrading old license
    • 5.4.1. Upgrading old license to Pyarmor Basic
• 6. FAQ
  • 6.1. Asking questions in GitHub
  • 6.2. Reporting bug
    • 6.2.1. Build issues
    • 6.2.2. Pack issues
    • 6.2.3. Runtime issues
  • 6.3. Hot Questions
  • 6.4. License
    • 6.4.1. Upgrading
  • 6.5. Purchasing
  • 6.6. Misc.

Indices and tables

• Index

• Module Index

• Search Page