revpi/revpicommander
1
0
Fork 0
mirror of https://github.com/naruxde/revpicommander.git synced 2025-11-08 16:43:53 +01:00
Code Issues Packages Releases Wiki Activity

build: Upgrade buildsystem with new Makefile and make.bat

Browse Source 
If a PyInstaller target is called from the Makefile, all libraries
installed in the virtual environment are captured with version and
license. The file 'bundled-libraries.md' contains a list of libraries
with version and license. The file 'open-source-licenses.txt'
includes the name, version, author, project URL, description and
complete license for each installed library. The files are included
in the output of the PyInstaller.
This commit is contained in:
Sven Sager
2023-10-01 13:45:02 +02:00
parent d2be450d98
commit 24f4d688ba
3 changed files with 145 additions and 59 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
Makefile
View File

@@ -19,7 +19,7 @@ endif
SYSTEM_PYTHON = python3 SYSTEM_PYTHON = python3
PYTHON = $(or $(wildcard $(VENV_PATH)/bin/python), $(SYSTEM_PYTHON)) PYTHON = $(or $(wildcard $(VENV_PATH)/bin/python), $(SYSTEM_PYTHON))
APP_VERSION = $(shell $(PYTHON) src/$(PACKAGE) --version) APP_VERSION = $(shell "$(PYTHON)" src/$(PACKAGE) --version | cut -d ' ' -f 2)
all: build_ui build_rc test build all: build_ui build_rc test build
@@ -27,55 +27,105 @@ all: build_ui build_rc test build
## Environment ## Environment
venv-info: venv-info:
echo Using path: "$(VENV_PATH)" @echo Environment for $(APP_NAME) $(APP_VERSION)
@echo Using path: "$(VENV_PATH)"
exit 0 exit 0
venv: venv:
$(SYSTEM_PYTHON) -m venv --system-site-packages "$(VENV_PATH)" # Start with empty environment
source $(VENV_PATH)/bin/activate && \ "$(SYSTEM_PYTHON)" -m venv "$(VENV_PATH)"
source "$(VENV_PATH)/bin/activate" && \
python3 -m pip install --upgrade pip && \ python3 -m pip install --upgrade pip && \
python3 -m pip install -r requirements.txt python3 -m pip install -r requirements.txt
exit 0 exit 0
.PHONY: venv-info venv venv-ssp:
# Include system installed site-packages and add just missing modules
"$(SYSTEM_PYTHON)" -m venv --system-site-packages "$(VENV_PATH)"
source "$(VENV_PATH)/bin/activate" && \
python3 -m pip install --upgrade pip && \
python3 -m pip install -r requirements.txt
exit 0
.PHONY: venv-info venv venv-ssp
## Compile Qt UI files to python code ## Compile Qt UI files to python code
build_ui: build-ui:
cd ui_dev && for ui_file in *.ui; do \ cd ui_dev && for ui_file in *.ui; do \
file_name=$${ui_file%.ui}; \ file_name=$${ui_file%.ui}; \
$(PYTHON) -m PyQt5.uic.pyuic $${ui_file} -o ../src/$(PACKAGE)/ui/$${file_name}_ui.py -x --from-imports; \ "$(PYTHON)" -m PyQt5.uic.pyuic $${ui_file} -o ../src/$(PACKAGE)/ui/$${file_name}_ui.py -x --from-imports; \
echo $${file_name}; \ echo $${file_name}; \
done done
build_rc: build-rc:
cd ui_dev && for rc_file in *.qrc; do \ cd ui_dev && for rc_file in *.qrc; do \
file_name=$${rc_file%.qrc}; \ file_name=$${rc_file%.qrc}; \
$(PYTHON) -m PyQt5.pyrcc_main $${rc_file} -o ../src/$(PACKAGE)/ui/$${file_name}_rc.py; \ "$(PYTHON)" -m PyQt5.pyrcc_main $${rc_file} -o ../src/$(PACKAGE)/ui/$${file_name}_rc.py; \
echo $${file_name}; \ echo $${file_name}; \
done done
update_translation: update-translation:
$(PYTHON) -m PyQt5.pylupdate_main translate.pro "$(PYTHON)" -m PyQt5.pylupdate_main translate.pro
.PHONY: build_ui build_rc update_translation .PHONY: build-ui build-rc update-translation
## Build steps ## Build steps
build: build_ui build_rc build:
$(PYTHON) -m setup sdist "$(PYTHON)" -m setup sdist
$(PYTHON) -m setup bdist_wheel "$(PYTHON)" -m setup bdist_wheel
install: test build install: build
$(PYTHON) -m pip install dist/$(PACKAGE)-*.whl "$(PYTHON)" -m pip install dist/$(PACKAGE)-$(APP_VERSION)-*.whl
uninstall: uninstall:
$(PYTHON) -m pip uninstall --yes $(PACKAGE) "$(PYTHON)" -m pip uninstall --yes $(PACKAGE)
.PHONY: test build install uninstall .PHONY: test build install uninstall
## PyInstaller ## PyInstaller
installer_mac: build_ui build_rc app-licenses:
$(PYTHON) -m PyInstaller -n $(APP_NAME) \ mkdir -p dist
# Create a list of all installed libraries, their versions and licenses
"$(PYTHON)" -m piplicenses \
--format=markdown \
--output-file dist/bundled-libraries.md
# Create a list of installed libraries with complete project information
"$(PYTHON)" -m piplicenses \
--with-authors \
--with-urls \
--with-description \
--with-license-file \
--no-license-path \
--format=json \
--output-file dist/open-source-licenses.json
"$(PYTHON)" -m piplicenses \
--with-authors \
--with-urls \
--with-description \
--with-license-file \
--no-license-path \
--format=plain-vertical \
--output-file dist/open-source-licenses.txt
app: build-ui build-rc app-licenses
"$(PYTHON)" -m PyInstaller -n $(APP_NAME) \
--add-data="src/$(PACKAGE)/locale:./$(PACKAGE)/locale" \ --add-data="src/$(PACKAGE)/locale:./$(PACKAGE)/locale" \
--add-data="dist/bundled-libraries.md:$(PACKAGE)/open-source-licenses" \
--add-data="dist/open-source-licenses.*:$(PACKAGE)/open-source-licenses" \
--add-data="data/$(PACKAGE).ico:." \
--add-data="data/$(PACKAGE).png:." \
--icon=data/$(PACKAGE).ico \
--noconfirm \
--clean \
--onedir \
--windowed \
src/$(PACKAGE)/__main__.py
app-mac: build-ui build-rc app-licenses
"$(PYTHON)" -m PyInstaller -n $(APP_NAME) \
--add-data="src/$(PACKAGE)/locale:./$(PACKAGE)/locale" \
--add-data="dist/bundled-libraries.md:$(PACKAGE)/open-source-licenses" \
--add-data="dist/open-source-licenses.*:$(PACKAGE)/open-source-licenses" \
--add-data="data/$(PACKAGE).icns:." \ --add-data="data/$(PACKAGE).icns:." \
--icon=data/$(PACKAGE).icns \ --icon=data/$(PACKAGE).icns \
--noconfirm \ --noconfirm \
@@ -86,7 +136,7 @@ installer_mac: build_ui build_rc
--codesign-identity $(APPLE_SIG) \ --codesign-identity $(APPLE_SIG) \
src/$(PACKAGE)/__main__.py src/$(PACKAGE)/__main__.py
installer_mac_dmg: installer_mac app-mac-dmg: app-mac
mkdir dist/dmg mkdir dist/dmg
mv dist/$(APP_NAME).app dist/dmg mv dist/$(APP_NAME).app dist/dmg
create-dmg \ create-dmg \
@@ -104,25 +154,19 @@ installer_mac_dmg: installer_mac
dist/$(APP_NAME)\ $(APP_VERSION).dmg \ dist/$(APP_NAME)\ $(APP_VERSION).dmg \
dist/dmg dist/dmg
installer_linux: build_ui build_rc .PHONY: app-licenses app app-mac app-mac-dmg
$(PYTHON) -m PyInstaller -n $(APP_NAME) \
--add-data="src/$(PACKAGE)/locale:./$(PACKAGE)/locale" \
--add-data="data/$(PACKAGE).ico:." \
--add-data="data/$(PACKAGE).png:." \
--icon=data/$(PACKAGE).ico \
--noconfirm \
--clean \
--onedir \
--windowed \
src/$(PACKAGE)/__main__.py
.PHONY: installer_mac installer_mac_dmg installer_linux
## Clean ## Clean
clean: clean:
rm -rf build dist src/*.egg-info *.spec # PyTest caches
rm -rf .pytest_cache
# Build artifacts
rm -rf build dist src/*.egg-info
# PyInstaller created files
rm -rf *.spec
distclean: clean distclean: clean
rm -rf $(VENV_PATH) # Virtual environment
rm -rf "$(VENV_PATH)"
.PHONY: clean distclean .PHONY: clean distclean

81
make.bat
View File

@@ -2,38 +2,77 @@
set PACKAGE=revpicommander set PACKAGE=revpicommander
set APP_NAME=RevPi Commander set APP_NAME=RevPi Commander
set PYTHON=venv\\Scripts\\python.exe
if "%1" == "venv" goto venv if "%1" == "venv" goto venv
if "%1" == "installer" goto installer if "%1" == "test" goto test
if "%1" == "build" goto build
if "%1" == "app" goto app
if "%1" == "clean" goto clean if "%1" == "clean" goto clean
if "%1" == "distclean" goto distclean
echo Make script for "%APP_NAME%" on Windows echo Make script for "%APP_NAME%" on Windows
echo. echo.
echo Need action: echo Need action:
echo venv Create / update your virtual environment for build process echo venv Create your virtual environment for build process
echo installer Build this application with PyInstaller echo test Run defined tests of the project
echo clean Clean up your environment after build process echo build Build PIP packages as source distribution and Wheel
echo app Build this application with PyInstaller
echo clean Clean up build artifacts after build process
echo distclean Same as clean plus removing virtual environment
goto end goto end
:venv :venv
python -m venv venv python -m venv venv
venv\\Scripts\\pip.exe install --upgrade -r requirements.txt venv\\Scripts\\pip.exe install -r requirements.txt
goto end goto end
:installer :test
venv\\Scripts\\pyinstaller -n "%APP_NAME%" ^ set PYTHONPATH=src
--add-data="src\%PACKAGE%\locale;.\%PACKAGE%\locale" ^ %PYTHON% -m pytest
--add-data="data\%PACKAGE%.ico;." ^ goto end
--icon=data\\%PACKAGE%.ico ^
--noconfirm ^ :build
--clean ^ %PYTHON% -m setup sdist
--onedir ^ %PYTHON% -m setup bdist_wheel
--windowed ^ goto end
src\\%PACKAGE%\\__main__.py
goto end :app
mkdir dist
%PYTHON% -m piplicenses ^
--format=markdown ^
--output-file dist/bundled-libraries.md
%PYTHON% -m piplicenses ^
--with-authors ^
--with-urls ^
--with-description ^
--with-license-file ^
--no-license-path ^
--format=json ^
--output-file dist/open-source-licenses.json
%PYTHON% -m piplicenses ^
--with-authors ^
--with-urls ^
--with-description ^
--with-license-file ^
--no-license-path ^
--format=plain-vertical ^
--output-file dist/open-source-licenses.txt
%PYTHON% -m PyInstaller -n "%APP_NAME%" ^
--add-data="dist/bundled-libraries.md;%PACKAGE%\open-source-licenses" ^
--add-data="dist/open-source-licenses.*;%PACKAGE%\open-source-licenses" ^
--noconfirm ^
--clean ^
--onefile ^
src\\%PACKAGE%\\__main__.py
goto end
:distclean
rmdir /S /Q venv
:clean :clean
rmdir /S /Q build dist rmdir /S /Q .pytest_cache
rmdir /S /Q src\%PACKAGE%.egg-info rmdir /S /Q build dist src\%PACKAGE%.egg-info
del *.spec del /Q *.spec
:end :end

7
requirements.txt
View File

@@ -1,7 +1,10 @@
setuptools>=65.6.3 # Build dependencies
wheel pip-licenses
Pyinstaller Pyinstaller
setuptools
wheel
# Runtime dependencies, must match install_requires in setup.py
keyring>=23.13.1 keyring>=23.13.1
PyQt5>=5.14.1 PyQt5>=5.14.1
paramiko>=2.12.0 paramiko>=2.12.0