Skip to content

Commit 5ec20c5

Browse files
committed
Add notes
1 parent a9a0a97 commit 5ec20c5

File tree

1 file changed

+40
-0
lines changed

1 file changed

+40
-0
lines changed

src/user-guide.md

+40
Original file line numberDiff line numberDiff line change
@@ -299,6 +299,46 @@ How about the performance after scripts are obfuscated, run
299299
python pyarmor.py benchmark
300300
```
301301

302+
## Keypoints of Using Obfuscated Scripts
303+
304+
* Obfuscated script is a normal python script, so it can be seamless
305+
to replace original script.
306+
307+
* There is only one thing changed, the following code must be run
308+
before using any obfuscated script.
309+
310+
```
311+
from pytransform import pyarmor_runtime
312+
pyarmor_runtime()
313+
```
314+
315+
It can be put in any script anywhere, only if it run in the same
316+
Python interpreter. It will create some builtin function to deal with
317+
obfuscated code.
318+
319+
* In order to run these extra code, there are several extra files
320+
should be distributed with obfuscated scripts. They're called
321+
**runtime files**
322+
323+
```
324+
pytransform.py _pytransform.so or _pytransform.dll or _pytransform.dylib
325+
pyshield.key, pyshield.lic, product.key, license.lic
326+
```
327+
328+
Generally all of the runtime files will be generated in the output
329+
path when obfuscate python scripts.
330+
331+
* pytransform.py must be in any Python path in target machine.
332+
333+
* pytransform.py need load dynamic library **_pytransform** it may be
334+
**_pytransform.so** in Linux, **_pytransform.dll** in Windows,
335+
**_pytransform.dylib** in MacOS. It's dependent-platform, download
336+
the right one to the same path of pytransform.py if use obfuscated
337+
scripts in any other platform.
338+
339+
All the prebuilt dynamic libraries
340+
list [here](http://pyarmor.dashingsoft.com/downloads/platforms/)
341+
302342
## Configure File
303343

304344
Each project has a configure file. It's a json file, used to specify

0 commit comments

Comments
 (0)