Package io.github.cdklabs.projen.python

Interface PoetryPyprojectOptionsWithoutDeps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

PoetryPyprojectOptions

All Known Implementing Classes:

PoetryPyprojectOptions.Jsii$Proxy, PoetryPyprojectOptionsWithoutDeps.Jsii$Proxy

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

(experimental) Poetry-specific options.

See Also:

https://python-poetry.org/docs/pyproject/

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static PoetryPyprojectOptionsWithoutDeps.Builder	builder()
default List<String>	getAuthors()	(experimental) The authors of the package.
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 (required).
default String	getDocumentation()	(experimental) A URL to the documentation of the project.
default List<String>	getExclude()	(experimental) A list of patterns that will be excluded in the final package.
default Map<String,List<String>>	getExtras()	(experimental) Package extras.
default String	getHomepage()	(experimental) A URL to the website of the project.
default List<String>	getInclude()	(experimental) A list of patterns that will be included in the final package.
default List<String>	getKeywords()	(experimental) A list of keywords (max: 5) that the package is related to.
default String	getLicense()	(experimental) License of this package as an SPDX identifier.
default List<String>	getMaintainers()	(experimental) the maintainers of the package.
default String	getName()	(experimental) Name of the package (required).
default List<Object>	getPackages()	(experimental) A list of packages and modules to include in the final distribution.
default Object	getPlugins()	(experimental) Plugins.
default String	getReadme()	(experimental) The name of the readme file of the package.
default String	getRepository()	(experimental) A URL to the repository of the project.
default Map<String,Object>	getScripts()	(experimental) The scripts or executables that will be installed when installing the package.
default List<Object>	getSource()	(experimental) Source registries from which packages are retrieved.
default Map<String,String>	getUrls()	(experimental) Project custom URLs, in addition to homepage, repository and documentation.
default String	getVersion()	(experimental) Version of the package (required).

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAuthors

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

(experimental) The authors of the package.

Must be in the form "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 description of the package (required).

getDocumentation

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

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

getExclude

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

(experimental) A list of patterns that will be excluded in the final package.

If a VCS is being used for a package, the exclude field will be seeded with the VCS’ ignore settings (.gitignore for git for example).

getExtras

@Stability(Experimental)
@Nullable
default Map<String,List<String>> getExtras()

(experimental) Package extras.

getHomepage

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

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

getInclude

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

(experimental) A list of patterns that will be included in the final package.

getKeywords

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

(experimental) A list of keywords (max: 5) that the package is related to.

getLicense

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

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

If the project is proprietary and does not use a specific license, you can set this value as "Proprietary".

getMaintainers

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

(experimental) the maintainers of the package.

Must be in the form "name "

getName

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

(experimental) Name of the package (required).

getPackages

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

(experimental) A list of packages and modules to include in the final distribution.

getPlugins

@Stability(Experimental)
@Nullable
default Object getPlugins()

(experimental) Plugins.

Must be specified as a table.

See Also:

https://toml.io/en/v1.0.0#table

getReadme

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

(experimental) The name of the readme file of the package.

getRepository

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

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

getScripts

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

(experimental) The scripts or executables that will be installed when installing the package.

getSource

@Stability(Experimental)
@Nullable
default List<Object> getSource()

(experimental) Source registries from which packages are retrieved.

getUrls

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

(experimental) Project custom URLs, in addition to homepage, repository and documentation.

E.g. "Bug Tracker"

getVersion

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

(experimental) Version of the package (required).

builder

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

Returns:

a PoetryPyprojectOptionsWithoutDeps.Builder of PoetryPyprojectOptionsWithoutDeps