Package io.github.cdklabs.projen.python
Class SetupPy.Builder
- java.lang.Object
-
- io.github.cdklabs.projen.python.SetupPy.Builder
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SetupPy.BuilderadditionalOptions(Map<String,? extends Object> additionalOptions)(experimental) Escape hatch to allow any value.SetupPy.BuilderauthorEmail(String authorEmail)(experimental) Author's e-mail.SetupPy.BuilderauthorName(String authorName)(experimental) Author's name.SetupPybuild()SetupPy.Builderclassifiers(List<String> classifiers)(experimental) A list of PyPI trove classifiers that describe the project.static SetupPy.Buildercreate(Project project)SetupPy.Builderdescription(String description)(experimental) A short project description.SetupPy.Builderhomepage(String homepage)(experimental) Package's Homepage / Website.SetupPy.Builderlicense(String license)(experimental) The project license.SetupPy.Buildername(String name)(experimental) Name of the package.SetupPy.Builderpackages(List<String> packages)(experimental) List of submodules to be packaged.SetupPy.Builderversion(String version)(experimental) Manually specify package version.
-
-
-
Method Detail
-
create
@Stability(Experimental) public static SetupPy.Builder create(Project project)
- Parameters:
project- This parameter is required.- Returns:
- a new instance of
SetupPy.Builder.
-
additionalOptions
@Stability(Experimental) public SetupPy.Builder additionalOptions(Map<String,? extends Object> additionalOptions)
(experimental) Escape hatch to allow any value.- Parameters:
additionalOptions- Escape hatch to allow any value. This parameter is required.- Returns:
this
-
authorEmail
@Stability(Experimental) public SetupPy.Builder authorEmail(String authorEmail)
(experimental) Author's e-mail.- Parameters:
authorEmail- Author's e-mail. This parameter is required.- Returns:
this
-
authorName
@Stability(Experimental) public SetupPy.Builder authorName(String authorName)
(experimental) Author's name.- Parameters:
authorName- Author's name. This parameter is required.- Returns:
this
-
classifiers
@Stability(Experimental) public SetupPy.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 SetupPy.Builder description(String description)
(experimental) A short project description.- Parameters:
description- A short project description. This parameter is required.- Returns:
this
-
homepage
@Stability(Experimental) public SetupPy.Builder homepage(String homepage)
(experimental) Package's Homepage / Website.- Parameters:
homepage- Package's Homepage / Website. This parameter is required.- Returns:
this
-
license
@Stability(Experimental) public SetupPy.Builder license(String license)
(experimental) The project license.- Parameters:
license- The project license. This parameter is required.- Returns:
this
-
name
@Stability(Experimental) public SetupPy.Builder name(String name)
(experimental) Name of the package.- Parameters:
name- Name of the package. This parameter is required.- Returns:
this
-
packages
@Stability(Experimental) public SetupPy.Builder packages(List<String> packages)
(experimental) List of submodules to be packaged.- Parameters:
packages- List of submodules to be packaged. This parameter is required.- Returns:
this
-
version
@Stability(Experimental) public SetupPy.Builder version(String version)
(experimental) Manually specify package version.- Parameters:
version- Manually specify package version. This parameter is required.- Returns:
this
-
-