Package io.github.cdklabs.projen.python

Interface SetupPyOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SetupPyOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.246Z")
@Stability(Experimental)
public interface SetupPyOptions
extends software.amazon.jsii.JsiiSerializable

(experimental) Fields to pass in the setup() function of setup.py.

See Also:

https://docs.python.org/3/distutils/setupscript.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	SetupPyOptions.Builder	A builder for SetupPyOptions
static class	SetupPyOptions.Jsii$Proxy	An implementation for SetupPyOptions

Method Summary

Modifier and Type	Method	Description
static SetupPyOptions.Builder	builder()
default Map<String,Object>	getAdditionalOptions()	(experimental) Escape hatch to allow any value.
default String	getAuthorEmail()	(experimental) Author's e-mail.
default String	getAuthorName()	(experimental) Author's name.
default List<String>	getClassifiers()	(experimental) A list of PyPI trove classifiers that describe the project.
default String	getDescription()	(experimental) A short project description.
default String	getHomepage()	(experimental) Package's Homepage / Website.
default String	getLicense()	(experimental) The project license.
default String	getName()	(experimental) Name of the package.
default List<String>	getPackages()	(experimental) List of submodules to be packaged.
default String	getVersion()	(experimental) Manually specify package version.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAdditionalOptions

@Stability(Experimental)
@Nullable
default Map<String,Object> getAdditionalOptions()

(experimental) Escape hatch to allow any value.

getAuthorEmail

@Stability(Experimental)
@Nullable
default String getAuthorEmail()

(experimental) Author's e-mail.

getAuthorName

@Stability(Experimental)
@Nullable
default String getAuthorName()

(experimental) Author's name.

getClassifiers

@Stability(Experimental)
@Nullable
default List<String> getClassifiers()

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

See Also:

https://pypi.org/classifiers/

getDescription

@Stability(Experimental)
@Nullable
default String getDescription()

(experimental) A short project description.

getHomepage

@Stability(Experimental)
@Nullable
default String getHomepage()

(experimental) Package's Homepage / Website.

getLicense

@Stability(Experimental)
@Nullable
default String getLicense()

(experimental) The project license.

getName

@Stability(Experimental)
@Nullable
default String getName()

(experimental) Name of the package.

getPackages

@Stability(Experimental)
@Nullable
default List<String> getPackages()

(experimental) List of submodules to be packaged.

getVersion

@Stability(Experimental)
@Nullable
default String getVersion()

(experimental) Manually specify package version.

builder

@Stability(Experimental)
static SetupPyOptions.Builder builder()

Returns:

a SetupPyOptions.Builder of SetupPyOptions