https://github.com/likianta/pyportable-crypto
Crypto plugin for pyportable-installer project.
https://github.com/likianta/pyportable-crypto
Last synced: about 1 month ago
JSON representation
Crypto plugin for pyportable-installer project.
- Host: GitHub
- URL: https://github.com/likianta/pyportable-crypto
- Owner: likianta
- License: mit
- Created: 2021-09-11T18:20:32.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-08-12T08:24:11.000Z (2 months ago)
- Last Synced: 2025-08-12T10:22:55.680Z (2 months ago)
- Language: Python
- Homepage:
- Size: 2.5 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# PyPortable Crypto
- [中文版](./README.zh.md) (内容已过时, 待更新)
An experimental encryption tool for encrypting Python code.
Warning: This project is under proof-in-concept stage, no guarantee for
production use.
## Installation
```shell
pip install pyportable-crypto
```
## Usage
Both can be used in command line and Python script.
### Get help
For command line usage, check the help info below:
```shell
# list all commands
python -m pyportable_crypto -h
# get help for specific command
python -m pyportable_crypto -h
```
For Python script usage, check the docstrings of the public functions in `pyportable_crypto/__init__.py`.
### Encrypt/decrypt a snippet of text
In command line:
```shell
python -m pyportable_crypto encrypt-text
python -m pyportable_crypto decrypt-text
```
In Python script:
```python
from pyportable_crypto import encrypt_data
encrypt_data('hello-world', key='test123')
# -> b'LQ02l/s/fanlGsad8rQZcw=='
encrypt_data(b'hello-world', key='test123')
# -> b'LQ02l/s/fanlGsad8rQZcw=='
from pyportable_crypto import decrypt_data
decrypt_data(b'LQ02l/s/fanlGsad8rQZcw==', key='test123')
# -> b'hello-world'
```
### Compile Python modules/packages
It is slightly different with `encrypt_data`, that we add a bit of wrapper code
to make the module still works feeling like it is a normal module.
```python
from pyportable_crypto import compile_file
compile_file('hello_world.py', 'hello_world_enc.py', key='test123')
from pyportable_crypto import compile_dir
compile_dir(
'example_package',
'example_package_enc',
key='test123',
add_runtime_package='outside' # 'inside' | 'outside' | 'no'
)
```
- For the first time compilation, it will take one minute or so.
The subsequent calls with the same key will be much faster since it is cached.
- The compiled file is also ".py" file, you can open it with any text editor.
The content would be like this:
- There will create a side package `pyportable_runtime` besides
"hello_world_enc.py", or, for `compile_dir` it is created depending on the
value of `[param]add_runtime_package`.
For example `add_runtime_package='inside'` is:
```
|= example_package
|- __init__.py
|- foo.py
|- bar.py
|= example_package_enc
|- __init__.py
|- foo.py # encrypted
|- bar.py # encrypted
|= pyportable_runtime # inside
|- __init__.py
|- cipher.pyd
```
For `add_runtime_package='outside'` is:
```
|= example_package
|- __init__.py
|- foo.py
|- bar.py
|= example_package_enc
|- __init__.py
|- foo.py # encrypted
|- bar.py # encrypted
|= pyportable_runtime # outside
|- __init__.py
|- cipher.pyd
```
- You can import the result and use it like a normal module.
```python
from hello_world import echo
echo('hello world')
# -> 'hello world'
# note: add the following line at the top of your script.
import pyportable_runtime # noqa
pyportable_runtime.setup() # just do it once. will be globally effected.
from hello_world_enc import echo
echo('hello world')
# -> 'hello world'
```