io.github.cdklabs.projen.python

Class PythonProject

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.projen.Project

io.github.cdklabs.projen.github.GitHubProject

io.github.cdklabs.projen.python.PythonProject

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.902Z")
 @Stability(value=Experimental)
public class PythonProject
extends GitHubProject

(experimental) Python project.

Nested Class Summary

Nested Classes

Modifier and Type	Class and 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

Field Summary

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

DEFAULT_TASK

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and 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.

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, getCompileTask, getComponents, getDefaultTask, getDeps, getFiles, getGitattributes, getGitignore, getInitProject, getLogger, getName, getOutdir, getPackageTask, getParent, getPostCompileTask, getPreCompileTask, getProjectBuild, getProjenCommand, getRoot, getTasks, getTestTask, preSynthesize, removeTask, runTaskCommand, synth, tryFindFile, tryFindJsonFile, tryFindObjectFile

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, toString, 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(value=Experimental)
public PythonProject(@NotNull
                                                    PythonProjectOptions options)

Parameters:

options - This parameter is required.

Method Detail

addDependency

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

(experimental) Adds a runtime dependency.

Parameters:

spec - Format `@`. This parameter is required.

addDevDependency

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

(experimental) Adds a dev dependency.

Parameters:

spec - Format `@`. This parameter is required.

postSynthesize

@Stability(value=Experimental)
public void postSynthesize()

(experimental) Called after all components are synthesized.

Order is not guaranteed.

Overrides:

postSynthesize in class Project

getDepsManager

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

(experimental) API for managing dependencies.

getEnvManager

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

(experimental) API for mangaging the Python runtime environment.

getModuleName

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

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

getVersion

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

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

getPackagingManager

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

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

Only applies when the projectType is LIB.

getPytest

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

(experimental) Pytest component.