Skip to content

Commit

Permalink
packaging/doc: support installing the encryption libraries as a extra…
Browse files Browse the repository at this point in the history
… and recommend it in the docs

[skip ci]
  • Loading branch information
Legorooj committed Jun 1, 2020
1 parent b5ebff3 commit 15ecf74
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,8 @@ Requirements and Tested Platforms
- Python:

- 3.5-3.7
- tinyaes_ 1.0+ (only if using bytecode encryption)
- tinyaes_ 1.0+ (only if using bytecode encryption).
Instead of installing tinyaes, ``pip install pyinstaller[encryption]`` instead.

- Windows (32bit/64bit):

Expand Down
8 changes: 6 additions & 2 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,12 +203,16 @@ To encrypt the Python bytecode modules stored in the bundle,
pass the ``--key=``\ *key-string* argument on
the command line.

For this to work, you must have the tinyaes_
module installed.
For this to work, you need to run::

pip install pyinstaller[encryption]

The *key-string* is a string of 16 characters which is used to
encrypt each file of Python byte-code before it is stored in
the archive inside the executable file.

This feature uses the tinyaes_ module internally for the encryption.


.. _defining the extraction location:

Expand Down
2 changes: 2 additions & 0 deletions setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ hook_testing =
pytest >= 2.7.3
execnet >= 1.5.0
psutil
encryption =
tinyaes>=1.0.0

[options.package_data]
# This includes precompiled bootloaders and icons for bootloaders
Expand Down

1 comment on commit 15ecf74

@johnthagen
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Please sign in to comment.