Skip to content

Latest commit

 

History

History
93 lines (85 loc) · 2.7 KB

buildinstructions.md

File metadata and controls

93 lines (85 loc) · 2.7 KB
Raw

Build instructions

In general please follow the build instructions as described in README.md. Here you will find a brief overview about what is needed to build your own development environment without further explanations.

Setup on OS X

Prerequisites

  • install python 3.10
  • install python extension compile environment, this is automatically done if you have xcode
  • install git

Clone the repository

git clone http://github.com/kliment/Printrun.git
cd Printrun
git pull

Install and activate the virtual environment

python3 -m venv v3
. ./v3/bin/activate

Install and update all required libraries

pip install --upgrade pip
pip install --upgrade setuptools
pip install -r requirements.txt
pip install cython
python setup.py build_ext --inplace

For running

python pronterface.py

For packaging

pip install pyinstaller
pyi-makespec --hidden-import="pkg_resources.py2_warn" -F --add-data images/\*:images --add-data \*.png:. --add-data \*.ico:. -w -i P-face.icns pronterface.py
rm -rf dist
sed -i '' '$ s/.$//' pronterface.spec
cat >> pronterface.spec <<EOL
,
info_plist={
    'NSPrincipalClass': 'NSApplication',
    'NSAppleScriptEnabled': False,
    'NSAppSleepDisabled': True,
  },
)
EOL
pyinstaller --clean pronterface.spec -y
(optional) codesign -s identityname dist/pronterface.app --deep

Setup on Windows

Prerequisites

Clone the repository

git clone http://github.com/kliment/Printrun.git
cd Printrun
git pull

Install and activate the virtual environment

\path\to\python3\python -m venv v3
v3\Scripts\activate
### Install and update all required libraries
pip install --upgrade pip
pip install --upgrade setuptools
pip install wheel
pip install cython
pip install -r requirements.txt
pip install simplejson
pip install pypiwin32
pip install polygon3
python setup.py build_ext --inplace

Please see remark for polygon31

For running

python pronterface.py

For packaging

pip install pyinstaller
pyi-makespec -F --add-data images/*;images --add-data *.png;. --add-data *.ico;. -w -i pronterface.ico pronterface.py
pyinstaller --clean pronterface.spec -y

[!TIP] Please find further informations about building a development environment and packaging in script release_windows.bat where we implemented an automated build for windows.

Remark:

Footnotes

  1. The library polygon3 is free for non commercial use. You can build Pronterface without this library - but then it will run slower. Please find further details regarding license here: https://pypi.org/project/Polygon3/ ↩