io.github.cdklabs.projen.python

Class PythonProject.Builder

java.lang.Object

io.github.cdklabs.projen.python.PythonProject.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<PythonProject>

Enclosing class:

PythonProject

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

(experimental) A fluent builder for PythonProject.

Method Summary

Modifier and Type	Method and Description
PythonProject.Builder	authorEmail(String authorEmail) (experimental) Author's e-mail.
PythonProject.Builder	authorName(String authorName) (experimental) Author's name.
PythonProject.Builder	autoApproveOptions(AutoApproveOptions autoApproveOptions) (experimental) Enable and configure the 'auto approve' workflow.
PythonProject.Builder	autoMergeOptions(AutoMergeOptions autoMergeOptions) (experimental) Configure options for automatic merging on GitHub.
PythonProject	build()
PythonProject.Builder	classifiers(List<String> classifiers) (experimental) A list of PyPI trove classifiers that describe the project.
PythonProject.Builder	clobber(Boolean clobber) (experimental) Add a `clobber` task which resets the repo to origin.
static PythonProject.Builder	create()
PythonProject.Builder	deps(List<String> deps) (experimental) List of runtime dependencies for this project.
PythonProject.Builder	description(String description) (experimental) A short description of the package.
PythonProject.Builder	devContainer(Boolean devContainer) (experimental) Add a VSCode development environment (used for GitHub Codespaces).
PythonProject.Builder	devDeps(List<String> devDeps) (experimental) List of dev dependencies for this project.
PythonProject.Builder	github(Boolean github) (experimental) Enable GitHub integration.
PythonProject.Builder	githubOptions(GitHubOptions githubOptions) (experimental) Options for GitHub integration.
PythonProject.Builder	gitpod(Boolean gitpod) (experimental) Add a Gitpod development environment.
PythonProject.Builder	homepage(String homepage) (experimental) A URL to the website of the project.
PythonProject.Builder	license(String license) (experimental) License of this package as an SPDX identifier.
PythonProject.Builder	logging(LoggerOptions logging) (experimental) Configure logging options such as verbosity.
PythonProject.Builder	mergify(Boolean mergify) Deprecated. use `githubOptions.mergify` instead
PythonProject.Builder	mergifyOptions(MergifyOptions mergifyOptions) Deprecated. use `githubOptions.mergifyOptions` instead
PythonProject.Builder	moduleName(String moduleName) (experimental) Name of the python package as used in imports and filenames.
PythonProject.Builder	name(String name) (experimental) This is the name of your project.
PythonProject.Builder	outdir(String outdir) (experimental) The root directory of the project.
PythonProject.Builder	parent(Project parent) (experimental) The parent project, if this project is part of a bigger project.
PythonProject.Builder	pip(Boolean pip) (experimental) Use pip with a requirements.txt file to track project dependencies.
PythonProject.Builder	poetry(Boolean poetry) (experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
PythonProject.Builder	poetryOptions(PoetryPyprojectOptionsWithoutDeps poetryOptions) (experimental) Additional options to set for poetry if using poetry.
PythonProject.Builder	projectType(ProjectType projectType) Deprecated. no longer supported at the base project level
PythonProject.Builder	projenCommand(String projenCommand) (experimental) The shell command to use in order to run the projen CLI.
PythonProject.Builder	projenrcJson(Boolean projenrcJson) (experimental) Generate (once) .projenrc.json (in JSON).
PythonProject.Builder	projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions) (experimental) Options for .projenrc.json.
PythonProject.Builder	projenrcPython(Boolean projenrcPython) (experimental) Use projenrc in python.
PythonProject.Builder	projenrcPythonOptions(ProjenrcOptions projenrcPythonOptions) (experimental) Options related to projenrc in python.
PythonProject.Builder	pytest(Boolean pytest) (experimental) Include pytest tests.
PythonProject.Builder	pytestOptions(PytestOptions pytestOptions) (experimental) pytest options.
PythonProject.Builder	readme(SampleReadmeProps readme) (experimental) The README setup.
PythonProject.Builder	sample(Boolean sample) (experimental) Include sample code and test if the relevant directories don't exist.
PythonProject.Builder	setupConfig(Map<String,? extends Object> setupConfig) (experimental) Additional fields to pass in the setup() function if using setuptools.
PythonProject.Builder	setuptools(Boolean setuptools) (experimental) Use setuptools with a setup.py script for packaging and publishing.
PythonProject.Builder	stale(Boolean stale) (experimental) Auto-close of stale issues and pull request.
PythonProject.Builder	staleOptions(StaleOptions staleOptions) (experimental) Auto-close stale issues and pull requests.
PythonProject.Builder	venv(Boolean venv) (experimental) Use venv to manage a virtual environment for installing dependencies inside.
PythonProject.Builder	venvOptions(VenvOptions venvOptions) (experimental) Venv options.
PythonProject.Builder	version(String version) (experimental) Version of the package.
PythonProject.Builder	vscode(Boolean vscode) (experimental) Enable VSCode integration.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Experimental)
public static PythonProject.Builder create()

Returns:

a new instance of PythonProject.Builder.

name

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

(experimental) This is the name of your project.

Default: $BASEDIR

Parameters:

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

Returns:

this

logging

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

(experimental) Configure logging options such as verbosity.

Default: {}

Parameters:

logging - Configure logging options such as verbosity. This parameter is required.

Returns:

this

outdir

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

(experimental) 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.

Default: "."

Parameters:

outdir - The root directory of the project. This parameter is required.

Returns:

this

parent

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

(experimental) The parent project, if this project is part of a bigger project.

Parameters:

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

Returns:

this

projenCommand

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

(experimental) The shell command to use in order to run the projen CLI.

Can be used to customize in special environments.

Default: "npx projen"

Parameters:

projenCommand - The shell command to use in order to run the projen CLI. This parameter is required.

Returns:

this

projenrcJson

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

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

Default: false

Parameters:

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

Returns:

this

projenrcJsonOptions

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

(experimental) Options for .projenrc.json.

Default: - default options

Parameters:

projenrcJsonOptions - Options for .projenrc.json. This parameter is required.

Returns:

this

autoApproveOptions

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

(experimental) Enable and configure the 'auto approve' workflow.

Default: - auto approve is disabled

Parameters:

autoApproveOptions - Enable and configure the 'auto approve' workflow. This parameter is required.

Returns:

this

autoMergeOptions

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

(experimental) Configure options for automatic merging on GitHub.

Has no effect if github.mergify is set to false.

Default: - see defaults in `AutoMergeOptions`

Parameters:

autoMergeOptions - Configure options for automatic merging on GitHub. This parameter is required.

Returns:

this

clobber

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

(experimental) Add a `clobber` task which resets the repo to origin.

Default: true

Parameters:

clobber - Add a `clobber` task which resets the repo to origin. This parameter is required.

Returns:

this

devContainer

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

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

Default: false

Parameters:

devContainer - Add a VSCode development environment (used for GitHub Codespaces). This parameter is required.

Returns:

this

github

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

(experimental) Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

Default: true

Parameters:

github - Enable GitHub integration. This parameter is required.

Returns:

this

githubOptions

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

(experimental) Options for GitHub integration.

Default: - see GitHubOptions

Parameters:

githubOptions - Options for GitHub integration. This parameter is required.

Returns:

this

gitpod

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

(experimental) Add a Gitpod development environment.

Default: false

Parameters:

gitpod - Add a Gitpod development environment. This parameter is required.

Returns:

this

mergify

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

Deprecated. use `githubOptions.mergify` instead

(deprecated) Whether mergify should be enabled on this repository or not.

Default: true

Parameters:

mergify - Whether mergify should be enabled on this repository or not. This parameter is required.

Returns:

this

mergifyOptions

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

Deprecated. use `githubOptions.mergifyOptions` instead

(deprecated) Options for mergify.

Default: - default options

Parameters:

mergifyOptions - Options for mergify. This parameter is required.

Returns:

this

projectType

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

Deprecated. no longer supported at the base project level

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

Default: ProjectType.UNKNOWN

Parameters:

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

Returns:

this

readme

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

(experimental) The README setup.

Default: - { filename: 'README.md', contents: '# replace this' }

Example:

 // Example automatically generated from non-compiling source. May contain errors.
 "{ filename: 'readme.md', contents: '# title' }"
 

Parameters:

readme - The README setup. This parameter is required.

Returns:

this

stale

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

(experimental) Auto-close of stale issues and pull request.

See staleOptions for options.

Default: true

Parameters:

stale - Auto-close of stale issues and pull request. This parameter is required.

Returns:

this

staleOptions

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

(experimental) Auto-close stale issues and pull requests.

To disable set stale to false.

Default: - see defaults in `StaleOptions`

Parameters:

staleOptions - Auto-close stale issues and pull requests. This parameter is required.

Returns:

this

vscode

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

(experimental) Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

Default: true

Parameters:

vscode - Enable VSCode integration. This parameter is required.

Returns:

this

authorEmail

@Stability(value=Experimental)
public PythonProject.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(value=Experimental)
public PythonProject.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(value=Experimental)
public PythonProject.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(value=Experimental)
public PythonProject.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(value=Experimental)
public PythonProject.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(value=Experimental)
public PythonProject.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(value=Experimental)
public PythonProject.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

poetryOptions

@Stability(value=Experimental)
public PythonProject.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(value=Experimental)
public PythonProject.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

moduleName

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

(experimental) Name of the python package as used in imports and filenames.

Must only consist of alphanumeric characters and underscores.

Default: $PYTHON_MODULE_NAME

Parameters:

moduleName - Name of the python package as used in imports and filenames. This parameter is required.

Returns:

this

deps

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

(experimental) List of runtime dependencies for this project.

Dependencies use the format: <module>@<semver>

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

Default: []

Parameters:

deps - List of runtime dependencies for this project. This parameter is required.

Returns:

this

devDeps

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

(experimental) List of dev dependencies for this project.

Dependencies use the format: <module>@<semver>

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

Default: []

Parameters:

devDeps - List of dev dependencies for this project. This parameter is required.

Returns:

this

pip

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

(experimental) Use pip with a requirements.txt file to track project dependencies.

Default: true

Parameters:

pip - Use pip with a requirements.txt file to track project dependencies. This parameter is required.

Returns:

this

poetry

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

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

Default: false

Parameters:

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

Returns:

this

projenrcPython

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

(experimental) Use projenrc in python.

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

Default: true

Parameters:

projenrcPython - Use projenrc in python. This parameter is required.

Returns:

this

projenrcPythonOptions

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

(experimental) Options related to projenrc in python.

Default: - default options

Parameters:

projenrcPythonOptions - Options related to projenrc in python. This parameter is required.

Returns:

this

pytest

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

(experimental) Include pytest tests.

Default: true

Parameters:

pytest - Include pytest tests. This parameter is required.

Returns:

this

pytestOptions

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

(experimental) pytest options.

Default: - defaults

Parameters:

pytestOptions - pytest options. This parameter is required.

Returns:

this

sample

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

(experimental) Include sample code and test if the relevant directories don't exist.

Default: true

Parameters:

sample - Include sample code and test if the relevant directories don't exist. This parameter is required.

Returns:

this

setuptools

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

(experimental) Use setuptools with a setup.py script for packaging and publishing.

Default: - true if the project type is library

Parameters:

setuptools - Use setuptools with a setup.py script for packaging and publishing. This parameter is required.

Returns:

this

venv

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

(experimental) Use venv to manage a virtual environment for installing dependencies inside.

Default: true

Parameters:

venv - Use venv to manage a virtual environment for installing dependencies inside. This parameter is required.

Returns:

this

venvOptions

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

(experimental) Venv options.

Default: - defaults

Parameters:

venvOptions - Venv options. This parameter is required.

Returns:

this

build

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

Specified by:

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