@Stability(value=Experimental) public static final class PoetryPyproject.Builder extends Object implements software.amazon.jsii.Builder<PoetryPyproject>
PoetryPyproject.| Modifier and Type | Method and Description |
|---|---|
PoetryPyproject.Builder |
authors(List<String> authors)
(experimental) The authors of the package.
|
PoetryPyproject |
build() |
PoetryPyproject.Builder |
classifiers(List<String> classifiers)
(experimental) A list of PyPI trove classifiers that describe the project.
|
static PoetryPyproject.Builder |
create(PythonProject project) |
PoetryPyproject.Builder |
dependencies(Map<String,? extends Object> dependencies)
(experimental) A list of dependencies for the project.
|
PoetryPyproject.Builder |
description(String description)
(experimental) A short description of the package (required).
|
PoetryPyproject.Builder |
devDependencies(Map<String,? extends Object> devDependencies)
(experimental) A list of development dependencies for the project.
|
PoetryPyproject.Builder |
documentation(String documentation)
(experimental) A URL to the documentation of the project.
|
PoetryPyproject.Builder |
exclude(List<String> exclude)
(experimental) A list of patterns that will be excluded in the final package.
|
PoetryPyproject.Builder |
extras(Map<String,? extends List<String>> extras)
(experimental) Package extras.
|
PoetryPyproject.Builder |
homepage(String homepage)
(experimental) A URL to the website of the project.
|
PoetryPyproject.Builder |
include(List<String> include)
(experimental) A list of patterns that will be included in the final package.
|
PoetryPyproject.Builder |
keywords(List<String> keywords)
(experimental) A list of keywords (max: 5) that the package is related to.
|
PoetryPyproject.Builder |
license(String license)
(experimental) License of this package as an SPDX identifier.
|
PoetryPyproject.Builder |
maintainers(List<String> maintainers)
(experimental) the maintainers of the package.
|
PoetryPyproject.Builder |
name(String name)
(experimental) Name of the package (required).
|
PoetryPyproject.Builder |
packages(List<? extends Object> packages)
(experimental) A list of packages and modules to include in the final distribution.
|
PoetryPyproject.Builder |
plugins(Object plugins)
(experimental) Plugins.
|
PoetryPyproject.Builder |
readme(String readme)
(experimental) The name of the readme file of the package.
|
PoetryPyproject.Builder |
repository(String repository)
(experimental) A URL to the repository of the project.
|
PoetryPyproject.Builder |
scripts(Map<String,? extends Object> scripts)
(experimental) The scripts or executables that will be installed when installing the package.
|
PoetryPyproject.Builder |
source(List<? extends Object> source)
(experimental) Source registries from which packages are retrieved.
|
PoetryPyproject.Builder |
urls(Map<String,String> urls)
(experimental) Project custom URLs, in addition to homepage, repository and documentation.
|
PoetryPyproject.Builder |
version(String version)
(experimental) Version of the package (required).
|
@Stability(value=Experimental) public static PoetryPyproject.Builder create(PythonProject project)
project - This parameter is required.PoetryPyproject.Builder.@Stability(value=Experimental) public PoetryPyproject.Builder authors(List<String> authors)
Must be in the form "name
authors - The authors of the package. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder classifiers(List<String> classifiers)
classifiers - A list of PyPI trove classifiers that describe the project. This parameter is required.thishttps://pypi.org/classifiers/@Stability(value=Experimental) public PoetryPyproject.Builder description(String description)
description - A short description of the package (required). This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder documentation(String documentation)
documentation - A URL to the documentation of the project. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder exclude(List<String> exclude)
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).
exclude - A list of patterns that will be excluded in the final package. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder extras(Map<String,? extends List<String>> extras)
extras - Package extras. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder homepage(String homepage)
homepage - A URL to the website of the project. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder include(List<String> include)
include - A list of patterns that will be included in the final package. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder keywords(List<String> keywords)
keywords - A list of keywords (max: 5) that the package is related to. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder license(String license)
If the project is proprietary and does not use a specific license, you can set this value as "Proprietary".
license - License of this package as an SPDX identifier. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder maintainers(List<String> maintainers)
Must be in the form "name
maintainers - the maintainers of the package. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder name(String name)
name - Name of the package (required). This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder packages(List<? extends Object> packages)
packages - A list of packages and modules to include in the final distribution. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder plugins(Object plugins)
Must be specified as a table.
plugins - Plugins. This parameter is required.thishttps://toml.io/en/v1.0.0#table@Stability(value=Experimental) public PoetryPyproject.Builder readme(String readme)
readme - The name of the readme file of the package. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder repository(String repository)
repository - A URL to the repository of the project. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder scripts(Map<String,? extends Object> scripts)
scripts - The scripts or executables that will be installed when installing the package. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder source(List<? extends Object> source)
source - Source registries from which packages are retrieved. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder urls(Map<String,String> urls)
E.g. "Bug Tracker"
urls - Project custom URLs, in addition to homepage, repository and documentation. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder version(String version)
version - Version of the package (required). This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder dependencies(Map<String,? extends Object> dependencies)
The python version for which your package is compatible is also required.
Example:
// Example automatically generated from non-compiling source. May contain errors.
{ requests: "^2.13.0" }
dependencies - A list of dependencies for the project. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject.Builder devDependencies(Map<String,? extends Object> devDependencies)
Example:
// Example automatically generated from non-compiling source. May contain errors.
{ requests: "^2.13.0" }
devDependencies - A list of development dependencies for the project. This parameter is required.this@Stability(value=Experimental) public PoetryPyproject build()
build in interface software.amazon.jsii.Builder<PoetryPyproject>Copyright © 2021. All rights reserved.