TASK_REFERENCE.md

Task Reference

Complete reference for all Gradle tasks available in the Bearsampp Python module build system.

Task Groups

Build Tasks

release

Build a release package for a specific Python version.

Group: build

Description: Build release package (interactive or use -PbundleVersion=X.X.X for non-interactive)

Usage:

# Interactive mode - lists available versions
gradle release

# Non-interactive mode - specify version
gradle release "-PbundleVersion=3.13.5"

Parameters:

bundleVersion (optional): Python version to build (e.g., "3.13.5")

Process:

Validates Python version exists in bin/ directory
Creates temporary build directory
Copies bundle files (excludes pyqt5)
Upgrades PIP to latest version
Downloads wheel packages from wheel.properties
Installs wheel packages using install.bat
Creates 7z archive in release directory
Cleans up temporary files

Output:

Release archive: {buildPath}/release/python{version}.7z

Example:

gradle release "-PbundleVersion=3.13.5"

Exit Codes:

0: Success
1: Version not found
2: PIP upgrade failed
3: Wheel installation failed
4: Archive creation failed

clean

Clean build artifacts and temporary files.

Group: build

Description: Clean build artifacts and temporary files

Usage:

gradle clean

Cleans:

build/ directory (Gradle build output)
Temporary build directories in configured build path

Example:

gradle clean

Verification Tasks

verify

Verify build environment and dependencies.

Group: verification

Description: Verify build environment and dependencies

Usage:

gradle verify

Checks:

✓ Java 8+ installed
✓ build.gradle exists
✓ build.properties exists
✓ releases.properties exists
✓ dev directory exists
✓ bin directory exists
✓ Python versions available
✓ 7-Zip command available

Output:

Environment Check Results:
------------------------------------------------------------
  [PASS]     Java 8+
  [PASS]     build.gradle
  [PASS]     build.properties
  [PASS]     releases.properties
  [PASS]     dev directory
  [PASS]     bin directory
  [PASS]     Python versions available
  [PASS]     7-Zip available
------------------------------------------------------------

[SUCCESS] All checks passed! Build environment is ready.

Example:

gradle verify

validateProperties

Validate build.properties configuration.

Group: verification

Description: Validate build.properties configuration

Usage:

gradle validateProperties

Validates:

bundle.name is present and not empty
bundle.release is present and not empty
bundle.type is present and not empty
bundle.format is present and not empty

Output:

Validating build.properties...
[SUCCESS] All required properties are present:
    bundle.name = python
    bundle.release = 2025.8.21
    bundle.type = tools
    bundle.format = 7z

Example:

gradle validateProperties

validatePythonVersion

Validate Python version directory structure.

Group: verification

Description: Validate Python version directory structure (use -PbundleVersion=X.X.X)

Usage:

gradle validatePythonVersion "-PbundleVersion=3.13.5"

Parameters:

bundleVersion (required): Python version to validate

Checks:

✓ Version directory exists
✓ bin/ subdirectory exists
✓ wheel/ subdirectory exists
✓ bearsampp.conf file exists
✓ bin/python.bat file exists
✓ wheel.properties file exists
✓ install.bat file exists
✓ Wheel URL is defined in wheel.properties

Output:

Validating Python version 3.13.5...
------------------------------------------------------------

Validation Results:
------------------------------------------------------------
  [PASS]     bin directory
  [PASS]     wheel directory
  [PASS]     bearsampp.conf
  [PASS]     bin/python.bat
  [PASS]     wheel.properties
  [PASS]     install.bat
  [PASS]     wheel URL defined
------------------------------------------------------------

[SUCCESS] Python version 3.13.5 structure is valid

Example:

gradle validatePythonVersion "-PbundleVersion=3.13.5"

Help Tasks

info

Display build configuration information.

Group: help

Description: Display build configuration information

Usage:

gradle info

Displays:

Project name, version, description
Bundle properties (name, release, type, format)
Path configuration
Java version and home
Gradle version and home
Python build features
Available task groups
Quick start commands

Example:

gradle info

listVersions

List all available Python bundle versions in bin/ directory.

Group: help

Description: List all available Python bundle versions in bin/ directory

Usage:

gradle listVersions

Output:

Available python versions in bin/:
------------------------------------------------------------
  3.10.6
  3.10.9
  3.11.5
  3.11.8
  3.12.2
  3.12.9 [wheel: PyQt5-5.15.9-cp312-cp312-win_amd64.whl]
  3.13.2
  3.13.3
  3.13.5 [wheel: PyQt5-5.15.9-cp313-cp313-win_amd64.whl]
------------------------------------------------------------
Total versions: 9

To build a specific version:
  gradle release "-PbundleVersion=3.13.5"

Example:

gradle listVersions

listReleases

List all available releases from releases.properties.

Group: help

Description: List all available releases from releases.properties

Usage:

gradle listReleases

Output:

Available Python Releases:
--------------------------------------------------------------------------------
  3.10.6          -> https://www.python.org/ftp/python/3.10.6/python-3.10.6-amd64.exe
  3.10.9          -> https://www.python.org/ftp/python/3.10.9/python-3.10.9-amd64.exe
  3.11.5          -> https://www.python.org/ftp/python/3.11.5/python-3.11.5-amd64.exe
  ...
--------------------------------------------------------------------------------
Total releases: 12

Example:

gradle listReleases

showWheelInfo

Display wheel package information for a Python version.

Group: help

Description: Display wheel package information for a Python version (use -PbundleVersion=X.X.X)

Usage:

gradle showWheelInfo "-PbundleVersion=3.13.5"

Parameters:

bundleVersion (required): Python version to check

Output:

Wheel Information for Python 3.13.5:
======================================================================
  Wheel URL:  https://files.pythonhosted.org/packages/.../PyQt5-5.15.9-cp313-cp313-win_amd64.whl
  Wheel File: PyQt5-5.15.9-cp313-cp313-win_amd64.whl
  Location:   E:/Bearsampp-development/module-python/bin/python3.13.5/wheel

  Install Script: E:/Bearsampp-development/module-python/bin/python3.13.5/wheel/install.bat
  Content:
  ------------------------------------------------------------------
  @echo off
  cd ..
  bin\python.bat -m pip install wheel\PyQt5-5.15.9-cp313-cp313-win_amd64.whl
======================================================================

Example:

gradle showWheelInfo "-PbundleVersion=3.13.5"

tasks

List all available tasks (built-in Gradle task).

Group: help

Description: Displays the tasks runnable from root project 'module-python'

Usage:

# List main tasks
gradle tasks

# List all tasks including internal tasks
gradle tasks --all

Example:

gradle tasks

Task Dependencies

Dependency Graph

release
  (no dependencies)

clean
  (no dependencies)

verify
  (no dependencies)

validateProperties
  (no dependencies)

validatePythonVersion
  (no dependencies)

info
  (no dependencies)

listVersions
  (no dependencies)

listReleases
  (no dependencies)

showWheelInfo
  (no dependencies)

Common Task Combinations

Full Build Workflow

# 1. Verify environment
gradle verify

# 2. List available versions
gradle listVersions

# 3. Validate specific version
gradle validatePythonVersion "-PbundleVersion=3.13.5"

# 4. Build release
gradle release "-PbundleVersion=3.13.5"

Development Workflow

# Check configuration
gradle validateProperties

# View build info
gradle info

# Build and test
gradle release "-PbundleVersion=3.13.5"

# Clean up
gradle clean

Troubleshooting Workflow

# Verify environment
gradle verify

# Check version structure
gradle validatePythonVersion "-PbundleVersion=3.13.5"

# Check wheel configuration
gradle showWheelInfo "-PbundleVersion=3.13.5"

# Try build with debug output
gradle release "-PbundleVersion=3.13.5" --debug

Task Options

Global Options

These options work with any task:

# Show stack traces
gradle <task> --stacktrace

# Show full stack traces
gradle <task> --full-stacktrace

# Debug output
gradle <task> --debug

# Info output
gradle <task> --info

# Quiet output
gradle <task> --quiet

# Dry run (don't execute)
gradle <task> --dry-run

# Continue on failure
gradle <task> --continue

# Refresh dependencies
gradle <task> --refresh-dependencies

# No daemon
gradle <task> --no-daemon

# Offline mode
gradle <task> --offline

Performance Options

# Parallel execution
gradle <task> --parallel

# Max workers
gradle <task> --max-workers=4

# Build cache
gradle <task> --build-cache

# No build cache
gradle <task> --no-build-cache

# Configuration cache
gradle <task> --configuration-cache

# No configuration cache
gradle <task> --no-configuration-cache

Exit Codes

All tasks follow standard exit code conventions:

0: Success
1: General error
2: Configuration error
3: Execution error
4: Validation error

Task Output

Success Output

================================================================
  Bearsampp Module Python - Pure Gradle Build
================================================================

Building release for python version 3.13.5...
======================================================================
Bundle path: E:/Bearsampp-development/module-python/bin/python3.13.5

Python-specific build steps:
  1. Copying bundle files...
  2. Upgrading PIP to latest version...
  3. Processing wheel packages...
     Downloading: PyQt5-5.15.9-cp313-cp313-win_amd64.whl
     Installing wheel packages...
  4. Creating release archive...

======================================================================
[SUCCESS] Release build completed successfully for version 3.13.5
Release file: C:/Users/user/Bearsampp-build/release/python3.13.5.7z
======================================================================

Error Output

FAILURE: Build failed with an exception.

* What went wrong:
Execution failed for task ':release'.
> Bundle version not found: E:/Bearsampp-development/module-python/bin/python3.13.5

Available versions in bin/:
  - 3.12.9
  - 3.13.3

* Try:
> Run with --stacktrace option to get the stack trace.
> Run with --info or --debug option to get more log output.
> Run with --scan to get full insights.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Task Reference

Task Groups

Build Tasks

release

clean

Verification Tasks

verify

validateProperties

validatePythonVersion

Help Tasks

info

listVersions

listReleases

showWheelInfo

tasks

Task Dependencies

Dependency Graph

Common Task Combinations

Full Build Workflow

Development Workflow

Troubleshooting Workflow

Task Options

Global Options

Performance Options

Exit Codes

Task Output

Success Output

Error Output

See Also

Uh oh!

FilesExpand file tree

TASK_REFERENCE.md

Latest commit

History

TASK_REFERENCE.md

File metadata and controls

Task Reference

Task Groups

Build Tasks

release

clean

Verification Tasks

verify

validateProperties

validatePythonVersion

Help Tasks

info

listVersions

listReleases

showWheelInfo

tasks

Task Dependencies

Dependency Graph

Common Task Combinations

Full Build Workflow

Development Workflow

Troubleshooting Workflow

Task Options

Global Options

Performance Options

Exit Codes

Task Output

Success Output

Error Output

See Also