so1us2 / gradle-miniconda-plugin

Plugin that sets up a Python environment for building and running tests using Miniconda.

Gradle Miniconda Plugin

Plugin that sets up a Python environment for building and running tests using Miniconda.

Usage

Apply the plugin to your project following https://plugins.gradle.org/plugin/com.palantir.python.miniconda, and configure the associated extension:

Minimal configuration:

miniconda {
    minicondaVersion = '3.19.0'
    packages = ['python']
}

Then invoke the setupPython task and use the resulting installation directory from Exec tasks:

task launchNotebook(type: Exec) {
    dependsOn 'setupPython'
    executable "${miniconda.buildEnvironmentDirectory}/bin/python"
    args '-c', 'print("Hello world!")'
}

Options

Name	Default Value	Description	Optional
minicondaVersion	N/A	The miniconda version which you want to use. See the miniconda repo	false
packages	N/A	The conda packages you want installed into your conda environment. This list must contain at least one argument.	false
bootstrapDirectoryPrefix	new File(System.getProperty('user.home'), '.miniconda')	The root directory to put the root install of miniconda. This helps performance by caching the root environment by pythonVersion and minicondaVersion.	true
buildEnvironmentDirectory	new File(buildDir, 'miniconda')	The directory to place your specific miniconda environment.	true
pythonVersion	2	The python version you want for your miniconda. If you want Miniconda3, this value is 3.	true
channels	['https://repo.continuum.io/pkgs/free']	The list of conda channels you want to use for downloading conda packages. Must not be empty.	true

Here is an example of the plugin with all the bells and whistles.

miniconda {
    bootstrapDirectoryPrefix = new File(System.getProperty('user.home'), '.miniconda')
    buildEnvironmentDirectory = new File(buildDir, 'python')
    minicondaVersion = '3.19.0'
    packages = ['ipython-notebook']
    pythonVersion = 2
    channels = ['https://repo.continuum.io/pkgs/free', 'conda-forge']
}

If you need to customize where the Miniconda installer script is downloaded from, you can add your artifact to the minicondaInstaller configuration. The default location where it is downloaded from is: https://repo.continuum.io.

Tasks

bootstrapPython

Installs Miniconda.

setupPython

Sets up conda environment in the project running conda create.

condaBuildSetup

Installs conda-build using conda install conda-build.

condaBuildCheck

Only checks (validates) the recipe.

condaBuild

Builds and packages the project using conda build.

License

Gradle Miniconda Plugin is released by Palantir Technologies, Inc. under the Apache 2.0 License. See the included LICENSE file for details.

Backwards Compatibility Breaks

0.5.0

The bootstrap Python is now placed in bootstrapDirectoryPrefix/python-$pythonVersion/miniconda-$minicondaVersion.

0.4.0

The bootstrap Python is now placed in bootstrapDirectoryPrefix/minicondaVersion. Users now must set bootstrapDirectoryPrefix instead of bootstrapDirectory. You can still get the new directory of the bootstrap Python by referring to the bootstrapDirectory property.