Skip to content

Commit 2d45ba9

Browse files
committed
Rename to PyArmor
1 parent 0930399 commit 2d45ba9

19 files changed

+79
-79
lines changed

src/README.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Protect Python Scripts By Pyarmor
1+
Protect Python Scripts By PyArmor
22
=================================
33

4-
Pyarmor is a command line tool used to obfuscate python scripts, bind
4+
PyArmor is a command line tool used to obfuscate python scripts, bind
55
obfuscated scripts to fixed machine or expire obfuscated scripts. It
66
protects Python scripts by the following ways:
77

@@ -10,7 +10,7 @@ protects Python scripts by the following ways:
1010
* Clear f_locals of frame as soon as code object completed execution.
1111
* Verify the license file of obfuscated scripts while running it.
1212

13-
Look at what happened after ``foo.py`` is obfuscated by Pyarmor. Here
13+
Look at what happened after ``foo.py`` is obfuscated by PyArmor. Here
1414
are the files list in the output path ``dist``::
1515

1616
foo.py
@@ -74,7 +74,7 @@ Generate an expired license and run obfuscated scripts with new license::
7474
cd dist/
7575
python queens.py
7676

77-
Start webui, open web page in browser for basic usage of Pyarmor::
77+
Start webui, open web page in browser for basic usage of PyArmor::
7878

7979
pyarmor-webui
8080

src/config.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,11 @@
33
version = '4.6.2'
44

55
version_info = '''
6-
Pyarmor is a tool used to import or run the encrypted python scripts.
6+
PyArmor is a tool used to import or run the encrypted python scripts.
77
Only by a few extra files, pyarmor can run and imported encrypted
88
files in the normal python environments.
99
10-
Pyarmor just likes an enhancement which let python could run or import
10+
PyArmor just likes an enhancement which let python could run or import
1111
encrypted files.
1212
1313
'''
@@ -18,7 +18,7 @@
1818
encrypted files are encrypted by same key.
1919
2020
A registration code is required to generate random project capsule.
21-
If Pyarmor is helpful for you, please purchase one by visiting
21+
If PyArmor is helpful for you, please purchase one by visiting
2222
2323
https://order.shareit.com/cart/add?vendorid=200089125&PRODUCT[300871197]=1
2424

src/examples/README-ZH.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 示例([English Version](README.md)
22

3-
好的示例就是最好的老师,是最快的学习方式。在 Pyarmor 发布的包里面,就包
3+
好的示例就是最好的老师,是最快的学习方式。在 PyArmor 发布的包里面,就包
44
含了针对不同使用场景的脚本模板。这些脚本里面的注释很详细,按照里面的说
55
明进行正确的设置,就可以快速加密 Python 脚本。扩展名为 `.bat`
66
Windows 下使用,`.sh` 的在 Linux,MacOS 等上面使用。他们都存放在子目录
@@ -27,10 +27,10 @@ Windows 下使用,`.sh` 的在 Linux,MacOS 等上面使用。他们都存放
2727

2828

2929
除了这些脚本之外,这里还有一些真实的例子。现在打开一个命令窗口,按照下
30-
面文档中的说明,一步一步来学习 Pyarmor 的常用功能。
30+
面文档中的说明,一步一步来学习 PyArmor 的常用功能。
3131

3232
在下面的章节中,假定 Python 已经安装,并且可以使用 `python` 直接调用,
33-
Pyarmor 的安装路径是 `/path/to/pyarmor`
33+
PyArmor 的安装路径是 `/path/to/pyarmor`
3434

3535
示例命令格式是 Linux 的脚本命令,Windows 上使用需要转换成为对应的命令。
3636

@@ -157,7 +157,7 @@ Pyarmor 的安装路径是 `/path/to/pyarmor`
157157

158158
* 如何使用命令 `pack` 来打包加密的脚本
159159

160-
Pyarmor 需要使用第三方的打包工具,推荐工具是 `PyInstaller`, 首先安装
160+
PyArmor 需要使用第三方的打包工具,推荐工具是 `PyInstaller`, 首先安装
161161

162162
pip install pyinstaller
163163

src/examples/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Exmaples ([中文版](README-ZH.md))
22

33
A good example maybe is the best teacher. There are several sample
4-
shell scripts distributed with source package of Pyarmor. All of them
4+
shell scripts distributed with source package of PyArmor. All of them
55
are rich comment used to obfuscate Python scripts in different cases,
66
`.bat` for Windows, `.sh` for Linux and MacOS. Find them in the path
77
`examples`, edit the variables in it according to actual enviroments,
@@ -33,11 +33,11 @@ then run it to obfuscate your python scripts quickly.
3333
`PyInstaller`, `py2exe`, `py2app` or `cx_Freeze`.
3434

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

3939
In the rest sections, assume that Python is installed, it can be
40-
called `python`. And Pyarmor has been installed in the
40+
called `python`. And PyArmor has been installed in the
4141
`/path/to/pyarmor`.
4242

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

src/examples/build-for-exe.bat

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Set ENTRY_NAME=hello
3131
Set ENTRY_SCRIPT=%ENTRY_NAME%.py
3232
Set ENTRY_EXE=%ENTRY_NAME%.exe
3333

34-
REM TODO: Pyarmor project path to save project config file
34+
REM TODO: PyArmor project path to save project config file
3535
Set PROJECT=C:\Python34\Lib\site-packages\pyarmor\build-for-py2exe
3636

3737
REM TODO: Comment next line if not to test obfuscated scripts
@@ -59,7 +59,7 @@ If NOT ERRORLEVEL 0 (
5959
Goto END
6060
)
6161

62-
REM Check Pyarmor
62+
REM Check PyArmor
6363
If NOT EXIST "%PYARMOR_PATH%\pyarmor.py" (
6464
Echo.
6565
Echo No pyarmor found, check value of variable PYARMOR_PATH

src/examples/build-for-freeze.bat

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ If NOT ERRORLEVEL 0 (
5858
Goto END
5959
)
6060

61-
REM Check Pyarmor
61+
REM Check PyArmor
6262
If NOT EXIST "%PYARMOR_PATH%\pyarmor.py" (
6363
Echo.
6464
Echo No pyarmor found, check value of variable PYARMOR_PATH
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
title = 'Pyarmor Test Case'
1+
title = 'PyArmor Test Case'

src/mechanism.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# How to Obfuscate Python Script by Pyarmor
1+
# How to Obfuscate Python Script by PyArmor
22

3-
From Pyarmor 3.3, a new mode is introduced. By this way, no import
3+
From PyArmor 3.3, a new mode is introduced. By this way, no import
44
hooker, no setprofile, no settrace. The performance of running or
55
importing obfuscation python script has been remarkably improved.
66

7-
Pyarmor protects Python scripts by the following ways:
7+
PyArmor protects Python scripts by the following ways:
88

99
* Obfuscate source file to protect constants and literal strings.
1010
* Obfuscate byte code of each code object.
1111
* Clear f_locals of frame as soon as code object completed execution.
1212

13-
There are 2 different cases for Pyarmor to protect Python scripts:
13+
There are 2 different cases for PyArmor to protect Python scripts:
1414

1515
* Application, also called standalone package
1616
* Package used by others
1717

18-
In the first case, Pyarmor obfuscates all the Python Scripts belong to
18+
In the first case, PyArmor obfuscates all the Python Scripts belong to
1919
standalone application, and doesn't allow to import those obfuscated
2020
scripts from any other clear script. So a simple way can be apply, it
2121
called **Restrict Mode**.
@@ -26,7 +26,7 @@ accessed in outer. It need more work to protect Python scripts.
2626

2727
## Mechanism in Restrict Mode
2828

29-
In restrict mode, Pyarmor will restore obfuscated byte code when this
29+
In restrict mode, PyArmor will restore obfuscated byte code when this
3030
code object is called first time, and not obfuscate it again. It's
3131
efficient and enough, because code object can't be accessed from any
3232
other scripts, except obfuscated scripts.
@@ -172,7 +172,7 @@ This feature is introuced from v3.9.0
172172

173173
When restrict mode is disabled, it means obfuscated scripts can be
174174
imported from any other scripts. So every code object must be
175-
obfuscated again as soon as it returns. Pyarmor insert a
175+
obfuscated again as soon as it returns. PyArmor insert a
176176
`try...finally` block in each code object, it will modify each code
177177
object as the following way:
178178

@@ -211,7 +211,7 @@ locals in this frame.
211211

212212
### Implementation
213213

214-
From Pyarmor 3.9.0, there are 2 ways
214+
From PyArmor 3.9.0, there are 2 ways
215215

216216
* Use Command `obfuscate` with option `--no-restrict`
217217

@@ -269,7 +269,7 @@ From Pyarmor 3.9.0, there are 2 ways
269269

270270
## Performance Analaysis
271271

272-
With default configuration, Pyarmor will do the following extra work
272+
With default configuration, PyArmor will do the following extra work
273273
to run or import obfuscated bytecode:
274274

275275
- Load library _pytransform at startup
@@ -379,7 +379,7 @@ It's even faster than no obfuscated scripts!
379379

380380
# DEPRECATED Mode
381381

382-
The following modes are used by Pyarmor before v3.2.0. It requires
382+
The following modes are used by PyArmor before v3.2.0. It requires
383383
import hooker, for example, sys.meta_path, and sys.setprofile or
384384
sys.settrace. Especially the latter, it could dramatically effect
385385
performance.

src/packer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ def update_specfile(project, obfdist, src, entry, specfile):
216216
lines = f.readlines()
217217

218218
patched_lines = (
219-
"", "# Patched by Pyarmor",
219+
"", "# Patched by PyArmor",
220220
"a.scripts[0] = '%s', '%s', 'PYSOURCE'" % (
221221
entry[:-3], os.path.join(obfdist, entry)),
222222
"for i in range(len(a.pure)):",

src/platforms/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Downloads for Pyarmor Prebuilt Dynamic Library #
1+
# Downloads for PyArmor Prebuilt Dynamic Library #
22

33
Latest version: **4.0.5**
44

55
Build date: 2018-12-27
66

7-
The core of Pyarmor is written by C, the prebuilt dynamic libraries
7+
The core of PyArmor is written by C, the prebuilt dynamic libraries
88
include the common platforms and some embeded platforms. It's not
99
difficult to build for any other platform, even for embeded system
1010
(the only dependency is libc).

0 commit comments

Comments
 (0)