Uses of Class
io.github.cdklabs.projen.python.PythonProject.Builder

Packages that use PythonProject.Builder

Package	Description
io.github.cdklabs.projen.python

Uses of PythonProject.Builder in io.github.cdklabs.projen.python

Methods in io.github.cdklabs.projen.python that return PythonProject.Builder

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