| Package | Description |
|---|---|
| io.github.cdklabs.projen.python |
| Modifier and Type | Method and 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.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.
|
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.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.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.projenrcJson(Boolean projenrcJson)
(experimental) Generate (once) .projenrc.json (in JSON).
|
PythonProject.Builder |
PythonProject.Builder.projenrcJsonOptions(ProjenrcOptions projenrcJsonOptions)
(experimental) Options for .projenrc.json.
|
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.pytest(Boolean pytest)
(experimental) Include pytest tests.
|
PythonProject.Builder |
PythonProject.Builder.pytestOptions(PytestOptions pytestOptions)
(experimental) pytest options.
|
PythonProject.Builder |
PythonProject.Builder.readme(SampleReadmeProps readme)
(experimental) The README setup.
|
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.
|
Copyright © 2021. All rights reserved.