Package io.github.cdklabs.projen.python

Class PoetryPyproject.Builder

    • Method Detail

      • authors

        @Stability(Experimental)
public PoetryPyproject.Builder authors​(List<String> authors)
        (experimental) The authors of the package.

        Must be in the form "name "

        Parameters:
        authors - The authors of the package. This parameter is required.
        Returns:
        this

      • classifiers

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

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

      • documentation

        @Stability(Experimental)
public PoetryPyproject.Builder documentation​(String documentation)
        (experimental) A URL to the documentation of the project.

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

      • exclude

        @Stability(Experimental)
public PoetryPyproject.Builder exclude​(List<String> exclude)
        (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).

        Parameters:
        exclude - A list of patterns that will be excluded in the final package. This parameter is required.
        Returns:
        this

      • extras

        @Stability(Experimental)
public PoetryPyproject.Builder extras​(Map<String,​? extends List<String>> extras)
        (experimental) Package extras.

        Parameters:
        extras - Package extras. This parameter is required.
        Returns:
        this

      • homepage

        @Stability(Experimental)
public PoetryPyproject.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

      • include

        @Stability(Experimental)
public PoetryPyproject.Builder include​(List<String> include)
        (experimental) A list of patterns that will be included in the final package.

        Parameters:
        include - A list of patterns that will be included in the final package. This parameter is required.
        Returns:
        this

      • keywords

        @Stability(Experimental)
public PoetryPyproject.Builder keywords​(List<String> keywords)
        (experimental) A list of keywords (max: 5) that the package is related to.

        Parameters:
        keywords - A list of keywords (max: 5) that the package is related to. This parameter is required.
        Returns:
        this

      • license

        @Stability(Experimental)
public PoetryPyproject.Builder license​(String license)
        (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".

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

      • maintainers

        @Stability(Experimental)
public PoetryPyproject.Builder maintainers​(List<String> maintainers)
        (experimental) the maintainers of the package.

        Must be in the form "name "

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

      • name

        @Stability(Experimental)
public PoetryPyproject.Builder name​(String name)
        (experimental) Name of the package (required).

        Parameters:
        name - Name of the package (required). This parameter is required.
        Returns:
        this

      • packages

        @Stability(Experimental)
public PoetryPyproject.Builder packages​(List<? extends Object> packages)
        (experimental) A list of packages and modules to include in the final distribution.

        Parameters:
        packages - A list of packages and modules to include in the final distribution. This parameter is required.
        Returns:
        this

      • readme

        @Stability(Experimental)
public PoetryPyproject.Builder readme​(String readme)
        (experimental) The name of the readme file of the package.

        Parameters:
        readme - The name of the readme file of the package. This parameter is required.
        Returns:
        this

      • repository

        @Stability(Experimental)
public PoetryPyproject.Builder repository​(String repository)
        (experimental) A URL to the repository of the project.

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

      • scripts

        @Stability(Experimental)
public PoetryPyproject.Builder scripts​(Map<String,​? extends Object> scripts)
        (experimental) The scripts or executables that will be installed when installing the package.

        Parameters:
        scripts - The scripts or executables that will be installed when installing the package. This parameter is required.
        Returns:
        this

      • source

        @Stability(Experimental)
public PoetryPyproject.Builder source​(List<? extends Object> source)
        (experimental) Source registries from which packages are retrieved.

        Parameters:
        source - Source registries from which packages are retrieved. This parameter is required.
        Returns:
        this

      • urls

        @Stability(Experimental)
public PoetryPyproject.Builder urls​(Map<String,​String> urls)
        (experimental) Project custom URLs, in addition to homepage, repository and documentation.

        E.g. "Bug Tracker"

        Parameters:
        urls - Project custom URLs, in addition to homepage, repository and documentation. This parameter is required.
        Returns:
        this

      • version

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

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

      • dependencies

        @Stability(Experimental)
public PoetryPyproject.Builder dependencies​(Map<String,​? extends Object> dependencies)
        (experimental) A list of dependencies for the project.

        The python version for which your package is compatible is also required.

        Example: 

         { requests: "^2.13.0" }

        Parameters:
        dependencies - A list of dependencies for the project. This parameter is required.
        Returns:
        this

      • devDependencies

        @Stability(Experimental)
public PoetryPyproject.Builder devDependencies​(Map<String,​? extends Object> devDependencies)
        (experimental) A list of development dependencies for the project.

        Example: 

         { requests: "^2.13.0" }

        Parameters:
        devDependencies - A list of development dependencies for the project. This parameter is required.
        Returns:
        this