Create Beam Cruncher Linux Executable - crunchtec/Beam-Cruncher-Wiki GitHub Wiki

Clone the Beam-Cruncher Repository on a Linux OS

Use git to clone the Beam-Cruncher Repository (on master branch) on a Linux machine.

Get PyInstaller

Get PyInstaller by typing 'sudo apt-get install python-setuptools', then 'pip3 install pyinstaller' - if you do not have pip3 already, install it by using the command: 'sudo apt-get install python3-pip'.

Create Executable with PyInstaller

Important: Make sure that you can run the BeamCruncher.py script in your current environment - test all the features to make sure that they work on this machine. All dependencies must be installed in this environment for PyInstaller to build successfully.

While in the directory with 'BeamCruncher.py' (/Beam-Cruncher-Application/BeamCruncher.py), open a terminal and type the command: 'pyinstaller --onefile --icon=/resources/crunch_icon.png BeamCruncher.py'. PyInstaller will now compile the BeamCruncher.py script and all of its dependencies into one executable file - this will take several minutes. After the executable file is created, you can find it in the newly-created 'dist' folder.

Create New Beam Cruncher Release

Create a new release in the Beam-Cruncher repository. Give it a new version number with the format v[Major].[Minor].[Patch]. Roll the patch number if the version is backwards-compatible and is a bugfix. Roll the minor number if the version is backward-compatible and contains a new feature. Roll the major number only if this release has a new feature that is not backwards-compatible.

Add the BeamCruncher executable to this new release. Be sure to add a license and readme text file to the release (as well as update the readme file to reflect the changes in the new release). Lastly, zip the resources folder and include this 'resources.zip' file in the new release.