Man Page

PyArmor is a command line tool used to obfuscate python scripts, bind obfuscated scripts to fixed machine or expire obfuscated scripts.

The syntax of the pyarmor command is:

pyarmor <command> [options]

The most commonly used pyarmor commands are:

obfuscate    Obfuscate python scripts
licenses     Generate new licenses for obfuscated scripts
pack         Pack obfuscated scripts to one bundle
hdinfo       Show hardware information

The commands for project:

init         Create a project to manage obfuscated scripts
config       Update project settings
build        Obfuscate all the scripts in the project

info         Show project information
check        Check consistency of project

The other commands:

benchmark    Run benchmark test in current machine
register     Make registration code work
download     Download platform-dependent dynamic libraries

See pyarmor <command> -h for more information on a specific command.

obfuscate

Obfuscate python scripts.

SYNOPSIS:

pyarmor obfuscate <options> SCRIPT...

OPTIONS

-O, --output PATH
 Output path, default is dist
-r, --recursive
 Search scripts in recursive mode
--exclude PATH Exclude the path in recusrive mode. Multiple paths are allowed, separated by “,”, or use this option multiple times
--exact Only obfuscate list scripts
--no-bootstrap Do not insert bootstrap code to entry script
--no-cross-protection
 Do not insert protection code to entry script
--plugin NAME Insert extra code to entry script
--platform NAME
 Distribute obfuscated scripts to other platform

DESCRIPTION

PyArmor first checks whether Global Capsule exists in the HOME path. If not, make it.

Then find all the scripts to be obfuscated. There are 3 modes to search the scripts:

  • Normal: find all the .py files in the same path of entry script
  • Recursive: find all the .py files in the path of entry script recursively
  • Exact: only these scripts list in the command line

If there is an entry script, PyArmor will modify it, insert cross protection code into the entry script.

Next obfuscate all these scripts in the default output path dist.

After that generate default license.lic for obfuscated scripts and make all the other Runtime Files in the dist path.

Finally insert Bootstrap Code into entry script.

The entry script is only the first script if there are more than one script in command line.

Option –plugin is used to extend license type of obfuscated scripts, it will insert the content of plugin into entry script. The corresponding filename of plugin is NAME.py. Name may be absolute path if it’s not in the current path, or specify plugin path by environment variable PYARMOR_PLUGIN.

About the usage of plugin, refer to Using Plugin to Extend License Type

Option –platform is used to specify the target platform of obfuscated scripts if target platform is different from build platform.

EXAMPLES

  • Obfuscate all the .py only in the current path:

    pyarmor obfuscate foo.py
    
  • Obfuscate all the .py in the current path recursively:

    pyarmor obfuscate --recursive foo.py
    
  • Obfuscate all the .py in the current path recursively, exclude all the .py in the path build and tests:

    pyarmor obfuscate --recursive --exclude build,tests foo.py
    pyarmor obfuscate --recursive --exclude build --exclude tests foo.py
    
  • Obfuscate only two scripts foo.py, moda.py exactly:

    pyarmor obfuscate --exact foo.py moda.py
    
  • Obfuscate all the .py file in the path mypkg/:

    pyarmor obfuscate --output dist/mypkg mypkg/__init__.py
    
  • Obfuscate all the .py files in the current path, but do not insert cross protection code into obfuscated script dist/foo.py:

    pyarmor obfuscate --no-cross-protection foo.py
    
  • Obfuscate all the .py files in the current path, but do not insert bootstrap code at the beginning of obfuscated script dist/foo.py:

    pyarmor obfuscate --no-bootstrap foo.py
    
  • Insert the content of check_ntp_time.py into foo.py, then obfuscating foo.py:

    pyarmor obfuscate --plugin check_ntp_time foo.py
    
  • Obfuscate the scripts in Macos and run obfuscated scripts in Ubuntu:

    pyarmor download --list
    pyarmor download linux_x86_64
    
    pyarmor obfuscate --platform linux_x86_64 foo.py
    

licenses

Generate new licenses for obfuscated scripts.

SYNOPSIS:

pyarmor licenses <options> CODE

OPTIONS

-O, --output OUTPUT
 Output path
-e, --expired YYYY-MM-DD
 Expired date for this license
-d, --bind-disk SN
 Bind license to serial number of harddisk
-4, --bind-ipv4 IPV4
 Bind license to ipv4 addr
-m, --bind-mac MACADDR
 Bind license to mac addr

DESCRIPTION

In order to run obfuscated scripts, it’s necessarey to hava a :flile:`license.lic`. As obfuscating the scripts, there is a default license.lic created at the same time. In this license the obfuscated scripts can run on any machine and never expired.

This command is used to generate new licenses for obfuscated scripts. For example:

pyarmor licenses --expired 2019-10-10 mycode

An expired license will be generated in the default output path plus code name licenses/mycode, then overwrite the old one in the same path of obfuscated script:

cp licenses/mycode/license.lic dist/

Another example, bind obfuscated scripts in mac address and expired on 2019-10-10:

pyarmor licenses --expired 2019-10-10 --bind-mac 2a:33:50:46:8f tom
cp licenses/tom/license.lic dist/

Before this, run command hdinfo to get hardware information:

pyarmor hdinfo

There maybe have whitespace in the serial number of harddisk for some machines, just quote it in the command line:

pyarmor licenses --bind-disk "100304PBN2081SF3NJ5T " jondy

pack

Obfuscate the scripts and pack them into one bundle.

SYNOPSIS:

pyarmor pack <options> SCRIPT

OPTIONS

-t, --type TYPE
 cx_Freeze, py2exe, py2app, PyInstaller(default).
-O, --output OUTPUT
 Directory to put final built distributions in.
-e, --options OPTIONS
 Extra options to run external tool
-x, --xoptions OPTIONS
 Extra options to obfuscate scripts
--clean Remove last build path before packing

DESCRIPTION

PyArmor first packes the script by calling the third-party tool such as PyInstaller, gets the dependencies and other required files.

Then obfuscates all the .py files in the same path of entry script.

Next replace the original scripts with the obfuscated ones.

Finally pack all of them into one bundle.

Option –options could pass any extra options to external tool. PyInstaller is called by this way:

pyinstaller --distpath DIST -y EXTRA_OPTIONS SCRIPT

EXTRA_OPTIONS is replaced with this option.

Option –xoptions could pass any extra options to obfuscate scripts. By default, pack will obfuscate scripts like this:

pyarmor obfuscate -r --output DIST EXTRA_OPTIONS SCRIPT

EXTRA_OPTIONS is replaced with this option.

For more information, refer to How To Pack Obfuscated Scripts.

EXAMPLES

  • Obfuscate foo.py and pack them into the bundle dist/foo:

    pyarmor pack foo.py
    
  • Pass extra options to run PyInstaller:

    pyarmor pack -e " -w --icon app.ico" foo.py
    
  • Pass extra options to obfuscate scripts:

    pyarmor pack -x " --exclude venv --exclude test" foo.py
    

hdinfo

Show hardware information of this machine, such as serial number of hard disk, mac address of network card etc. The information got here could be as input data to generate license file for obfuscated scripts.

SYNOPSIS:

pyarmor hdinfo

init

Create a project to manage obfuscated scripts.

SYNOPSIS:

pyarmor init <options> PATH

OPTIONS

-t, --type <auto,app,pkg>
 Project type, default value is auto
-s, --src SRC Base path of python scripts, default is current path
-e, --entry ENTRY
 Entry script of this project

DESCRIPTION

This command will create a project in the specify PATH, and a .pyarmor_config will be created at the same time, which is project configuration of JSON format.

If the option –type is set to auto, which is the default value, the project type will set to pkg if the entry script is __init__.py, otherwise to app.

The init command will set the properties disable_restrict_mode and is_package of this project to 1 if the new project is configured as pkg, otherwise they’re set to 0.

After project is created, use command config to change the project settings.

EXAMPLES

  • Create a project in the current path:

    pyarmor init --entry foo.py
    
  • Create a project in the build path obf:

    pyarmor init --entry foo.py obf
    
  • Create a project for package:

    pyarmor init --entry __init__.py
    
  • Create a project in the path obf, manage the scripts in the path /path/to/src:

    pyarmor init --src /path/to/src --entry foo.py obf
    

config

Update project settings.

SYNOPSIS:

pyarmor config <options> [PATH]

OPTIONS

--name NAME Project name
--title TITLE Project title
--src SRC Project src
--output OUTPUT
 Output path for obfuscated scripts
--manifest TEMPLATE
 Manifest template string
--entry SCRIPT Entry script of this project
--is-package <0,1>
 Set project as package or not
--disable-restrict-mode <0,1>
 Disable or enable restrict mode
--obf-mod <0,1>
 Disable or enable to obfuscate module
--obf-code <0,1>
 Disable or enable to obfuscate function
--wrap-mode <0,1>
 Disable or enable to wrap mode
--cross-protection <0,1>
 Disable or enable to insert cross protection code into entry script
--runtime-path RPATH
 Set the path of runtime files in target machine
--plugin NAME Insert extra code to entry script

DESCRIPTION

Run this command in project path to change project settings:

pyarmor config --option new-value

Or specify the project path at the end:

pyarmor config --option new-value /path/to/project

Option –manifest is comma-separated list of manifest template command, same as MANIFEST.in of Python Distutils.

Option –entry is comma-separated list of entry scripts, relative to src path of project.

EXAMPLES

  • Change project name and title:

    pyarmor config --name "project-1"  --title "My PyArmor Project"
    
  • Change project entries:

    pyarmor config --entry foo.py,hello.py
    
  • Exclude path build and dist, do not search .py file from these paths:

    pyarmor config --manifest "global-include *.py, prune build, prune dist"
    
  • Obfuscate script with wrap mode off:

    pyarmor config --wrap-mode 0
    
  • Set plugin for entry script. The content of check_ntp_time.py will be insert into entry script as building project:

    pyarmor config --plugin check_ntp_time.py
    
  • Clear all plugins:

    pyarmor config --plugin clear
    

build

Build project, obfuscate all scripts in the project.

OPTIONS

-B, --force Force to obfuscate all scripts
-r, --only-runtime
 Generate extra runtime files only
-n, --no-runtime
 DO NOT generate runtime files
-O, --output OUTPUT
 Output path, override project configuration
--platform NAME
 Distribute obfuscated scripts to other platform

DESCRIPTION

Run this command in project path:

pyarmor build

Or specify the project path at the end:

pyarmor build /path/to/project

EXAMPLES

  • Only obfuscate the scripts which have been changed since last build:

    pyarmor build
    
  • Force build all the scripts:

    pyarmor build -B
    
  • Generate runtime files only, do not try to obfuscate any script:

    pyarmor build -r
    
  • Obfuscate the scripts only, do not generate runtime files:

    pyarmor build -n
    
  • Save the obfuscated scripts to other path, it doesn’t change the output path of project settings:

    pyarmor build -B -O /path/to/other
    
  • Build project in Macos and run obfuscated scripts in Ubuntu:

    pyarmor download --list
    pyarmor download linux_x86_64
    
    pyarmor build -B --platform linux_x86_64
    

info

Show project information.

SYNOPSIS:

pyarmor info [PATH]

DESCRIPTION

Run this command in project path:

pyarmor info

Or specify the project path at the end:

pyarmor info /path/to/project

check

Check consistency of project.

SYNOPSIS:

pyarmor check [PATH]

DESCRIPTION

Run this command in project path:

pyarmor check

Or specify the project path at the end:

pyarmor check /path/to/project

banchmark

Check the performance of obfuscated scripts.

SYNOPSIS:

pyarmor benchmark <options>

OPTIONS:

-m, --obf-mode <0,1>
 Whether to obfuscate the whole module
-c, --obf-code <0,1>
 Whether to obfuscate each function
-w, --wrap-mode <0,1>
 Whether to obfuscate each function with wrap mode
--debug Do not remove test path

DESCRIPTION

This command will generate a test script, obfuscate it and run it, then output the elapsed time to initialize, import obfuscated module, run obfuscated functions etc.

EXAMPLES

  • Test performance with default mode:

    pyarmor benchmark
    
  • Test performance with no wrap mode:

    pyarmor benchmark --wrap-mode 0
    
  • Check the test scripts which saved in the path .benchtest:

    pyarmor benchmark --debug
    

register

Make registration code effect, backup and restore it.

SYNOPSIS:

pyarmor register <options> CODE

OPTIONS:

-b, --backup Backup current registration code
-r, --restore Restore license file from last backup

DESCRIPTION

Make registration code effect by this way:

pyarmor register CODE

Check it works:

pyarmor -v

It’s better to backup this code after everything is fine:

pyarmor register --backup

The code will be saved in the file ~/.pyarmor_config

Note

If something is wrong, PyArmor maybe could not start. In this case, try to remove license.lic in the installed path of PyArmor, then run pyarmor again.

download

List and download platform-dependent dynamic libraries.

SYNOPSIS:

pyarmor download <options> PLAT-ID

OPTIONS:

--list PATTERN List available dynamic libraries in different platforms
-O, --output NAME
 Save downloaded file to another path

DESCRIPTION

In some machines maybe PyArmor could not recognize the platform and raise error. For example:

ERROR: Unsupport platform linux32/armv7l

In this case, check all the available prebuilt libraries:

pyarmor download --list

And download armv7 from this list:

pyarmor download --output linux32/armv7l armv7

Filter could be applied to list the platforms, for example:

pyarmor download --list linux32