Package io.github.cdklabs.projen.python

Class Poetry.Builder

  • All Implemented Interfaces:
    software.amazon.jsii.Builder<Poetry>
    Enclosing class:
    Poetry
    @Stability(Experimental)
public static final class Poetry.Builder
extends Object
implements software.amazon.jsii.Builder<Poetry>
    (experimental) A fluent builder for Poetry.

    • Method Detail

      • create

        @Stability(Experimental)
public static Poetry.Builder create​(Project project)
        Parameters:
        project - This parameter is required.
        Returns:
        a new instance of Poetry.Builder.

      • authorEmail

        @Stability(Experimental)
public Poetry.Builder authorEmail​(String authorEmail)
        (experimental) Author's e-mail.

        Default: $GIT_USER_EMAIL

        Parameters:
        authorEmail - Author's e-mail. This parameter is required.
        Returns:
        this

      • authorName

        @Stability(Experimental)
public Poetry.Builder authorName​(String authorName)
        (experimental) Author's name.

        Default: $GIT_USER_NAME

        Parameters:
        authorName - Author's name. This parameter is required.
        Returns:
        this

      • version

        @Stability(Experimental)
public Poetry.Builder version​(String version)
        (experimental) Version of the package.

        Default: "0.1.0"

        Parameters:
        version - Version of the package. This parameter is required.
        Returns:
        this

      • classifiers

        @Stability(Experimental)
public Poetry.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(Experimental)
public Poetry.Builder description​(String description)
        (experimental) A short description of the package.

        Parameters:
        description - A short description of the package. This parameter is required.
        Returns:
        this

      • homepage

        @Stability(Experimental)
public Poetry.Builder homepage​(String homepage)
        (experimental) A URL to the website of the project.

        Parameters:
        homepage - A URL to the website of the project. This parameter is required.
        Returns:
        this

      • license

        @Stability(Experimental)
public Poetry.Builder license​(String license)
        (experimental) License of this package as an SPDX identifier.

        Parameters:
        license - License of this package as an SPDX identifier. This parameter is required.
        Returns:
        this

      • packageName

        @Stability(Experimental)
public Poetry.Builder packageName​(String packageName)
        (experimental) Package name.

        Parameters:
        packageName - Package name. This parameter is required.
        Returns:
        this

      • poetryOptions

        @Stability(Experimental)
public Poetry.Builder poetryOptions​(PoetryPyprojectOptionsWithoutDeps poetryOptions)
        (experimental) Additional options to set for poetry if using poetry.

        Parameters:
        poetryOptions - Additional options to set for poetry if using poetry. This parameter is required.
        Returns:
        this

      • setupConfig

        @Stability(Experimental)
public Poetry.Builder setupConfig​(Map<String,​? extends Object> setupConfig)
        (experimental) Additional fields to pass in the setup() function if using setuptools.

        Parameters:
        setupConfig - Additional fields to pass in the setup() function if using setuptools. This parameter is required.
        Returns:
        this

      • pythonExec

        @Stability(Experimental)
public Poetry.Builder pythonExec​(String pythonExec)
        (experimental) Path to the python executable to use.

        Default: "python"

        Parameters:
        pythonExec - Path to the python executable to use. This parameter is required.
        Returns:
        this

      • build

        @Stability(Experimental)
public Poetry build()
        Specified by:
        build in interface software.amazon.jsii.Builder<Poetry>
        Returns:
        a newly built instance of Poetry.