io.github.cdklabs.projen.python

Class Pip

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.python.Pip

All Implemented Interfaces:

IPythonDeps, software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.895Z")
 @Stability(value=Experimental)
public class Pip
extends Component
implements IPythonDeps

(experimental) Manages dependencies using a requirements.txt file and the pip CLI tool.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Pip.Builder (experimental) A fluent builder for Pip.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.python.IPythonDeps

IPythonDeps.Jsii$Default, IPythonDeps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Pip(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Pip(software.amazon.jsii.JsiiObjectRef objRef)
	Pip(PythonProject project)
	Pip(PythonProject project, PipOptions _options)

Method Summary

Modifier and Type	Method and Description
void	addDependency(String spec) (experimental) Adds a runtime dependency.
void	addDevDependency(String spec) (experimental) Adds a dev dependency.
Task	getInstallTask() (experimental) A task that installs and updates dependencies.
void	installDependencies() (experimental) Installs dependencies (called during post-synthesis).

Methods inherited from class io.github.cdklabs.projen.Component

getProject, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

Pip

protected Pip(software.amazon.jsii.JsiiObjectRef objRef)

Pip

protected Pip(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Pip

@Stability(value=Experimental)
public Pip(@NotNull
                                          PythonProject project,
                                          @Nullable
                                          PipOptions _options)

Parameters:

project - This parameter is required.

_options -

Pip

@Stability(value=Experimental)
public Pip(@NotNull
                                          PythonProject project)

Parameters:

project - This parameter is required.

Method Detail

addDependency

@Stability(value=Experimental)
public void addDependency(@NotNull
                                                         String spec)

(experimental) Adds a runtime dependency.

Specified by:

addDependency in interface IPythonDeps

Parameters:

spec - Format `@`. This parameter is required.

addDevDependency

@Stability(value=Experimental)
public void addDevDependency(@NotNull
                                                            String spec)

(experimental) Adds a dev dependency.

Specified by:

addDevDependency in interface IPythonDeps

Parameters:

spec - Format `@`. This parameter is required.

installDependencies

@Stability(value=Experimental)
public void installDependencies()

(experimental) Installs dependencies (called during post-synthesis).

Specified by:

installDependencies in interface IPythonDeps

getInstallTask

@Stability(value=Experimental)
 @NotNull
public Task getInstallTask()

(experimental) A task that installs and updates dependencies.

Specified by:

getInstallTask in interface IPythonDeps