Module for generating Baseline packages for deployment
Project description
Baseline Builder
Python-based tooling for generating Baseline packages, for streamlining package building of multiple clients. Designed for easier CI/CD integration with Python 3.
Features implemented:
- Resolves local files such as scripts, packages and images to Baseline packaging
- Scans in same directory as invocation script
- Calculates MD5 for scripts and packages
- Determines Team ID for local packages
- Easy imports for chaining into larger CI/CD workflows
- Validates existing packages
Logic
Baseline Builder works by taking configuration files for Baseline, and generating a package for deployment. If scripts, packages or images are declared in the file, Baseline Builder will attempt to resolve them and embed inside the package.
- See Baseline's documentation on how to configure: Baseline Wiki
- If an mobileconfig is provided as input, a resolved version will be written next to the package.
- As the mobileconfig method is meant to be used, no BaselineConfig.plist is embedded in the package.
Example configuration can be found in the Samples directory. Below is pulled from RIPEDA Engineering configuration:
<key>Packages</key>
<array>
<dict>
<key>DisplayName</key>
<string>Printer</string>
<key>PackagePath</key>
<string>Assets/Packages/Printer.pkg</string>
<key>Icon</key>
<string>Assets/Icons/Printer.png</string>
</dict>
</array>
The project will attempt to resolve the PackagePath
and Icon
keys through scanning the local directory:
Baseline Builder Directory:
- client.plist
- Assets:
- Packages:
- Printer.pkg
- Icons:
- Printer.png
Installation
pip3 install baseline-builder
Usage
Building
import baseline
baseline_obj = baseline.BaselineBuilder(
configuration_file="ripeda.plist",
identifier="com.ripeda.baseline.engineering",
version="1.0.0",
output="RIPEDA Baseline.pkg"
)
baseline_obj.build()
print("Package built successfully")
After a build is complete, optional .validate_pkg()
can be invoked to decompress and validate the package contents automatically.
Validating existing packages via command line
For quick validation of existing packages, the -v/--validate
flag can be used to decompress and validate the package contents automatically.
If the package lacks a BaselineConfig.plist, a mobileconfig can be provided to validate against.
# Validate package with mobileconfig
python3 baseline.py --validate "RIPEDA.pkg" ripeda.mobileconfig
# Validate package without config (embedded in pkg)
python3 baseline.py --validate "RIPEDA.pkg"
# Example Output
$ python3 baseline.py --validate RIPEDA.pkg
Performing post-build validation...
Validating configuration file...
Validating Icon: Zoom.icns...
Validating Installomator label: zoom...
Validating Icon: Chrome.icns...
Validating Installomator label: googlechromepkg...
Validating PackagePath: Printer.pkg...
Calculating MD5 for: Printer.pkg...
Determining Team ID for: Printer.pkg...
Validating Icon: Scripts-Printer.png...
Validating ScriptPath: universal_remove_stock_apps.sh...
Calculating MD5 for: universal_remove_stock_apps.sh...
Validating Icon: Scripts-Stock-Apps.png...
Validating ScriptPath: universal_dock.sh...
Calculating MD5 for: universal_dock.sh...
Validating Icon: Scripts-Dock.png...
Configuration file is valid.
Post-build validation complete.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distributions
Built Distribution
File details
Details for the file baseline_builder-1.7.0-py3-none-any.whl
.
File metadata
- Download URL: baseline_builder-1.7.0-py3-none-any.whl
- Upload date:
- Size: 10.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.0.0 CPython/3.11.8
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d4665cef6d72bddd3a6910e3bf6ecc8bd3efc7d94268b1ec92b0251bc468254f |
|
MD5 | e07c3620a9c02813c6b44bfa5250329c |
|
BLAKE2b-256 | 7d85387b51fe3e1b0b7d77ac68dda9d5201a08407663a505d99cef31d0325677 |