Skip to content

Commit

Permalink
Update README, usage docs and add news/ entry for change-log
Browse files Browse the repository at this point in the history
  • Loading branch information
naufraghi committed Feb 17, 2020
1 parent 34cfc32 commit bd95389
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -64,15 +64,15 @@ PyInstaller is available on PyPI. You can install it through `pip`::
Requirements and Tested Platforms
------------------------------------

- Python:
- Python:

- 3.5-3.7
- PyCrypto_ 2.4+ (only if using bytecode encryption)
- `tinyaes`_ 1.0+ (only if using bytecode encryption)

- Windows (32bit/64bit):

- Windows XP or newer.

- GNU/Linux (32bit/64bit)

- ldd: Console application to print the shared libraries required
Expand Down Expand Up @@ -127,14 +127,14 @@ enhancements on these are welcome.
Before using any contributed platform, you need to build the PyInstaller
bootloader, as we do not ship binary packages. Download PyInstaller
source, and build the bootloader::

cd bootloader
python ./waf distclean all

Then install PyInstaller::

python setup.py install

or simply use it directly from the source (pyinstaller.py).


Expand All @@ -155,6 +155,6 @@ http://www.pyinstaller.org/funding.html for how to support PyInstaller.



.. _PyCrypto: https://www.dlitz.net/software/pycrypto/
.. _`tinyaes`: https://github.com/naufraghi/tinyaes-py
.. _`manual`: https://pyinstaller.readthedocs.io/en/latest/

2 changes: 1 addition & 1 deletion doc/_common_definitions.txt
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
.. _pip-Win: https://sites.google.com/site/pydatalog/python/pip-for-windows
.. _plistlib: https://docs.python.org/3/library/plistlib.html
.. _png2icns: http://icns.sourceforge.net/
.. _PyCrypto: https://pypi.python.org/pypi/pycrypto/
.. _`tinyaes`: https://github.com/naufraghi/tinyaes-py
.. _PyInstaller.org: https://github.com/pyinstaller/pyinstaller/wiki/Community
.. _`PyInstaller at GitHub`: https://github.com/pyinstaller/pyinstaller
.. _`PyInstaller code signing recipe`: https://github.com/pyinstaller/pyinstaller/wiki/Recipe-OSX-Code-Signing
Expand Down
3 changes: 1 addition & 2 deletions doc/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -203,8 +203,7 @@ 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 PyCrypto_
module installed.
For this to work, you must have the `tinyaes`_ module installed.
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.
Expand Down
1 change: 1 addition & 0 deletions news/4652.bootloader.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update base library to support encrypting Python bytecode (``--key`` option)

0 comments on commit bd95389

Please sign in to comment.