io.github.cdklabs.projen.python

Class SetupPy.Builder

java.lang.Object

io.github.cdklabs.projen.python.SetupPy.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SetupPy>

Enclosing class:

SetupPy

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

(experimental) A fluent builder for SetupPy.

Method Summary

Modifier and Type	Method and Description
SetupPy.Builder	authorEmail(String authorEmail) (experimental) Author's e-mail.
SetupPy.Builder	authorName(String authorName) (experimental) Author's name.
SetupPy	build()
SetupPy.Builder	classifiers(List<String> classifiers) (experimental) A list of PyPI trove classifiers that describe the project.
static SetupPy.Builder	create(PythonProject project)
SetupPy.Builder	description(String description) (experimental) A short project description.
SetupPy.Builder	homepage(String homepage) (experimental) Package's Homepage / Website.
SetupPy.Builder	license(String license) (experimental) The project license.
SetupPy.Builder	name(String name) (experimental) Name of the package.
SetupPy.Builder	packages(List<String> packages) (experimental) List of submodules to be packaged.
SetupPy.Builder	version(String version) (experimental) Manually specify package version.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static SetupPy.Builder create(PythonProject project)

Parameters:

project - This parameter is required.

Returns:

a new instance of SetupPy.Builder.

authorEmail

@Stability(value=Experimental)
public SetupPy.Builder authorEmail(String authorEmail)

(experimental) Author's e-mail.

Parameters:

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

Returns:

this

authorName

@Stability(value=Experimental)
public SetupPy.Builder authorName(String authorName)

(experimental) Author's name.

Parameters:

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

Returns:

this

classifiers

@Stability(value=Experimental)
public SetupPy.Builder classifiers(List<String> classifiers)

(experimental) A list of PyPI trove classifiers that describe the project.

Parameters:

classifiers - A list of PyPI trove classifiers that describe the project. This parameter is required.

Returns:

this

See Also:

https://pypi.org/classifiers/

description

@Stability(value=Experimental)
public SetupPy.Builder description(String description)

(experimental) A short project description.

Parameters:

description - A short project description. This parameter is required.

Returns:

this

homepage

@Stability(value=Experimental)
public SetupPy.Builder homepage(String homepage)

(experimental) Package's Homepage / Website.

Parameters:

homepage - Package's Homepage / Website. This parameter is required.

Returns:

this

license

@Stability(value=Experimental)
public SetupPy.Builder license(String license)

(experimental) The project license.

Parameters:

license - The project license. This parameter is required.

Returns:

this

name

@Stability(value=Experimental)
public SetupPy.Builder name(String name)

(experimental) Name of the package.

Parameters:

name - Name of the package. This parameter is required.

Returns:

this

packages

@Stability(value=Experimental)
public SetupPy.Builder packages(List<String> packages)

(experimental) List of submodules to be packaged.

Parameters:

packages - List of submodules to be packaged. This parameter is required.

Returns:

this

version

@Stability(value=Experimental)
public SetupPy.Builder version(String version)

(experimental) Manually specify package version.

Parameters:

version - Manually specify package version. This parameter is required.

Returns:

this

build

@Stability(value=Experimental)
public SetupPy build()

Specified by:

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