io.github.cdklabs.projen.python

Class PythonProjectOptions.Builder

java.lang.Object

io.github.cdklabs.projen.python.PythonProjectOptions.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PythonProjectOptions>

Enclosing interface:

PythonProjectOptions

@Stability(value=Experimental)
public static final class PythonProjectOptions.Builder
extends Object
implements software.amazon.jsii.Builder<PythonProjectOptions>

A builder for PythonProjectOptions

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
PythonProjectOptions.Builder	authorEmail(String authorEmail) Sets the value of PythonPackagingOptions.getAuthorEmail()
PythonProjectOptions.Builder	authorName(String authorName) Sets the value of PythonPackagingOptions.getAuthorName()
PythonProjectOptions.Builder	autoApproveOptions(AutoApproveOptions autoApproveOptions) Sets the value of GitHubProjectOptions.getAutoApproveOptions()
PythonProjectOptions.Builder	autoMergeOptions(AutoMergeOptions autoMergeOptions) Sets the value of GitHubProjectOptions.getAutoMergeOptions()
PythonProjectOptions	build() Builds the configured instance.
PythonProjectOptions.Builder	classifiers(List<String> classifiers) Sets the value of PythonPackagingOptions.getClassifiers()
PythonProjectOptions.Builder	clobber(Boolean clobber) Sets the value of GitHubProjectOptions.getClobber()
PythonProjectOptions.Builder	deps(List<String> deps) Sets the value of PythonProjectOptions.getDeps()
PythonProjectOptions.Builder	description(String description) Sets the value of PythonPackagingOptions.getDescription()
PythonProjectOptions.Builder	devContainer(Boolean devContainer) Sets the value of GitHubProjectOptions.getDevContainer()
PythonProjectOptions.Builder	devDeps(List<String> devDeps) Sets the value of PythonProjectOptions.getDevDeps()
PythonProjectOptions.Builder	github(Boolean github) Sets the value of GitHubProjectOptions.getGithub()
PythonProjectOptions.Builder	githubOptions(GitHubOptions githubOptions) Sets the value of GitHubProjectOptions.getGithubOptions()
PythonProjectOptions.Builder	gitpod(Boolean gitpod) Sets the value of GitHubProjectOptions.getGitpod()
PythonProjectOptions.Builder	homepage(String homepage) Sets the value of PythonPackagingOptions.getHomepage()
PythonProjectOptions.Builder	license(String license) Sets the value of PythonPackagingOptions.getLicense()
PythonProjectOptions.Builder	logging(LoggerOptions logging) Sets the value of ProjectOptions.getLogging()
PythonProjectOptions.Builder	mergify(Boolean mergify) Deprecated. use `githubOptions.mergify` instead
PythonProjectOptions.Builder	mergifyOptions(MergifyOptions mergifyOptions) Deprecated. use `githubOptions.mergifyOptions` instead
PythonProjectOptions.Builder	moduleName(String moduleName) Sets the value of PythonProjectOptions.getModuleName()
PythonProjectOptions.Builder	name(String name) Sets the value of ProjectOptions.getName()
PythonProjectOptions.Builder	outdir(String outdir) Sets the value of ProjectOptions.getOutdir()
PythonProjectOptions.Builder	parent(Project parent) Sets the value of ProjectOptions.getParent()
PythonProjectOptions.Builder	pip(Boolean pip) Sets the value of PythonProjectOptions.getPip()
PythonProjectOptions.Builder	poetry(Boolean poetry) Sets the value of PythonProjectOptions.getPoetry()
PythonProjectOptions.Builder	poetryOptions(PoetryPyprojectOptionsWithoutDeps poetryOptions) Sets the value of PythonPackagingOptions.getPoetryOptions()
PythonProjectOptions.Builder	projectType(ProjectType projectType) Deprecated. no longer supported at the base project level
PythonProjectOptions.Builder	projenCommand(String projenCommand) Sets the value of ProjectOptions.getProjenCommand()
PythonProjectOptions.Builder	projenrcJson(Boolean projenrcJson) Sets the value of ProjectOptions.getProjenrcJson()
PythonProjectOptions.Builder	projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions) Sets the value of ProjectOptions.getProjenrcJsonOptions()
PythonProjectOptions.Builder	projenrcPython(Boolean projenrcPython) Sets the value of PythonProjectOptions.getProjenrcPython()
PythonProjectOptions.Builder	projenrcPythonOptions(ProjenrcOptions projenrcPythonOptions) Sets the value of PythonProjectOptions.getProjenrcPythonOptions()
PythonProjectOptions.Builder	pytest(Boolean pytest) Sets the value of PythonProjectOptions.getPytest()
PythonProjectOptions.Builder	pytestOptions(PytestOptions pytestOptions) Sets the value of PythonProjectOptions.getPytestOptions()
PythonProjectOptions.Builder	readme(SampleReadmeProps readme) Sets the value of GitHubProjectOptions.getReadme()
PythonProjectOptions.Builder	sample(Boolean sample) Sets the value of PythonProjectOptions.getSample()
PythonProjectOptions.Builder	setupConfig(Map<String,? extends Object> setupConfig) Sets the value of PythonPackagingOptions.getSetupConfig()
PythonProjectOptions.Builder	setuptools(Boolean setuptools) Sets the value of PythonProjectOptions.getSetuptools()
PythonProjectOptions.Builder	stale(Boolean stale) Sets the value of GitHubProjectOptions.getStale()
PythonProjectOptions.Builder	staleOptions(StaleOptions staleOptions) Sets the value of GitHubProjectOptions.getStaleOptions()
PythonProjectOptions.Builder	venv(Boolean venv) Sets the value of PythonProjectOptions.getVenv()
PythonProjectOptions.Builder	venvOptions(VenvOptions venvOptions) Sets the value of PythonProjectOptions.getVenvOptions()
PythonProjectOptions.Builder	version(String version) Sets the value of PythonPackagingOptions.getVersion()
PythonProjectOptions.Builder	vscode(Boolean vscode) Sets the value of GitHubProjectOptions.getVscode()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

moduleName

@Stability(value=Experimental)
public PythonProjectOptions.Builder moduleName(String moduleName)

Sets the value of PythonProjectOptions.getModuleName()

Parameters:

moduleName - Name of the python package as used in imports and filenames. This parameter is required. Must only consist of alphanumeric characters and underscores.

Returns:

this

deps

@Stability(value=Experimental)
public PythonProjectOptions.Builder deps(List<String> deps)

Sets the value of PythonProjectOptions.getDeps()

Parameters:

deps - List of runtime dependencies for this project. Dependencies use the format: <module>@<semver>

Additional dependencies can be added via project.addDependency().

Returns:

this

devDeps

@Stability(value=Experimental)
public PythonProjectOptions.Builder devDeps(List<String> devDeps)

Sets the value of PythonProjectOptions.getDevDeps()

Parameters:

devDeps - List of dev dependencies for this project. Dependencies use the format: <module>@<semver>

Additional dependencies can be added via project.addDevDependency().

Returns:

this

pip

@Stability(value=Experimental)
public PythonProjectOptions.Builder pip(Boolean pip)

Sets the value of PythonProjectOptions.getPip()

Parameters:

pip - Use pip with a requirements.txt file to track project dependencies.

Returns:

this

poetry

@Stability(value=Experimental)
public PythonProjectOptions.Builder poetry(Boolean poetry)

Sets the value of PythonProjectOptions.getPoetry()

Parameters:

poetry - Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.

Returns:

this

projenrcPython

@Stability(value=Experimental)
public PythonProjectOptions.Builder projenrcPython(Boolean projenrcPython)

Sets the value of PythonProjectOptions.getProjenrcPython()

Parameters:

projenrcPython - Use projenrc in python. This will install projen as a python dependency and will add a synth task which will run .projenrc.py.

Returns:

this

projenrcPythonOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder projenrcPythonOptions(ProjenrcOptions projenrcPythonOptions)

Sets the value of PythonProjectOptions.getProjenrcPythonOptions()

Parameters:

projenrcPythonOptions - Options related to projenrc in python.

Returns:

this

pytest

@Stability(value=Experimental)
public PythonProjectOptions.Builder pytest(Boolean pytest)

Sets the value of PythonProjectOptions.getPytest()

Parameters:

pytest - Include pytest tests.

Returns:

this

pytestOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder pytestOptions(PytestOptions pytestOptions)

Sets the value of PythonProjectOptions.getPytestOptions()

Parameters:

pytestOptions - pytest options.

Returns:

this

sample

@Stability(value=Experimental)
public PythonProjectOptions.Builder sample(Boolean sample)

Sets the value of PythonProjectOptions.getSample()

Parameters:

sample - Include sample code and test if the relevant directories don't exist.

Returns:

this

setuptools

@Stability(value=Experimental)
public PythonProjectOptions.Builder setuptools(Boolean setuptools)

Sets the value of PythonProjectOptions.getSetuptools()

Parameters:

setuptools - Use setuptools with a setup.py script for packaging and publishing.

Returns:

this

venv

@Stability(value=Experimental)
public PythonProjectOptions.Builder venv(Boolean venv)

Sets the value of PythonProjectOptions.getVenv()

Parameters:

venv - Use venv to manage a virtual environment for installing dependencies inside.

Returns:

this

venvOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder venvOptions(VenvOptions venvOptions)

Sets the value of PythonProjectOptions.getVenvOptions()

Parameters:

venvOptions - Venv options.

Returns:

this

autoApproveOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder autoApproveOptions(AutoApproveOptions autoApproveOptions)

Sets the value of GitHubProjectOptions.getAutoApproveOptions()

Parameters:

autoApproveOptions - Enable and configure the 'auto approve' workflow.

Returns:

this

autoMergeOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder autoMergeOptions(AutoMergeOptions autoMergeOptions)

Sets the value of GitHubProjectOptions.getAutoMergeOptions()

Parameters:

autoMergeOptions - Configure options for automatic merging on GitHub. Has no effect if github.mergify is set to false.

Returns:

this

clobber

@Stability(value=Experimental)
public PythonProjectOptions.Builder clobber(Boolean clobber)

Sets the value of GitHubProjectOptions.getClobber()

Parameters:

clobber - Add a `clobber` task which resets the repo to origin.

Returns:

this

devContainer

@Stability(value=Experimental)
public PythonProjectOptions.Builder devContainer(Boolean devContainer)

Sets the value of GitHubProjectOptions.getDevContainer()

Parameters:

devContainer - Add a VSCode development environment (used for GitHub Codespaces).

Returns:

this

github

@Stability(value=Experimental)
public PythonProjectOptions.Builder github(Boolean github)

Sets the value of GitHubProjectOptions.getGithub()

Parameters:

github - Enable GitHub integration. Enabled by default for root projects. Disabled for non-root projects.

Returns:

this

githubOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder githubOptions(GitHubOptions githubOptions)

Sets the value of GitHubProjectOptions.getGithubOptions()

Parameters:

githubOptions - Options for GitHub integration.

Returns:

this

gitpod

@Stability(value=Experimental)
public PythonProjectOptions.Builder gitpod(Boolean gitpod)

Sets the value of GitHubProjectOptions.getGitpod()

Parameters:

gitpod - Add a Gitpod development environment.

Returns:

this

mergify

@Stability(value=Deprecated)
 @Deprecated
public PythonProjectOptions.Builder mergify(Boolean mergify)

Deprecated. use `githubOptions.mergify` instead

Sets the value of GitHubProjectOptions.getMergify()

Parameters:

mergify - Whether mergify should be enabled on this repository or not.

Returns:

this

mergifyOptions

@Stability(value=Deprecated)
 @Deprecated
public PythonProjectOptions.Builder mergifyOptions(MergifyOptions mergifyOptions)

Deprecated. use `githubOptions.mergifyOptions` instead

Sets the value of GitHubProjectOptions.getMergifyOptions()

Parameters:

mergifyOptions - Options for mergify.

Returns:

this

projectType

@Stability(value=Deprecated)
 @Deprecated
public PythonProjectOptions.Builder projectType(ProjectType projectType)

Deprecated. no longer supported at the base project level

Sets the value of GitHubProjectOptions.getProjectType()

Parameters:

projectType - Which type of project this is (library/app).

Returns:

this

readme

@Stability(value=Experimental)
public PythonProjectOptions.Builder readme(SampleReadmeProps readme)

Sets the value of GitHubProjectOptions.getReadme()

Parameters:

readme - The README setup.

Returns:

this

stale

@Stability(value=Experimental)
public PythonProjectOptions.Builder stale(Boolean stale)

Sets the value of GitHubProjectOptions.getStale()

Parameters:

stale - Auto-close of stale issues and pull request. See staleOptions for options.

Returns:

this

staleOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder staleOptions(StaleOptions staleOptions)

Sets the value of GitHubProjectOptions.getStaleOptions()

Parameters:

staleOptions - Auto-close stale issues and pull requests. To disable set stale to false.

Returns:

this

vscode

@Stability(value=Experimental)
public PythonProjectOptions.Builder vscode(Boolean vscode)

Sets the value of GitHubProjectOptions.getVscode()

Parameters:

vscode - Enable VSCode integration. Enabled by default for root projects. Disabled for non-root projects.

Returns:

this

name

@Stability(value=Experimental)
public PythonProjectOptions.Builder name(String name)

Sets the value of ProjectOptions.getName()

Parameters:

name - This is the name of your project. This parameter is required.

Returns:

this

logging

@Stability(value=Experimental)
public PythonProjectOptions.Builder logging(LoggerOptions logging)

Sets the value of ProjectOptions.getLogging()

Parameters:

logging - Configure logging options such as verbosity.

Returns:

this

outdir

@Stability(value=Experimental)
public PythonProjectOptions.Builder outdir(String outdir)

Sets the value of ProjectOptions.getOutdir()

Parameters:

outdir - The root directory of the project. Relative to this directory, all files are synthesized.

If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other sub-projects.

Returns:

this

parent

@Stability(value=Experimental)
public PythonProjectOptions.Builder parent(Project parent)

Sets the value of ProjectOptions.getParent()

Parameters:

parent - The parent project, if this project is part of a bigger project.

Returns:

this

projenCommand

@Stability(value=Experimental)
public PythonProjectOptions.Builder projenCommand(String projenCommand)

Sets the value of ProjectOptions.getProjenCommand()

Parameters:

projenCommand - The shell command to use in order to run the projen CLI. Can be used to customize in special environments.

Returns:

this

projenrcJson

@Stability(value=Experimental)
public PythonProjectOptions.Builder projenrcJson(Boolean projenrcJson)

Sets the value of ProjectOptions.getProjenrcJson()

Parameters:

projenrcJson - Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.

Returns:

this

projenrcJsonOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)

Sets the value of ProjectOptions.getProjenrcJsonOptions()

Parameters:

projenrcJsonOptions - Options for .projenrc.json.

Returns:

this

authorEmail

@Stability(value=Experimental)
public PythonProjectOptions.Builder authorEmail(String authorEmail)

Sets the value of PythonPackagingOptions.getAuthorEmail()

Parameters:

authorEmail - Author's e-mail. This parameter is required.

Returns:

this

authorName

@Stability(value=Experimental)
public PythonProjectOptions.Builder authorName(String authorName)

Sets the value of PythonPackagingOptions.getAuthorName()

Parameters:

authorName - Author's name. This parameter is required.

Returns:

this

version

@Stability(value=Experimental)
public PythonProjectOptions.Builder version(String version)

Sets the value of PythonPackagingOptions.getVersion()

Parameters:

version - Version of the package. This parameter is required.

Returns:

this

classifiers

@Stability(value=Experimental)
public PythonProjectOptions.Builder classifiers(List<String> classifiers)

Sets the value of PythonPackagingOptions.getClassifiers()

Parameters:

classifiers - A list of PyPI trove classifiers that describe the project.

Returns:

this

description

@Stability(value=Experimental)
public PythonProjectOptions.Builder description(String description)

Sets the value of PythonPackagingOptions.getDescription()

Parameters:

description - A short description of the package.

Returns:

this

homepage

@Stability(value=Experimental)
public PythonProjectOptions.Builder homepage(String homepage)

Sets the value of PythonPackagingOptions.getHomepage()

Parameters:

homepage - A URL to the website of the project.

Returns:

this

license

@Stability(value=Experimental)
public PythonProjectOptions.Builder license(String license)

Sets the value of PythonPackagingOptions.getLicense()

Parameters:

license - License of this package as an SPDX identifier.

Returns:

this

poetryOptions

@Stability(value=Experimental)
public PythonProjectOptions.Builder poetryOptions(PoetryPyprojectOptionsWithoutDeps poetryOptions)

Sets the value of PythonPackagingOptions.getPoetryOptions()

Parameters:

poetryOptions - Additional options to set for poetry if using poetry.

Returns:

this

setupConfig

@Stability(value=Experimental)
public PythonProjectOptions.Builder setupConfig(Map<String,? extends Object> setupConfig)

Sets the value of PythonPackagingOptions.getSetupConfig()

Parameters:

setupConfig - Additional fields to pass in the setup() function if using setuptools.

Returns:

this

build

@Stability(value=Experimental)
public PythonProjectOptions build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<PythonProjectOptions>

Returns:

a new instance of PythonProjectOptions

Throws:

NullPointerException - if any required attribute was not provided