Package io.github.cdklabs.projen.python

Class Pip

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.python.Pip

All Implemented Interfaces:

IPythonDeps, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.225Z")
@Stability(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	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 software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

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

IPythonDeps.Jsii$Default, IPythonDeps.Jsii$Proxy

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
void	addDependency(String spec)	(experimental) Adds a runtime dependency.
void	addDevDependency(String spec)	(experimental) Adds a dev dependency.
Task	getInstallCiTask()	(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, isComponent, postSynthesize, preSynthesize, synthesize

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

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, 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(Experimental)
public Pip(@NotNull
           Project project,
           @Nullable
           PipOptions _options)

Parameters:

project - This parameter is required.

_options -

Pip

@Stability(Experimental)
public Pip(@NotNull
           Project project)

Parameters:

project - This parameter is required.

Method Detail

addDependency

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

(experimental) Adds a runtime dependency.

Specified by:

addDependency in interface IPythonDeps

Parameters:

spec - Format <module>@<semver>. This parameter is required.

addDevDependency

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

(experimental) Adds a dev dependency.

Specified by:

addDevDependency in interface IPythonDeps

Parameters:

spec - Format <module>@<semver>. This parameter is required.

installDependencies

@Stability(Experimental)
public void installDependencies()

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

Specified by:

installDependencies in interface IPythonDeps

getInstallCiTask

@Stability(Experimental)
@NotNull
public Task getInstallCiTask()

(experimental) A task that installs and updates dependencies.

Specified by:

getInstallCiTask in interface IPythonDeps