diff --git a/docs/features/deploy.md b/docs/features/deploy.md new file mode 100644 index 00000000..16e6657e --- /dev/null +++ b/docs/features/deploy.md @@ -0,0 +1,32 @@ +--- +icon: dot +title: Deploy Bytecodes +order: 81 +--- + +!!! +The feature requires pocketpy version >= `2.1.7` +!!! + +You can deploy your pocketpy program as bytecode files. +It provides some sort of code obfuscation and may slightly improve the loading speed of your program. +It makes your users unable to get your source code directly, unless they do expensive reverse engineering. + +To compile a `.py` file into a `.pyc` bytecode file, you need the command-line executable `main`, +which can be simply built by running `python cmake_build.py` in the repository root. + + +## Example + +Once you have `main` executable, you can run the following command to compile `input_file.py`: + +```sh +./main --compile input_file.py output_file.pyc +``` + +Alternatively, you can invoke the `compileall.py` script in the repository root. +It compiles all `.py` files in the specified directory into `.pyc` files. + +```sh +python compileall.py ./main input_path output_path +``` \ No newline at end of file