Package io.github.cdklabs.projen.python

Interface PythonPackagingOptions

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

AwsCdkPythonAppOptions, Cdk8sPythonOptions, PoetryOptions, PythonProjectOptions, SetuptoolsOptions

All Known Implementing Classes:

AwsCdkPythonAppOptions.Jsii$Proxy, Cdk8sPythonOptions.Jsii$Proxy, PoetryOptions.Jsii$Proxy, PythonPackagingOptions.Jsii$Proxy, PythonProjectOptions.Jsii$Proxy, SetuptoolsOptions.Jsii$Proxy

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PythonPackagingOptions.Builder	builder()
String	getAuthorEmail()	(experimental) Author's e-mail.
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 description of the package.
default String	getHomepage()	(experimental) A URL to the website of the project.
default String	getLicense()	(experimental) License of this package as an SPDX identifier.
default String	getPackageName()	(experimental) Package name.
default PoetryPyprojectOptionsWithoutDeps	getPoetryOptions()	(experimental) Additional options to set for poetry if using poetry.
default Map<String,Object>	getSetupConfig()	(experimental) Additional fields to pass in the setup() function if using setuptools.
String	getVersion()	(experimental) Version of the package.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthorEmail

@Stability(Experimental)
@NotNull
String getAuthorEmail()

(experimental) Author's e-mail.

Default: $GIT_USER_EMAIL

getAuthorName

@Stability(Experimental)
@NotNull
String getAuthorName()

(experimental) Author's name.

Default: $GIT_USER_NAME

getVersion

@Stability(Experimental)
@NotNull
String getVersion()

(experimental) Version of the package.

Default: "0.1.0"

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 description of the package.

getHomepage

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

(experimental) A URL to the website of the project.

getLicense

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

(experimental) License of this package as an SPDX identifier.

getPackageName

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

(experimental) Package name.

getPoetryOptions

@Stability(Experimental)
@Nullable
default PoetryPyprojectOptionsWithoutDeps getPoetryOptions()

(experimental) Additional options to set for poetry if using poetry.

getSetupConfig

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

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

builder

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

Returns:

a PythonPackagingOptions.Builder of PythonPackagingOptions