io.github.cdklabs.projen.python

Interface PythonProjectOptions

All Superinterfaces:

GitHubProjectOptions, software.amazon.jsii.JsiiSerializable, ProjectOptions, PythonPackagingOptions

All Known Implementing Classes:

PythonProjectOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.905Z")
 @Stability(value=Experimental)
public interface PythonProjectOptions
extends software.amazon.jsii.JsiiSerializable, GitHubProjectOptions, PythonPackagingOptions

(experimental) Options for `PythonProject`.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PythonProjectOptions.Builder A builder for PythonProjectOptions
static class	PythonProjectOptions.Jsii$Proxy An implementation for PythonProjectOptions

Method Summary

Modifier and Type	Method and Description
static PythonProjectOptions.Builder	builder()
default List<String>	getDeps() (experimental) List of runtime dependencies for this project.
default List<String>	getDevDeps() (experimental) List of dev dependencies for this project.
String	getModuleName() (experimental) Name of the python package as used in imports and filenames.
default Boolean	getPip() (experimental) Use pip with a requirements.txt file to track project dependencies.
default Boolean	getPoetry() (experimental) Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
default Boolean	getProjenrcPython() (experimental) Use projenrc in python.
default ProjenrcOptions	getProjenrcPythonOptions() (experimental) Options related to projenrc in python.
default Boolean	getPytest() (experimental) Include pytest tests.
default PytestOptions	getPytestOptions() (experimental) pytest options.
default Boolean	getSample() (experimental) Include sample code and test if the relevant directories don't exist.
default Boolean	getSetuptools() (experimental) Use setuptools with a setup.py script for packaging and publishing.
default Boolean	getVenv() (experimental) Use venv to manage a virtual environment for installing dependencies inside.
default VenvOptions	getVenvOptions() (experimental) Venv options.

Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

getAutoApproveOptions, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getReadme, getStale, getStaleOptions, getVscode

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Methods inherited from interface io.github.cdklabs.projen.python.PythonPackagingOptions

getAuthorEmail, getAuthorName, getClassifiers, getDescription, getHomepage, getLicense, getPoetryOptions, getSetupConfig, getVersion

Method Detail

getModuleName

@Stability(value=Experimental)
 @NotNull
String getModuleName()

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

Must only consist of alphanumeric characters and underscores.

Default: $PYTHON_MODULE_NAME

getDeps

@Stability(value=Experimental)
 @Nullable
default List<String> getDeps()

(experimental) List of runtime dependencies for this project.

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

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

Default: []

getDevDeps

@Stability(value=Experimental)
 @Nullable
default List<String> getDevDeps()

(experimental) List of dev dependencies for this project.

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

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

Default: []

getPip

@Stability(value=Experimental)
 @Nullable
default Boolean getPip()

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

Default: true

getPoetry

@Stability(value=Experimental)
 @Nullable
default Boolean getPoetry()

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

Default: false

getProjenrcPython

@Stability(value=Experimental)
 @Nullable
default Boolean getProjenrcPython()

(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

getProjenrcPythonOptions

@Stability(value=Experimental)
 @Nullable
default ProjenrcOptions getProjenrcPythonOptions()

(experimental) Options related to projenrc in python.

Default: - default options

getPytest

@Stability(value=Experimental)
 @Nullable
default Boolean getPytest()

(experimental) Include pytest tests.

Default: true

getPytestOptions

@Stability(value=Experimental)
 @Nullable
default PytestOptions getPytestOptions()

(experimental) pytest options.

Default: - defaults

getSample

@Stability(value=Experimental)
 @Nullable
default Boolean getSample()

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

Default: true

getSetuptools

@Stability(value=Experimental)
 @Nullable
default Boolean getSetuptools()

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

Default: - true if the project type is library

getVenv

@Stability(value=Experimental)
 @Nullable
default Boolean getVenv()

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

Default: true

getVenvOptions

@Stability(value=Experimental)
 @Nullable
default VenvOptions getVenvOptions()

(experimental) Venv options.

Default: - defaults

builder

@Stability(value=Experimental)
static PythonProjectOptions.Builder builder()

Specified by:

builder in interface GitHubProjectOptions

Specified by:

builder in interface ProjectOptions

Specified by:

builder in interface PythonPackagingOptions

Returns:

a PythonProjectOptions.Builder of PythonProjectOptions