ssh-audit/windows_build.txt

Below are notes for creating a Windows executable.

An executable can only be made on a Windows host because the PyInstaller tool (https://www.pyinstaller.org/) does not support cross-compilation.

On a Windows machine, do the following:

1.) Install Python v3.7.x from https://www.python.org/.  (As of this writing v3.8.0 isn't supported.)  To make life easier, check the option to add Python to the PATH environment variable.

2.) Using pip, install pyinstaller and colorama:

    pip install pyinstaller colorama

3.) Create the executable with:

    cd src\ssh_audit
    rename ssh_audit.py ssh-audit.py
    pyinstaller -D --icon ..\..\windows_icon.ico --add-data policies;policies ssh-audit.py

4.) Rename the "dist\ssh-audit\" folder to "dist\ssh-audit vX.X.X\"

5.) Zip the "dist\ssh-audit vX.X.X\" folder and name it "windows_ssh-audit_vX.X.X.zip" (hint: zip windows_ssh-audit_vX.X.X.zip -r "ssh-audit vX.X.X").
Added Windows build instructions and icon. 2019-11-30 22:55:43 +01:00			`Below are notes for creating a Windows executable.`

			`An executable can only be made on a Windows host because the PyInstaller tool (https://www.pyinstaller.org/) does not support cross-compilation.`

			`On a Windows machine, do the following:`

			`1.) Install Python v3.7.x from https://www.python.org/. (As of this writing v3.8.0 isn't supported.) To make life easier, check the option to add Python to the PATH environment variable.`

			`2.) Using pip, install pyinstaller and colorama:`

			`pip install pyinstaller colorama`

			`3.) Create the executable with:`

Improve PyPI packaging (#71) * Move files for better setup.py packaging * Update setup.py and configs for src layout * Run tests on setup.py build In effect, this tests that the setup.py configuration is correct. coverage combine and coverage:paths are added to keep the displayed coverage paths as src/ssh_audit/.py instead of .tox/$envname//site-packages/ssh_audit/.py * Remove unnecessary encoding declarations Python 3 defaults to UTF-8 encoding. https://docs.python.org/3/reference/lexical_analysis.html#encoding-declarations * Remove shebang from colorama type stubs Shouldn't need to be an executable. Related: git has this file tracked as chmod -x. 2020-10-11 20:03:02 +02:00			`cd src\ssh_audit`
			`rename ssh_audit.py ssh-audit.py`
			`pyinstaller -D --icon ..\..\windows_icon.ico --add-data policies;policies ssh-audit.py`
Added Windows build instructions and icon. 2019-11-30 22:55:43 +01:00
Updated Windows build instructions. 2020-09-28 01:32:23 +02:00			`4.) Rename the "dist\ssh-audit\" folder to "dist\ssh-audit vX.X.X\"`

Updated packaging notes and snap build process. 2020-09-29 16:24:36 +02:00			`5.) Zip the "dist\ssh-audit vX.X.X\" folder and name it "windows_ssh-audit_vX.X.X.zip" (hint: zip windows_ssh-audit_vX.X.X.zip -r "ssh-audit vX.X.X").`