Package io.github.cdklabs.projen.python

Class Setuptools

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Component

io.github.cdklabs.projen.python.Setuptools

All Implemented Interfaces:

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.246Z")
@Stability(Experimental)
public class Setuptools
extends Component
implements IPythonPackaging

(experimental) Manages packaging through setuptools with a setup.py script.

Nested Class Summary

Nested Classes

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

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.IPythonPackaging

IPythonPackaging.Jsii$Default, IPythonPackaging.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
	Setuptools(Project project, SetuptoolsOptions options)
protected	Setuptools(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	Setuptools(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
Task	getPublishTask()	(experimental) A task that uploads the package to a package repository.
Task	getPublishTestTask()	(experimental) A task that uploads the package to the Test PyPI repository.

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

Setuptools

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

Setuptools

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

Setuptools

@Stability(Experimental)
public Setuptools(@NotNull
                  Project project,
                  @NotNull
                  SetuptoolsOptions options)

Parameters:

project - This parameter is required.

options - This parameter is required.

Method Detail

getPublishTask

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

(experimental) A task that uploads the package to a package repository.

Specified by:

getPublishTask in interface IPythonPackaging

getPublishTestTask

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

(experimental) A task that uploads the package to the Test PyPI repository.