Package io.github.cdklabs.projen.python

Class Poetry

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.python.Poetry

All Implemented Interfaces:

IPythonDeps, IPythonEnv, IPythonPackaging, 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 Poetry
extends Component
implements IPythonDeps, IPythonEnv, IPythonPackaging

(experimental) Manage project dependencies, virtual environments, and packaging through the poetry CLI tool.

Nested Class Summary

Nested Classes

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

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

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

IPythonEnv.Jsii$Default, IPythonEnv.Jsii$Proxy

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

IPythonPackaging.Jsii$Default, IPythonPackaging.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	Poetry(Project project, PoetryOptions options)
protected	Poetry(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Poetry(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) Task for installing dependencies according to the existing lockfile.
Task	getInstallTask()	(experimental) Task for updating the lockfile and installing project dependencies.
Task	getPublishTask()	(experimental) Task for publishing the package to a package repository.
Task	getPublishTestTask()	(experimental) Task for publishing the package to the Test PyPI repository for testing purposes.
void	installDependencies()	(experimental) Installs dependencies (called during post-synthesis).
void	setupEnvironment()	(experimental) Initializes the virtual environment if it doesn't exist (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

Poetry

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

Poetry

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

Poetry

@Stability(Experimental)
public Poetry(@NotNull
              Project project,
              @NotNull
              PoetryOptions options)

Parameters:

project - This parameter is required.

options - 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

setupEnvironment

@Stability(Experimental)
public void setupEnvironment()

(experimental) Initializes the virtual environment if it doesn't exist (called during post-synthesis).

Specified by:

setupEnvironment in interface IPythonEnv

getInstallCiTask

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

(experimental) Task for installing dependencies according to the existing lockfile.

Specified by:

getInstallCiTask in interface IPythonDeps

getInstallTask

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

(experimental) Task for updating the lockfile and installing project dependencies.

getPublishTask

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

(experimental) Task for publishing the package to a package repository.

Specified by:

getPublishTask in interface IPythonPackaging

getPublishTestTask

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

(experimental) Task for publishing the package to the Test PyPI repository for testing purposes.