Package io.github.cdklabs.projen.python

Class PythonPackagingOptions.Builder

java.lang.Object

io.github.cdklabs.projen.python.PythonPackagingOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PythonPackagingOptions>

Enclosing interface:

PythonPackagingOptions

@Stability(Experimental)
public static final class PythonPackagingOptions.Builder
extends Object
implements software.amazon.jsii.Builder<PythonPackagingOptions>

A builder for PythonPackagingOptions

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
PythonPackagingOptions.Builder	authorEmail(String authorEmail)	Sets the value of PythonPackagingOptions.getAuthorEmail()
PythonPackagingOptions.Builder	authorName(String authorName)	Sets the value of PythonPackagingOptions.getAuthorName()
PythonPackagingOptions	build()	Builds the configured instance.
PythonPackagingOptions.Builder	classifiers(List<String> classifiers)	Sets the value of PythonPackagingOptions.getClassifiers()
PythonPackagingOptions.Builder	description(String description)	Sets the value of PythonPackagingOptions.getDescription()
PythonPackagingOptions.Builder	homepage(String homepage)	Sets the value of PythonPackagingOptions.getHomepage()
PythonPackagingOptions.Builder	license(String license)	Sets the value of PythonPackagingOptions.getLicense()
PythonPackagingOptions.Builder	packageName(String packageName)	Sets the value of PythonPackagingOptions.getPackageName()
PythonPackagingOptions.Builder	poetryOptions(PoetryPyprojectOptionsWithoutDeps poetryOptions)	Sets the value of PythonPackagingOptions.getPoetryOptions()
PythonPackagingOptions.Builder	setupConfig(Map<String,? extends Object> setupConfig)	Sets the value of PythonPackagingOptions.getSetupConfig()
PythonPackagingOptions.Builder	version(String version)	Sets the value of PythonPackagingOptions.getVersion()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

authorEmail

@Stability(Experimental)
public PythonPackagingOptions.Builder authorEmail(String authorEmail)

Sets the value of PythonPackagingOptions.getAuthorEmail()

Parameters:

authorEmail - Author's e-mail. This parameter is required.

Returns:

this

authorName

@Stability(Experimental)
public PythonPackagingOptions.Builder authorName(String authorName)

Sets the value of PythonPackagingOptions.getAuthorName()

Parameters:

authorName - Author's name. This parameter is required.

Returns:

this

version

@Stability(Experimental)
public PythonPackagingOptions.Builder version(String version)

Sets the value of PythonPackagingOptions.getVersion()

Parameters:

version - Version of the package. This parameter is required.

Returns:

this

classifiers

@Stability(Experimental)
public PythonPackagingOptions.Builder classifiers(List<String> classifiers)

Sets the value of PythonPackagingOptions.getClassifiers()

Parameters:

classifiers - A list of PyPI trove classifiers that describe the project.

Returns:

this

description

@Stability(Experimental)
public PythonPackagingOptions.Builder description(String description)

Sets the value of PythonPackagingOptions.getDescription()

Parameters:

description - A short description of the package.

Returns:

this

homepage

@Stability(Experimental)
public PythonPackagingOptions.Builder homepage(String homepage)

Sets the value of PythonPackagingOptions.getHomepage()

Parameters:

homepage - A URL to the website of the project.

Returns:

this

license

@Stability(Experimental)
public PythonPackagingOptions.Builder license(String license)

Sets the value of PythonPackagingOptions.getLicense()

Parameters:

license - License of this package as an SPDX identifier.

Returns:

this

packageName

@Stability(Experimental)
public PythonPackagingOptions.Builder packageName(String packageName)

Sets the value of PythonPackagingOptions.getPackageName()

Parameters:

packageName - Package name.

Returns:

this

poetryOptions

@Stability(Experimental)
public PythonPackagingOptions.Builder poetryOptions(PoetryPyprojectOptionsWithoutDeps poetryOptions)

Sets the value of PythonPackagingOptions.getPoetryOptions()

Parameters:

poetryOptions - Additional options to set for poetry if using poetry.

Returns:

this

setupConfig

@Stability(Experimental)
public PythonPackagingOptions.Builder setupConfig(Map<String,? extends Object> setupConfig)

Sets the value of PythonPackagingOptions.getSetupConfig()

Parameters:

setupConfig - Additional fields to pass in the setup() function if using setuptools.

Returns:

this

build

@Stability(Experimental)
public PythonPackagingOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<PythonPackagingOptions>

Returns:

a new instance of PythonPackagingOptions

Throws:

NullPointerException - if any required attribute was not provided