Skip to content

examples

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

examples

README.md

Exmaples

中文版

A good example maybe is the best teacher. There are several sample shell scripts distributed with source package of Pyarmor. All of them are rich comment used to obfuscate Python scripts in different cases, .bat for Windows, .sh for Linux and MacOS. Find them in the path examples, edit the variables in it according to actual enviroments, then run it to obfuscate your python scripts quickly.

Not only those scripts, but also some really examples are distributed with Pyarmor. Just open a command window, follow the instructions in this document, learn how to use Pyarmor by these examples.

In the rest sections, assume that Python is installed, it can be called python. And Pyarmor has been installed in the /path/to/pyarmor.

Shell commands will shown for Unix-based systems. Windows has analogous commands for each.

Example 1: Obfuscate scripts

Learn from this example

  • How to obufscate python scripts in the path examples/simple
  • How to run obfuscated scripts
  • How to distribute obfuscated scripts
    cd /path/to/pyarmor

    # Obfuscate python scripts in the path `examples/simple`
    python pyarmor.py obfuscate --recursive --src examples/simple --entry queens.py

    # Obfuscated scripts saved in the output path `dist`
    cd dist

    # Run obfuscated scripts
    python queens.py

    # Zip all the files in the path `dist`, distribute this archive
    zip queens-obf.zip .

Example 2: Obfuscate package

Learn from this example

  • How to obfuscate a python package mypkg in the path examples/testpkg
  • How to expire this obfuscated package on some day
  • How to import obfuscated package mypkg by outer script main.py
  • How to distribute obfuscated package to end user
    cd /path/to/pyarmor

    # Obfuscate all the python scripts in the package, obfuscated package saved in the path `dist/mypkg`
    # python pyarmor.py obfuscate --src "examples/testpkg/mypkg" --entry "__init__.py" --output "dist/mypkg"

    # Generate an expired license on 2019-01-01
    python pyarmor.py licenses --expired 2019-01-01 mypkg2018

    # Overwrite the default license
    cp licenses/mypkg2018/license.lic dist/mypkg

    # Import functions from obfuscated package
    cd dist
    cp ../examples/testpkg/main.py ./
    python main.py

    # Zip the whole path `mypkg`, distribute this archive
    zip -r mypkg-obf.zip mypkg

Example 3: Build with project

Learn from this example

  • How to use project to manage obfuscated scripts
  • How to bind obfuscated scripts to harddisk, network card
  • How to distribute obfuscated scripts to different platform
  • How to generate license for each user

In this example, obfuscated script queens.py in the path examples/simple will be distributed to three customers with different licenses:

  • John, run on any Ubuntu 64, but expired on May 5, 2019
  • Lily, run one Windows 10 (64-bit), the serial number of harddisk is 100304PBN2081SF3NJ5T
  • Tom, run on Raspberry Pi, mac address of network card is 70:f1:a1:23:f0:94, and expired on May 5, 2019
    cd /path/to/pyarmor

    # Create a project in the path `projects/simple`
    python pyarmor.py init --src=examples/simple --entry=queens.py projects/simple

    # Change to project path
    cd projects/simple

    # A shell script "pyarmor" is created here (In windows it is "pyarmor.bat")
    # Use command `build` to obfuscate all the `.py` in the project
    ./pyarmor build

    # Generate licenses for each customer
    #
    # For John, generate an expired license, new license in "licenses/john/license.lic"
    ./pyarmor licenses --expired 2019-03-05 john

    # For Lily, generate a license bind to harddisk, new license in "licenses/lily/license.lic"
    ./pyarmor licenses --bind-disk '100304PBN2081SF3NJ5T' lily

    # For Tom, generate an expired license bind to mac address, new license in "licenses/tom/license.lic"
    ./pyarmor licenses --bind-mac '70:f1:a1:23:f0:94' --expired 2019-03-05 tom

    # Create distribution package for John
    #
    mkdir -p customers/john

    # Copy obfuscated scripts
    cp -a dist/ customers/john

    # Replace default license
    cp licenses/john/license.lic customers/john/dist

    # Replace platform-dependent dynamic library `_pytransform`
    rm -f customer/john/dist/_pytransform.*
    wget http://pyarmor.dashingsoft.com/downloads/platforms/linux_x86_64/_pytransform.so -O customer/john/dist/_pytransform.so

    # Zip all files in the path `customer/john/dist`, distribute the archive to John

    # Do the same thing for Lily and Tom, except for platform-dependent dynamic library `_pytransform`
    #
    # For Lily
    wget http://pyarmor.dashingsoft.com/downloads/platforms/win_amd64/_pytransform.dll

    # For Tom
    wget http://pyarmor.dashingsoft.com/downloads/platforms/raspberrypi/_pytransform.so

Example 4: Build for py2exe

Learn from this example

  • How to pack obfuscated script with py2exe by command pack

First install py2xe

pip install py2exe

Then write setup.py for py2exe, here is an example script examples/py2exe/setup.py. There are 2 scripts in this example, entry script hello.py and queens.py. To be sure setup.py works,

cd /path/to/pyarmor
cd example/py2exe
python setup.py py2exe

Then run command pack to pack obfuscated scripts

cd ../..
python pyarmor.py pack --type py2exe examples/py2exe/hello.py

Check the output path of examples/py2exe/dist, the runtime files required by obfuscated scripts are copied here, and the library.zip is updated, the original queens.pyc replaced with obfuscated one.

For cx_Freeze and py2app, it's almost same as py2exe.

Example 5: Build for PyInstaller

Here is one of workaround to pack obfuscated scripts with PyInstaller, this example will distribute a script hello.py and moudle file queens.py

First obfuscate all the .py file in the path testmod to dist/obf

pyarmor obfuscate --src testmod --entry hello.py --no-restrict --output dist/obf

Then run pyinstaller to build the bundle to dist/hello/, this command will generate hello.spec either

cd /path/to/pyarmor/examples
pyinstaller testmod/hello.py

Edit hello.spec, change Analysis, add obfuscated script and date files as the following way

a = Analysis(['testmod/hello.py', 'dist/obf/hello.py'],
             datas=[('dist/obf/*.lic', '.'), ('dist/obf/*.key', '.'), ('dist/obf/_pytransform.*', '.')],

After Analysis, insert code to replace original python scrips and moudles with obfuscated ones

a.scripts[0] = 'hello', 'dist/obf/hello.py', 'PYSOURCE'
for i in range(len(a.pure)):
    if a.pure[i][1].startswith(a.pathex[0]):
        a.pure[i] = a.pure[i][0], a.pure[i][1].replace('/testmod/', '/dist/obf/'), a.pure[i][2]

Next run pyinstaller with this hello.spec

pyinstaller hello.spec

Finally run exetuable with obfuscated scripts

dist/hello/hello

# Check the scripts are obfuscated
rm dist/hello/license.lic
dist/hello/hello