Package io.github.cdklabs.projen.python

Class PythonProject

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

io.github.cdklabs.projen.Project

io.github.cdklabs.projen.github.GitHubProject

io.github.cdklabs.projen.python.PythonProject

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

Direct Known Subclasses:

AwsCdkPythonApp, Cdk8sPythonApp

@Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.230Z")
@Stability(Experimental)
public class PythonProject
extends GitHubProject

(experimental) Python project.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PythonProject.Builder	(experimental) A fluent builder for PythonProject.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default, software.constructs.IConstruct.Jsii$Proxy

Field Summary

Fields inherited from class io.github.cdklabs.projen.Project

DEFAULT_TASK

Constructor Summary

Constructors

Modifier	Constructor	Description
	PythonProject(PythonProjectOptions options)
protected	PythonProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	PythonProject(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	addDependency(String spec)	(experimental) Adds a runtime dependency.
void	addDevDependency(String spec)	(experimental) Adds a dev dependency.
IPythonDeps	getDepsManager()	(experimental) API for managing dependencies.
IPythonEnv	getEnvManager()	(experimental) API for mangaging the Python runtime environment.
String	getModuleName()	(experimental) Python module name (the project name, with any hyphens or periods replaced with underscores).
IPythonPackaging	getPackagingManager()	(experimental) API for managing packaging the project as a library.
Pytest	getPytest()	(experimental) Pytest component.
String	getVersion()	(experimental) Version of the package for distribution (should follow semver).
void	postSynthesize()	(experimental) Called after all components are synthesized.
void	setPytest(Pytest value)	(experimental) Pytest component.

Methods inherited from class io.github.cdklabs.projen.github.GitHubProject

annotateGenerated, getAutoApprove, getDevContainer, getGithub, getGitpod, getProjectType, getVscode

Methods inherited from class io.github.cdklabs.projen.Project

addExcludeFromCleanup, addGitIgnore, addPackageIgnore, addTask, addTask, addTip, getBuildTask, getCommitGenerated, getCompileTask, getComponents, getDefaultTask, getDeps, getEjected, getFiles, getGitattributes, getGitignore, getInitProject, getLogger, getName, getOutdir, getPackageTask, getParent, getPostCompileTask, getPreCompileTask, getProjectBuild, getProjenCommand, getRoot, getSubprojects, getTasks, getTestTask, isProject, of, preSynthesize, removeTask, runTaskCommand, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile, tryRemoveFile

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Detail

PythonProject

protected PythonProject(software.amazon.jsii.JsiiObjectRef objRef)

PythonProject

protected PythonProject(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

PythonProject

@Stability(Experimental)
public PythonProject(@NotNull
                     PythonProjectOptions options)

Parameters:

options - This parameter is required.

Method Detail

addDependency

@Stability(Experimental)
public void addDependency(@NotNull
                          String spec)

(experimental) Adds a runtime dependency.

Parameters:

spec - Format <module>@<semver>. This parameter is required.

addDevDependency

@Stability(Experimental)
public void addDevDependency(@NotNull
                             String spec)

(experimental) Adds a dev dependency.

Parameters:

spec - Format <module>@<semver>. This parameter is required.

postSynthesize

@Stability(Experimental)
public void postSynthesize()

(experimental) Called after all components are synthesized.

Order is not guaranteed.

Overrides:

postSynthesize in class Project

getDepsManager

@Stability(Experimental)
@NotNull
public IPythonDeps getDepsManager()

(experimental) API for managing dependencies.

getEnvManager

@Stability(Experimental)
@NotNull
public IPythonEnv getEnvManager()

(experimental) API for mangaging the Python runtime environment.

getModuleName

@Stability(Experimental)
@NotNull
public String getModuleName()

(experimental) Python module name (the project name, with any hyphens or periods replaced with underscores).

getVersion

@Stability(Experimental)
@NotNull
public String getVersion()

(experimental) Version of the package for distribution (should follow semver).

getPackagingManager

@Stability(Experimental)
@Nullable
public IPythonPackaging getPackagingManager()

(experimental) API for managing packaging the project as a library.

Only applies when the projectType is LIB.

getPytest

@Stability(Experimental)
@Nullable
public Pytest getPytest()

(experimental) Pytest component.

setPytest

@Stability(Experimental)
public void setPytest(@Nullable
                      Pytest value)

(experimental) Pytest component.