Pyarmor 8.5 Documentation
- Version
8.5.11
- Homepage
- Contact
- 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.
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.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
- 1.1. Getting Started
- 2. How To
- 2.1. Highest security and performance
- 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.9. Work with Third-Party Libraries
- 2.10. Using Pyarmor License
- 3. References
- 4. Topics
- 5. License Types
- 6. FAQ