`python` Submodule

Constructs

Pip

Implements: IPythonDeps

Manages dependencies using a requirements.txt file and the pip CLI tool.

Initializers

import { python } from 'projen'

new python.Pip(project: Project, _options?: PipOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`_options`	`PipOptions`	No description.

`project`^Required

Type: projen.Project

`_options`^Optional

Type: PipOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.
`addDependency`	Adds a runtime dependency.
`addDevDependency`	Adds a dev dependency.
`installDependencies`	Installs dependencies (called during post-synthesis).

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

It does not run on later projen invocations. It only fires for projen new (or Projects.createProject). It is also skipped when post-synthesis steps are disabled, e.g. --no-post or PROJEN_DISABLE_POST. Use it for one-off setup that can be turned off by the user, like running a task to give the user immediate feedback on their new project. Order across components is not guaranteed.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

It does not run on later projen invocations. It only fires for projen new (or Projects.createProject). Use it for deterministic, one-off file generation. Order across components is not guaranteed.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addDependency`

public addDependency(spec: string): void

Adds a runtime dependency.

`spec`^Required

Type: string

Format <module>@<semver>.

`addDevDependency`

public addDevDependency(spec: string): void

Adds a dev dependency.

`spec`^Required

Type: string

Format <module>@<semver>.

`installDependencies`

public installDependencies(): void

Installs dependencies (called during post-synthesis).

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.Pip.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.Pip.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`installCiTask`	`projen.Task`	A task that installs and updates dependencies.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`installCiTask`^Required

public readonly installCiTask: Task;

Type: projen.Task

A task that installs and updates dependencies.

Poetry

Implements: IPythonDeps, IPythonEnv, IPythonPackaging

Manage project dependencies, virtual environments, and packaging through the poetry CLI tool.

Initializers

import { python } from 'projen'

new python.Poetry(project: Project, options: PoetryOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`PoetryOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Required

Type: PoetryOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.
`addDependency`	Adds a runtime dependency.
`addDevDependency`	Adds a dev dependency.
`installDependencies`	Installs dependencies (called during post-synthesis).
`setupEnvironment`	Initializes the virtual environment if it doesn't exist (called during post-synthesis).

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addDependency`

public addDependency(spec: string): void

Adds a runtime dependency.

`spec`^Required

Type: string

Format <module>@<semver>.

`addDevDependency`

public addDevDependency(spec: string): void

Adds a dev dependency.

`spec`^Required

Type: string

Format <module>@<semver>.

`installDependencies`

public installDependencies(): void

Installs dependencies (called during post-synthesis).

`setupEnvironment`

public setupEnvironment(): void

Initializes the virtual environment if it doesn't exist (called during post-synthesis).

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.Poetry.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.Poetry.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`installCiTask`	`projen.Task`	Task for installing dependencies according to the existing lockfile.
`installTask`	`projen.Task`	Task for updating the lockfile and installing project dependencies.
`publishTask`	`projen.Task`	Task for publishing the package to a package repository.
`publishTestTask`	`projen.Task`	Task for publishing the package to the Test PyPI repository for testing purposes.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`installCiTask`^Required

public readonly installCiTask: Task;

Type: projen.Task

Task for installing dependencies according to the existing lockfile.

`installTask`^Required

public readonly installTask: Task;

Type: projen.Task

Task for updating the lockfile and installing project dependencies.

`publishTask`^Required

public readonly publishTask: Task;

Type: projen.Task

Task for publishing the package to a package repository.

`publishTestTask`^Required

public readonly publishTestTask: Task;

Type: projen.Task

Task for publishing the package to the Test PyPI repository for testing purposes.

PoetryPyproject

Represents configuration of a pyproject.toml file for a Poetry project.

https://python-poetry.org/docs/pyproject/

Initializers

import { python } from 'projen'

new python.PoetryPyproject(scope: IConstruct, options: PoetryPyprojectOptions)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`options`	`PoetryPyprojectOptions`	No description.

`scope`^Required

Type: constructs.IConstruct

`options`^Required

Type: PoetryPyprojectOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.PoetryPyproject.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.PoetryPyproject.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`file`	`PyprojectTomlFile`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`file`^Required

public readonly file: PyprojectTomlFile;

Type: PyprojectTomlFile

Projenrc

Allows writing projenrc files in python.

This will install projen as a Python dependency and will add a synth task which will run .projenrc.py.

Initializers

import { python } from 'projen'

new python.Projenrc(project: Project, options?: ProjenrcOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`ProjenrcOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Optional

Type: ProjenrcOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.
`of`	Returns the `Projenrc` instance associated with a project or `undefined` if there is no Projenrc.

`isConstruct`

import { python } from 'projen'

python.Projenrc.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.Projenrc.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

`of`

import { python } from 'projen'

python.Projenrc.of(project: Project)

Returns the Projenrc instance associated with a project or undefined if there is no Projenrc.

`project`^Required

Type: projen.Project

The project.

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`filePath`	`string`	The name of the projenrc file.
`pythonExec`	`string`	Path to the python executable to use.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`filePath`^Required

public readonly filePath: string;

Type: string

The name of the projenrc file.

`pythonExec`^Required

public readonly pythonExec: string;

Type: string

Path to the python executable to use.

PyprojectTomlFile

Represents configuration of a pyproject.toml file.

https://packaging.python.org/en/latest/guides/writing-pyproject-toml/

Initializers

import { python } from 'projen'

new python.PyprojectTomlFile(scope: IConstruct, config: PyprojectToml)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`config`	`PyprojectToml`	No description.

`scope`^Required

Type: constructs.IConstruct

`config`^Required

Type: PyprojectToml

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Writes the file to the project's output directory.
`diff`	Returns a unified diff of the old and new file contents with context lines and hunk headers.
`addDeletionOverride`	Syntactic sugar for `addOverride(path, undefined)`.
`addOverride`	Adds an override to the synthesized object file.
`addToArray`	Adds to an array in the synthesized object file.
`patch`	Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`diff`

public diff(colorize?: boolean, contextLines?: number): string[]

Returns a unified diff of the old and new file contents with context lines and hunk headers.

Only available after synthesis.

This is an expensive operation and should only be used on non time-critical code paths, like debug output.

`colorize`^Optional

Type: boolean

Whether to colorize the diff output.

`contextLines`^Optional

Type: number

Number of context lines around changes.

`addDeletionOverride`

public addDeletionOverride(path: string): void

Syntactic sugar for addOverride(path, undefined).

`path`^Required

Type: string

The path of the value to delete.

`addOverride`

public addOverride(path: string, value: any): void

Adds an override to the synthesized object file.

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

project.tsconfig.file.addOverride('compilerOptions.alwaysStrict', true);
project.tsconfig.file.addOverride('compilerOptions.lib', ['dom', 'dom.iterable', 'esnext']);

would add the overrides

"compilerOptions": {
  "alwaysStrict": true,
  "lib": [
    "dom",
    "dom.iterable",
    "esnext"
  ]
  ...
}
...

`path`^Required

Type: string

The path of the property, you can use dot notation to override values in complex types.

Any intermediate keys will be created as needed.

`value`^Required

Type: any

The value.

Could be primitive or complex.

`addToArray`

public addToArray(path: string, values: ...any[]): void

Adds to an array in the synthesized object file.

If the array is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example, with the following object file

"compilerOptions": {
  "exclude": ["node_modules"],
  "lib": ["es2020"]
  ...
}
...

project.tsconfig.file.addToArray('compilerOptions.exclude', 'coverage');
project.tsconfig.file.addToArray('compilerOptions.lib', 'dom', 'dom.iterable', 'esnext');

would result in the following object file

"compilerOptions": {
  "exclude": ["node_modules", "coverage"],
  "lib": ["es2020", "dom", "dom.iterable", "esnext"]
  ...
}
...

`path`^Required

Type: string

The path of the property, you can use dot notation to att to arrays in complex types.

Any intermediate keys will be created as needed.

`values`^Required

Type: ...any[]

The values to add.

Could be primitive or complex.

`patch`

public patch(patches: ...JsonPatch[]): void

Applies an RFC 6902 JSON-patch to the synthesized object file. See https://datatracker.ietf.org/doc/html/rfc6902 for more information.

For example, with the following object file

"compilerOptions": {
  "exclude": ["node_modules"],
  "lib": ["es2020"]
  ...
}
...

project.tsconfig.file.patch(JsonPatch.add("/compilerOptions/exclude/-", "coverage"));
project.tsconfig.file.patch(JsonPatch.replace("/compilerOptions/lib", ["dom", "dom.iterable", "esnext"]));

would result in the following object file

"compilerOptions": {
  "exclude": ["node_modules", "coverage"],
  "lib": ["dom", "dom.iterable", "esnext"]
  ...
}
...

`patches`^Required

Type: ...projen.JsonPatch[]

The patch operations to apply.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.PyprojectTomlFile.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.PyprojectTomlFile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`committed`	`boolean`	Indicates if the file will be committed.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.
`omitEmpty`	`boolean`	Indicates if empty objects and arrays are omitted from the output object.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`committed`^Required

public readonly committed: boolean;

Type: boolean

Indicates if the file will be committed.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

`omitEmpty`^Required

public readonly omitEmpty: boolean;

Type: boolean

Indicates if empty objects and arrays are omitted from the output object.

Pytest

Initializers

import { python } from 'projen'

new python.Pytest(project: Project, options?: PytestOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`PytestOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Optional

Type: PytestOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.Pytest.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.Pytest.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`testMatch`	`string[]`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`testMatch`^Required

public readonly testMatch: string[];

Type: string[]

PytestSample

Python test code sample.

Initializers

import { python } from 'projen'

new python.PytestSample(project: Project, options: PytestSampleOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`PytestSampleOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Required

Type: PytestSampleOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.PytestSample.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.PytestSample.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

PythonProject

Python project.

Initializers

import { python } from 'projen'

new python.PythonProject(options: PythonProjectOptions)

Name	Type	Description
`options`	`PythonProjectOptions`	No description.

`options`^Required

Type: PythonProjectOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`addExcludeFromCleanup`	Exclude the matching files from pre-synth cleanup.
`addGitIgnore`	Adds a .gitignore pattern.
`addPackageIgnore`	Exclude these files from the bundled package.
`addTask`	Adds a new task to this project.
`annotateGenerated`	Marks the provided file(s) as being generated.
`postSynthesize`	Called after all components are synthesized.
`preSynthesize`	Called before all components are synthesized.
`removeTask`	Removes a task from a project.
`runTaskCommand`	Returns the shell command to execute in order to run a task.
`synth`	Synthesize all project files into `outdir`.
`tryFindFile`	Finds a file at the specified relative path within this project and all its subprojects.
`tryFindObjectFile`	Finds an object file (like JsonFile, YamlFile, etc.) by name.
`tryRemoveFile`	Finds a file at the specified relative path within this project and removes it.
`addDependency`	Adds a runtime dependency.
`addDevDependency`	Adds a dev dependency.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`addExcludeFromCleanup`

public addExcludeFromCleanup(globs: ...string[]): void

Exclude the matching files from pre-synth cleanup.

Can be used when, for example, some source files include the projen marker and we don't want them to be erased during synth.

`globs`^Required

Type: ...string[]

The glob patterns to match.

`addGitIgnore`

public addGitIgnore(pattern: string): void

Adds a .gitignore pattern.

`pattern`^Required

Type: string

The glob pattern to ignore.

`addPackageIgnore`

public addPackageIgnore(_pattern: string): void

Exclude these files from the bundled package.

Implemented by project types based on the packaging mechanism. For example, NodeProject delegates this to .npmignore.

`_pattern`^Required

Type: string

The glob pattern to exclude.

`addTask`

public addTask(name: string, props?: TaskOptions): Task

Adds a new task to this project.

This will fail if the project already has a task with this name.

`name`^Required

Type: string

The task name to add.

`props`^Optional

Type: projen.TaskOptions

Task properties.

`annotateGenerated`

public annotateGenerated(glob: string): void

Marks the provided file(s) as being generated.

This is achieved using the github-linguist attributes. Generated files do not count against the repository statistics and language breakdown.

https://github.com/github/linguist/blob/master/docs/overrides.md

`glob`^Required

Type: string

the glob pattern to match (could be a file path).

`postSynthesize`

public postSynthesize(): void

Called after all components are synthesized.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before all components are synthesized.

`removeTask`

public removeTask(name: string): Task

Removes a task from a project.

`name`^Required

Type: string

The name of the task to remove.

`runTaskCommand`

public runTaskCommand(task: Task): string

Returns the shell command to execute in order to run a task.

By default, this is npx projen@<version> <task>

`task`^Required

Type: projen.Task

The task for which the command is required.

`synth`

public synth(): void

Synthesize all project files into outdir.

Call "this.preSynthesize()"
Delete all generated files
Synthesize all subprojects
Synthesize all components of this project
Call "projectCreation()" for all components, only if the project is being created for the first time
Call "postSynthesize()" for all components of this project
Call "this.postSynthesize()"
Call "postProjectCreation()" for all components, only if the project is being created for the first time

`tryFindFile`

public tryFindFile(filePath: string): FileBase

Finds a file at the specified relative path within this project and all its subprojects.

`filePath`^Required

Type: string

The file path.

If this path is relative, it will be resolved from the root of this project.

`tryFindObjectFile`

public tryFindObjectFile(filePath: string): ObjectFile

Finds an object file (like JsonFile, YamlFile, etc.) by name.

`filePath`^Required

Type: string

The file path.

`tryRemoveFile`

public tryRemoveFile(filePath: string): FileBase

Finds a file at the specified relative path within this project and removes it.

`filePath`^Required

Type: string

The file path.

If this path is relative, it will be resolved from the root of this project.

`addDependency`

public addDependency(spec: string): void

Adds a runtime dependency.

`spec`^Required

Type: string

Format <module>@<semver>.

`addDevDependency`

public addDevDependency(spec: string): void

Adds a dev dependency.

`spec`^Required

Type: string

Format <module>@<semver>.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isProject`	Test whether the given construct is a project.
`of`	Find the closest ancestor project for given construct.

`isConstruct`

import { python } from 'projen'

python.PythonProject.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isProject`

import { python } from 'projen'

python.PythonProject.isProject(x: any)

Test whether the given construct is a project.

`x`^Required

Type: any

`of`

import { python } from 'projen'

python.PythonProject.of(construct: IConstruct)

Find the closest ancestor project for given construct.

When given a project, this it the project itself.

`construct`^Required

Type: constructs.IConstruct

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`buildTask`	`projen.Task`	No description.
`commitGenerated`	`boolean`	Whether to commit the managed files by default.
`compileTask`	`projen.Task`	No description.
`components`	`projen.Component[]`	Returns all the components within this project.
`deps`	`projen.Dependencies`	Project dependencies.
`ejected`	`boolean`	Whether or not the project is being ejected.
`files`	`projen.FileBase[]`	All files in this project.
`gitattributes`	`projen.GitAttributesFile`	The .gitattributes file for this repository.
`gitignore`	`projen.IgnoreFile`	.gitignore.
`logger`	`projen.Logger`	Logging utilities.
`name`	`string`	Project name.
`outdir`	`string`	Absolute output directory of this project.
`packageTask`	`projen.Task`	No description.
`postCompileTask`	`projen.Task`	No description.
`preCompileTask`	`projen.Task`	No description.
`projectBuild`	`projen.ProjectBuild`	Manages the build process of the project.
`projenCommand`	`string`	The command to use in order to run the projen CLI.
`root`	`projen.Project`	The root project.
`subprojects`	`projen.Project[]`	Returns all the subprojects within this project.
`tasks`	`projen.Tasks`	Project tasks.
`testTask`	`projen.Task`	No description.
`defaultTask`	`projen.Task`	This is the "default" task, the one that executes "projen".
`initProject`	`projen.InitProject`	The options used when this project is bootstrapped via `projen new`.
`parent`	`projen.Project`	A parent project.
`autoApprove`	`projen.github.AutoApprove`	Auto approve set up for this project.
`devContainer`	`projen.vscode.DevContainer`	Access for .devcontainer.json (used for GitHub Codespaces).
`github`	`projen.github.GitHub`	Access all github components.
`gitpod`	`projen.Gitpod`	Access for Gitpod.
`vscode`	`projen.vscode.VsCode`	Access all VSCode components.
`depsManager`	`IPythonDeps`	API for managing dependencies.
`envManager`	`IPythonEnv`	API for managing the Python runtime environment.
`moduleName`	`string`	Python module name (the project name, with any hyphens or periods replaced with underscores).
`sampleTestdir`	`string`	Directory where sample tests are located.
`version`	`string`	Version of the package for distribution (should follow semver).
`packagingManager`	`IPythonPackaging`	API for managing packaging the project as a library.
`pytest`	`Pytest`	Pytest component.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`buildTask`^Required

public readonly buildTask: Task;

Type: projen.Task

`commitGenerated`^Required

public readonly commitGenerated: boolean;

Type: boolean

Whether to commit the managed files by default.

`compileTask`^Required

public readonly compileTask: Task;

Type: projen.Task

`components`^Required

public readonly components: Component[];

Type: projen.Component[]

Returns all the components within this project.

`deps`^Required

public readonly deps: Dependencies;

Type: projen.Dependencies

Project dependencies.

`ejected`^Required

public readonly ejected: boolean;

Type: boolean

Whether or not the project is being ejected.

`files`^Required

public readonly files: FileBase[];

Type: projen.FileBase[]

All files in this project.

`gitattributes`^Required

public readonly gitattributes: GitAttributesFile;

Type: projen.GitAttributesFile

The .gitattributes file for this repository.

`gitignore`^Required

public readonly gitignore: IgnoreFile;

Type: projen.IgnoreFile

.gitignore.

`logger`^Required

public readonly logger: Logger;

Type: projen.Logger

Logging utilities.

`name`^Required

public readonly name: string;

Type: string

Project name.

`outdir`^Required

public readonly outdir: string;

Type: string

Absolute output directory of this project.

`packageTask`^Required

public readonly packageTask: Task;

Type: projen.Task

`postCompileTask`^Required

public readonly postCompileTask: Task;

Type: projen.Task

`preCompileTask`^Required

public readonly preCompileTask: Task;

Type: projen.Task

`projectBuild`^Required

public readonly projectBuild: ProjectBuild;

Type: projen.ProjectBuild

Manages the build process of the project.

`projenCommand`^Required

public readonly projenCommand: string;

Type: string

The command to use in order to run the projen CLI.

`root`^Required

public readonly root: Project;

Type: projen.Project

The root project.

`subprojects`^Required

public readonly subprojects: Project[];

Type: projen.Project[]

Returns all the subprojects within this project.

`tasks`^Required

public readonly tasks: Tasks;

Type: projen.Tasks

Project tasks.

`testTask`^Required

public readonly testTask: Task;

Type: projen.Task

`defaultTask`^Optional

public readonly defaultTask: Task;

Type: projen.Task

This is the "default" task, the one that executes "projen".

Undefined if the project is being ejected.

`initProject`^Optional

Deprecated: use the initProject argument passed to Component.projectCreation() instead.

public readonly initProject: InitProject;

Type: projen.InitProject

The options used when this project is bootstrapped via projen new.

It includes the original set of options passed to the CLI and also the JSII FQN of the project type.

`parent`^Optional

public readonly parent: Project;

Type: projen.Project

A parent project.

If undefined, this is the root project.

`autoApprove`^Optional

public readonly autoApprove: AutoApprove;

Type: projen.github.AutoApprove

Auto approve set up for this project.

`devContainer`^Optional

public readonly devContainer: DevContainer;

Type: projen.vscode.DevContainer

Access for .devcontainer.json (used for GitHub Codespaces).

This will be undefined if devContainer boolean is false

`github`^Optional

public readonly github: GitHub;

Type: projen.github.GitHub

Access all github components.

This will be undefined for subprojects.

`gitpod`^Optional

public readonly gitpod: Gitpod;

Type: projen.Gitpod

Access for Gitpod.

This will be undefined if gitpod boolean is false

`vscode`^Optional

public readonly vscode: VsCode;

Type: projen.vscode.VsCode

Access all VSCode components.

This will be undefined for subprojects.

`depsManager`^Required

public readonly depsManager: IPythonDeps;

Type: IPythonDeps

API for managing dependencies.

`envManager`^Required

public readonly envManager: IPythonEnv;

Type: IPythonEnv

API for managing the Python runtime environment.

`moduleName`^Required

public readonly moduleName: string;

Type: string

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

`sampleTestdir`^Required

public readonly sampleTestdir: string;

Type: string
Default: "tests"

Directory where sample tests are located.

`version`^Required

public readonly version: string;

Type: string

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

`packagingManager`^Optional

public readonly packagingManager: IPythonPackaging;

Type: IPythonPackaging

API for managing packaging the project as a library.

Only applies when the projectType is LIB.

`pytest`^Optional

public readonly pytest: Pytest;

Type: Pytest

Pytest component.

Constants

Name	Type	Description
`DEFAULT_TASK`	`string`	The name of the default task (the task executed when `projen` is run without arguments).

`DEFAULT_TASK`^Required

public readonly DEFAULT_TASK: string;

Type: string

The name of the default task (the task executed when projen is run without arguments).

Normally this task should synthesize the project files.

PythonSample

Python code sample.

Initializers

import { python } from 'projen'

new python.PythonSample(project: Project, options: PythonSampleOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`PythonSampleOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Required

Type: PythonSampleOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.PythonSample.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.PythonSample.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

RequirementsFile

Specifies a list of packages to be installed using pip.

https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format

Initializers

import { python } from 'projen'

new python.RequirementsFile(project: Project, filePath: string, options: RequirementsFileOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`filePath`	`string`	No description.
`options`	`RequirementsFileOptions`	No description.

`project`^Required

Type: projen.Project

`filePath`^Required

Type: string

`options`^Required

Type: RequirementsFileOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Writes the file to the project's output directory.
`diff`	Returns a unified diff of the old and new file contents with context lines and hunk headers.
`addPackages`	Adds the specified packages provided in semver format.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`diff`

public diff(colorize?: boolean, contextLines?: number): string[]

Returns a unified diff of the old and new file contents with context lines and hunk headers.

Only available after synthesis.

This is an expensive operation and should only be used on non time-critical code paths, like debug output.

`colorize`^Optional

Type: boolean

Whether to colorize the diff output.

`contextLines`^Optional

Type: number

Number of context lines around changes.

`addPackages`

public addPackages(packages: ...string[]): void

Adds the specified packages provided in semver format.

Comment lines (start with #) are ignored.

`packages`^Required

Type: ...string[]

Package version in format <module>@<semver>.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.RequirementsFile.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.RequirementsFile.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`committed`	`boolean`	Indicates if the file will be committed.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`committed`^Required

public readonly committed: boolean;

Type: boolean

Indicates if the file will be committed.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

SetupPy

Python packaging script where package metadata can be placed.

Initializers

import { python } from 'projen'

new python.SetupPy(project: Project, options: SetupPyOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`SetupPyOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Required

Type: SetupPyOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Writes the file to the project's output directory.
`diff`	Returns a unified diff of the old and new file contents with context lines and hunk headers.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Writes the file to the project's output directory.

`diff`

public diff(colorize?: boolean, contextLines?: number): string[]

Returns a unified diff of the old and new file contents with context lines and hunk headers.

Only available after synthesis.

This is an expensive operation and should only be used on non time-critical code paths, like debug output.

`colorize`^Optional

Type: boolean

Whether to colorize the diff output.

`contextLines`^Optional

Type: number

Number of context lines around changes.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.SetupPy.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.SetupPy.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`absolutePath`	`string`	The absolute path of this file.
`committed`	`boolean`	Indicates if the file will be committed.
`path`	`string`	The file path, relative to the project's outdir.
`changed`	`boolean`	Indicates if the file has been changed during synthesis.
`marker`	`string`	The projen marker, used to identify files as projen-generated.
`executable`	`boolean`	Indicates if the file should be marked as executable.
`readonly`	`boolean`	Indicates if the file should be read-only or read-write.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`absolutePath`^Required

public readonly absolutePath: string;

Type: string

The absolute path of this file.

`committed`^Required

public readonly committed: boolean;

Type: boolean

Indicates if the file will be committed.

`path`^Required

public readonly path: string;

Type: string

The file path, relative to the project's outdir.

`changed`^Optional

public readonly changed: boolean;

Type: boolean

Indicates if the file has been changed during synthesis.

This property is only available in postSynthesize() hooks. If this is undefined, the file has not been synthesized yet.

`marker`^Optional

public readonly marker: string;

Type: string

The projen marker, used to identify files as projen-generated.

Value is undefined if the project is being ejected.

`executable`^Required

public readonly executable: boolean;

Type: boolean

Indicates if the file should be marked as executable.

`readonly`^Required

public readonly readonly: boolean;

Type: boolean

Indicates if the file should be read-only or read-write.

Setuptools

Implements: IPythonPackaging

Manages packaging through setuptools with a setup.py script.

Initializers

import { python } from 'projen'

new python.Setuptools(project: Project, options: SetuptoolsOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`SetuptoolsOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Required

Type: SetuptoolsOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.Setuptools.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.Setuptools.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`publishTask`	`projen.Task`	A task that uploads the package to a package repository.
`publishTestTask`	`projen.Task`	A task that uploads the package to the Test PyPI repository.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`publishTask`^Required

public readonly publishTask: Task;

Type: projen.Task

A task that uploads the package to a package repository.

`publishTestTask`^Required

public readonly publishTestTask: Task;

Type: projen.Task

A task that uploads the package to the Test PyPI repository.

Uv

Implements: IPythonDeps, IPythonEnv, IPythonPackaging

Manage project dependencies, virtual environments, and packaging through uv.

Initializers

import { python } from 'projen'

new python.Uv(scope: IConstruct, options: UvOptions)

Name	Type	Description
`scope`	`constructs.IConstruct`	No description.
`options`	`UvOptions`	No description.

`scope`^Required

Type: constructs.IConstruct

`options`^Required

Type: UvOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.
`addDependency`	Adds a runtime dependency.
`addDevDependency`	Adds a dev dependency.
`installDependencies`	Installs dependencies (called during post-synthesis).
`setupEnvironment`	Initializes the virtual environment if it doesn't exist (called during post-synthesis).

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`addDependency`

public addDependency(spec: string): void

Adds a runtime dependency.

`spec`^Required

Type: string

`addDevDependency`

public addDevDependency(spec: string): void

Adds a dev dependency.

`spec`^Required

Type: string

`installDependencies`

public installDependencies(): void

Installs dependencies (called during post-synthesis).

`setupEnvironment`

public setupEnvironment(): void

Initializes the virtual environment if it doesn't exist (called during post-synthesis).

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.Uv.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.Uv.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.
`file`	`PyprojectTomlFile`	The `pyproject.toml` file.
`installCiTask`	`projen.Task`	A task that installs and updates dependencies.
`installTask`	`projen.Task`	No description.
`publishTask`	`projen.Task`	A task that uploads the package to a package repository.
`publishTestTask`	`projen.Task`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

`file`^Required

public readonly file: PyprojectTomlFile;

Type: PyprojectTomlFile

The pyproject.toml file.

`installCiTask`^Required

public readonly installCiTask: Task;

Type: projen.Task

A task that installs and updates dependencies.

`installTask`^Required

public readonly installTask: Task;

Type: projen.Task

`publishTask`^Required

public readonly publishTask: Task;

Type: projen.Task

A task that uploads the package to a package repository.

`publishTestTask`^Required

public readonly publishTestTask: Task;

Type: projen.Task

Venv

Implements: IPythonEnv

Manages a virtual environment through the Python venv module.

Initializers

import { python } from 'projen'

new python.Venv(project: Project, options?: VenvOptions)

Name	Type	Description
`project`	`projen.Project`	No description.
`options`	`VenvOptions`	No description.

`project`^Required

Type: projen.Project

`options`^Optional

Type: VenvOptions

Methods

Name	Description
`toString`	Returns a string representation of this construct.
`with`	Applies one or more mixins to this construct.
`postProjectCreation`	Called once, right after `postSynthesize()`, only when the project is created for the first time.
`postSynthesize`	Called after synthesis.
`preSynthesize`	Called before synthesis.
`projectCreation`	Called once, right after `synthesize()`, only when the project is created for the first time.
`synthesize`	Synthesizes files to the project output directory.
`setupEnvironment`	Initializes the virtual environment if it doesn't exist (called during post-synthesis).

`toString`

public toString(): string

Returns a string representation of this construct.

`with`

public with(mixins: ...IMixin[]): IConstruct

Applies one or more mixins to this construct.

`mixins`^Required

Type: ...constructs.IMixin[]

The mixins to apply.

`postProjectCreation`

public postProjectCreation(initProject: InitProject): void

Called once, right after postSynthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`postSynthesize`

public postSynthesize(): void

Called after synthesis.

Order is not guaranteed.

`preSynthesize`

public preSynthesize(): void

Called before synthesis.

`projectCreation`

public projectCreation(initProject: InitProject): void

Called once, right after synthesize(), only when the project is created for the first time.

`initProject`^Required

Type: projen.InitProject

Details about how the project was created, e.g. its type and the original CLI args.

`synthesize`

public synthesize(): void

Synthesizes files to the project output directory.

`setupEnvironment`

public setupEnvironment(): void

Initializes the virtual environment if it doesn't exist (called during post-synthesis).

Static Functions

Name	Description
`isConstruct`	Checks if `x` is a construct.
`isComponent`	Test whether the given construct is a component.

`isConstruct`

import { python } from 'projen'

python.Venv.isConstruct(x: any)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

`x`^Required

Type: any

Any object.

`isComponent`

import { python } from 'projen'

python.Venv.isComponent(x: any)

Test whether the given construct is a component.

`x`^Required

Type: any

Properties

Name	Type	Description
`node`	`constructs.Node`	The tree node.
`project`	`projen.Project`	No description.

`node`^Required

public readonly node: Node;

Type: constructs.Node

The tree node.

`project`^Required

public readonly project: Project;

Type: projen.Project

Structs

BuildSystem

Declares any Python level dependencies that must be installed in order to run the project’s build system successfully.

Initializer

import { python } from 'projen'

const buildSystem: python.BuildSystem = { ... }

Properties

Name	Type	Description
`requires`	`string[]`	List of strings following the version specifier specification, representing dependencies required to execute the build system.
`backendPath`	`string[]`	list of directories to prepend to `sys.path` when loading the build backend, relative to project root.
`buildBackend`	`string`	String is formatted following the same `module:object` syntax as a `setuptools` entry point.

`requires`^Required

public readonly requires: string[];

Type: string[]

List of strings following the version specifier specification, representing dependencies required to execute the build system.

`backendPath`^Optional

public readonly backendPath: string[];

Type: string[]

list of directories to prepend to sys.path when loading the build backend, relative to project root.

`buildBackend`^Optional

public readonly buildBackend: string;

Type: string

String is formatted following the same module:object syntax as a setuptools entry point.

It’s also legal to leave out the :object part.

PipOptions

Options for pip.

Initializer

import { python } from 'projen'

const pipOptions: python.PipOptions = { ... }

PoetryOptions

Initializer

import { python } from 'projen'

const poetryOptions: python.PoetryOptions = { ... }

Properties

Name	Type	Description
`authorEmail`	`string`	Author's e-mail.
`authorName`	`string`	Author's name.
`version`	`string`	Version of the package.
`classifiers`	`string[]`	A list of PyPI trove classifiers that describe the project.
`description`	`string`	A short description of the package.
`homepage`	`string`	A URL to the website of the project.
`license`	`string`	License of this package as an SPDX identifier.
`packageName`	`string`	Package name.
`poetryOptions`	`PoetryPyprojectOptionsWithoutDeps`	Additional options to set for poetry if using poetry.
`setupConfig`	`{[ key: string ]: any}`	Additional fields to pass in the setup() function if using setuptools.
`uvOptions`	`UvOptions`	Additional options to set for uv if using uv.
`pythonExec`	`string`	Path to the python executable to use.

`authorEmail`^Required

public readonly authorEmail: string;

Type: string
Default: $GIT_USER_EMAIL

Author's e-mail.

`authorName`^Required

public readonly authorName: string;

Type: string
Default: $GIT_USER_NAME

Author's name.

`version`^Required

public readonly version: string;

Type: string
Default: "0.1.0"

Version of the package.

`classifiers`^Optional

public readonly classifiers: string[];

Type: string[]

A list of PyPI trove classifiers that describe the project.

https://pypi.org/classifiers/

`description`^Optional

public readonly description: string;

Type: string

A short description of the package.

`homepage`^Optional

public readonly homepage: string;

Type: string

A URL to the website of the project.

`license`^Optional

public readonly license: string;

Type: string

License of this package as an SPDX identifier.

`packageName`^Optional

public readonly packageName: string;

Type: string

Package name.

`poetryOptions`^Optional

public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps;

Type: PoetryPyprojectOptionsWithoutDeps

Additional options to set for poetry if using poetry.

`setupConfig`^Optional

public readonly setupConfig: {[ key: string ]: any};

Type: {[ key: string ]: any}

Additional fields to pass in the setup() function if using setuptools.

`uvOptions`^Optional

public readonly uvOptions: UvOptions;

Type: UvOptions

Additional options to set for uv if using uv.

`pythonExec`^Optional

public readonly pythonExec: string;

Type: string
Default: "python"

Path to the python executable to use.

PoetryPyprojectOptions

Poetry-specific options.

https://python-poetry.org/docs/pyproject/

Initializer

import { python } from 'projen'

const poetryPyprojectOptions: python.PoetryPyprojectOptions = { ... }

Properties

Name	Type	Description
`authors`	`string[]`	The authors of the package.
`classifiers`	`string[]`	A list of PyPI trove classifiers that describe the project.
`description`	`string`	A short description of the package (required).
`documentation`	`string`	A URL to the documentation of the project.
`exclude`	`string[]`	A list of patterns that will be excluded in the final package.
`extras`	`{[ key: string ]: string[]}`	Package extras.
`homepage`	`string`	A URL to the website of the project.
`include`	`string[]`	A list of patterns that will be included in the final package.
`keywords`	`string[]`	A list of keywords (max: 5) that the package is related to.
`license`	`string`	License of this package as an SPDX identifier.
`maintainers`	`string[]`	the maintainers of the package.
`name`	`string`	Name of the package (required).
`packageMode`	`boolean`	Package mode (optional).
`packages`	`any[]`	A list of packages and modules to include in the final distribution.
`plugins`	`any`	Plugins.
`readme`	`string`	The name of the readme file of the package.
`repository`	`string`	A URL to the repository of the project.
`scripts`	`{[ key: string ]: any}`	The scripts or executables that will be installed when installing the package.
`source`	`any[]`	Source registries from which packages are retrieved.
`urls`	`{[ key: string ]: string}`	Project custom URLs, in addition to homepage, repository and documentation.
`version`	`string`	Version of the package (required).
`dependencies`	`{[ key: string ]: any}`	A list of dependencies for the project.
`devDependencies`	`{[ key: string ]: any}`	A list of development dependencies for the project.

`authors`^Optional

public readonly authors: string[];

Type: string[]

The authors of the package.

Must be in the form "name "

`classifiers`^Optional

public readonly classifiers: string[];

Type: string[]

A list of PyPI trove classifiers that describe the project.

https://pypi.org/classifiers/

`description`^Optional

public readonly description: string;

Type: string

A short description of the package (required).

`documentation`^Optional

public readonly documentation: string;

Type: string

A URL to the documentation of the project.

`exclude`^Optional

public readonly exclude: string[];

Type: string[]

A list of patterns that will be excluded in the final package.

If a VCS is being used for a package, the exclude field will be seeded with the VCS’ ignore settings (.gitignore for git for example).

`extras`^Optional

public readonly extras: {[ key: string ]: string[]};

Type: {[ key: string ]: string[]}

Package extras.

`homepage`^Optional

public readonly homepage: string;

Type: string

A URL to the website of the project.

`include`^Optional

public readonly include: string[];

Type: string[]

A list of patterns that will be included in the final package.

`keywords`^Optional

public readonly keywords: string[];

Type: string[]

A list of keywords (max: 5) that the package is related to.

`license`^Optional

public readonly license: string;

Type: string

License of this package as an SPDX identifier.

If the project is proprietary and does not use a specific license, you can set this value as "Proprietary".

`maintainers`^Optional

public readonly maintainers: string[];

Type: string[]

the maintainers of the package.

Must be in the form "name "

`name`^Optional

public readonly name: string;

Type: string

Name of the package (required).

`packageMode`^Optional

public readonly packageMode: boolean;

Type: boolean
Default: true

Package mode (optional).

https://python-poetry.org/docs/pyproject/#package-mode

Example

false

`packages`^Optional

public readonly packages: any[];

Type: any[]

A list of packages and modules to include in the final distribution.

`plugins`^Optional

public readonly plugins: any;

Type: any

Plugins.

Must be specified as a table.

https://toml.io/en/v1.0.0#table

`readme`^Optional

public readonly readme: string;

Type: string

The name of the readme file of the package.

`repository`^Optional

public readonly repository: string;

Type: string

A URL to the repository of the project.

`scripts`^Optional

public readonly scripts: {[ key: string ]: any};

Type: {[ key: string ]: any}

The scripts or executables that will be installed when installing the package.

`source`^Optional

public readonly source: any[];

Type: any[]

Source registries from which packages are retrieved.

`urls`^Optional

public readonly urls: {[ key: string ]: string};

Type: {[ key: string ]: string}

Project custom URLs, in addition to homepage, repository and documentation.

E.g. "Bug Tracker"

`version`^Optional

public readonly version: string;

Type: string

Version of the package (required).

`dependencies`^Optional

public readonly dependencies: {[ key: string ]: any};

Type: {[ key: string ]: any}

A list of dependencies for the project.

The python version for which your package is compatible is also required.

Example

{ requests: "^2.13.0" }

`devDependencies`^Optional

public readonly devDependencies: {[ key: string ]: any};

Type: {[ key: string ]: any}

A list of development dependencies for the project.

Example

{ requests: "^2.13.0" }

PoetryPyprojectOptionsWithoutDeps

Poetry-specific options.

https://python-poetry.org/docs/pyproject/

Initializer

import { python } from 'projen'

const poetryPyprojectOptionsWithoutDeps: python.PoetryPyprojectOptionsWithoutDeps = { ... }

Properties

Name	Type	Description
`authors`	`string[]`	The authors of the package.
`classifiers`	`string[]`	A list of PyPI trove classifiers that describe the project.
`description`	`string`	A short description of the package (required).
`documentation`	`string`	A URL to the documentation of the project.
`exclude`	`string[]`	A list of patterns that will be excluded in the final package.
`extras`	`{[ key: string ]: string[]}`	Package extras.
`homepage`	`string`	A URL to the website of the project.
`include`	`string[]`	A list of patterns that will be included in the final package.
`keywords`	`string[]`	A list of keywords (max: 5) that the package is related to.
`license`	`string`	License of this package as an SPDX identifier.
`maintainers`	`string[]`	the maintainers of the package.
`name`	`string`	Name of the package (required).
`packageMode`	`boolean`	Package mode (optional).
`packages`	`any[]`	A list of packages and modules to include in the final distribution.
`plugins`	`any`	Plugins.
`readme`	`string`	The name of the readme file of the package.
`repository`	`string`	A URL to the repository of the project.
`scripts`	`{[ key: string ]: any}`	The scripts or executables that will be installed when installing the package.
`source`	`any[]`	Source registries from which packages are retrieved.
`urls`	`{[ key: string ]: string}`	Project custom URLs, in addition to homepage, repository and documentation.
`version`	`string`	Version of the package (required).

`authors`^Optional

public readonly authors: string[];

Type: string[]

The authors of the package.

Must be in the form "name "

`classifiers`^Optional

public readonly classifiers: string[];

Type: string[]

A list of PyPI trove classifiers that describe the project.

https://pypi.org/classifiers/

`description`^Optional

public readonly description: string;

Type: string

A short description of the package (required).

`documentation`^Optional

public readonly documentation: string;

Type: string

A URL to the documentation of the project.

`exclude`^Optional

public readonly exclude: string[];

Type: string[]

A list of patterns that will be excluded in the final package.

If a VCS is being used for a package, the exclude field will be seeded with the VCS’ ignore settings (.gitignore for git for example).

`extras`^Optional

public readonly extras: {[ key: string ]: string[]};

Type: {[ key: string ]: string[]}

Package extras.

`homepage`^Optional

public readonly homepage: string;

Type: string

A URL to the website of the project.

`include`^Optional

public readonly include: string[];

Type: string[]

A list of patterns that will be included in the final package.

`keywords`^Optional

public readonly keywords: string[];

Type: string[]

A list of keywords (max: 5) that the package is related to.

`license`^Optional

public readonly license: string;

Type: string

License of this package as an SPDX identifier.

If the project is proprietary and does not use a specific license, you can set this value as "Proprietary".

`maintainers`^Optional

public readonly maintainers: string[];

Type: string[]

the maintainers of the package.

Must be in the form "name "

`name`^Optional

public readonly name: string;

Type: string

Name of the package (required).

`packageMode`^Optional

public readonly packageMode: boolean;

Type: boolean
Default: true

Package mode (optional).

https://python-poetry.org/docs/pyproject/#package-mode

Example

false

`packages`^Optional

public readonly packages: any[];

Type: any[]

A list of packages and modules to include in the final distribution.

`plugins`^Optional

public readonly plugins: any;

Type: any

Plugins.

Must be specified as a table.

https://toml.io/en/v1.0.0#table

`readme`^Optional

public readonly readme: string;

Type: string

The name of the readme file of the package.

`repository`^Optional

public readonly repository: string;

Type: string

A URL to the repository of the project.

`scripts`^Optional

public readonly scripts: {[ key: string ]: any};

Type: {[ key: string ]: any}

The scripts or executables that will be installed when installing the package.

`source`^Optional

public readonly source: any[];

Type: any[]

Source registries from which packages are retrieved.

`urls`^Optional

public readonly urls: {[ key: string ]: string};

Type: {[ key: string ]: string}

Project custom URLs, in addition to homepage, repository and documentation.

E.g. "Bug Tracker"

`version`^Optional

public readonly version: string;

Type: string

Version of the package (required).

ProjectAuthor

Initializer

import { python } from 'projen'

const projectAuthor: python.ProjectAuthor = { ... }

Properties

Name	Type	Description
`email`	`string`	No description.
`name`	`string`	No description.

`email`^Optional

public readonly email: string;

Type: string

`name`^Optional

public readonly name: string;

Type: string

ProjenrcOptions

Options for Projenrc.

Initializer

import { python } from 'projen'

const projenrcOptions: python.ProjenrcOptions = { ... }

Properties

Name	Type	Description
`filename`	`string`	The name of the projenrc file.
`projenVersion`	`string`	The projen version to use.
`pythonExec`	`string`	Path to the python executable to use.

`filename`^Optional

public readonly filename: string;

Type: string
Default: ".projenrc.py"

The name of the projenrc file.

`projenVersion`^Optional

public readonly projenVersion: string;

Type: string
Default: current version

The projen version to use.

`pythonExec`^Optional

public readonly pythonExec: string;

Type: string
Default: "python"

Path to the python executable to use.

PyprojectToml

Initializer

import { python } from 'projen'

const pyprojectToml: python.PyprojectToml = { ... }

Properties

Name	Type	Description
`buildSystem`	`BuildSystem`	No description.
`dependencyGroups`	`PyprojectTomlDependencyGroups`	Named groups of dependencies, similar to `requirements.txt` files, which launchers, IDEs, and other tools can find and identify by name. Each item in `[dependency-groups]` is defined as mapping of group name to list of dependency specifiers.
`project`	`PyprojectTomlProject`	There are three kinds of metadata: static, dynamic, and partially dynamic.
`tool`	`PyprojectTomlTool`	Every tool that is used by the project can have users specify configuration data as long as they use a sub-table within `[tool]`.

`buildSystem`^Optional

public readonly buildSystem: BuildSystem;

Type: BuildSystem

`dependencyGroups`^Optional

public readonly dependencyGroups: PyprojectTomlDependencyGroups;

Type: PyprojectTomlDependencyGroups

Named groups of dependencies, similar to requirements.txt files, which launchers, IDEs, and other tools can find and identify by name. Each item in [dependency-groups] is defined as mapping of group name to list of dependency specifiers.

`project`^Optional

public readonly project: PyprojectTomlProject;

Type: PyprojectTomlProject

There are three kinds of metadata: static, dynamic, and partially dynamic.

Static metadata is listed in the [project] table directly and cannot be specified or changed by a tool.

Dynamic metadata key names are listed inside the dynamic key and represents metadata that a tool will later provide.
Partially dynamic metadata is specified in the [project] table as a list or table, and also listed in dynamic, allowing the build backend to add entries but not modify or remove existing ones.

`tool`^Optional

public readonly tool: PyprojectTomlTool;

Type: PyprojectTomlTool

Every tool that is used by the project can have users specify configuration data as long as they use a sub-table within [tool].

Generally a project can use the subtable tool.$NAME if, and only if, they own the entry for $NAME in the Cheeseshop/PyPI.

PyprojectTomlDependencyGroups

Initializer

import { python } from 'projen'

const pyprojectTomlDependencyGroups: python.PyprojectTomlDependencyGroups = { ... }

Properties

Name	Type	Description
`dev`	`any[]`	No description.

`dev`^Optional

public readonly dev: any[];

Type: any[]

PyprojectTomlProject

There are three kinds of metadata: static, dynamic, and partially dynamic.

Static metadata is listed in the [project] table directly and cannot be specified or changed by a tool.

Dynamic metadata key names are listed inside the dynamic key and represents metadata that a tool will later provide.
Partially dynamic metadata is specified in the [project] table as a list or table, and also listed in dynamic, allowing the build backend to add entries but not modify or remove existing ones.

Initializer

import { python } from 'projen'

const pyprojectTomlProject: python.PyprojectTomlProject = { ... }

Properties

Name	Type	Description
`name`	`string`	Valid name consists only of ASCII letters and numbers, period, underscore and hyphen.
`authors`	`ProjectAuthor[]`	People or organizations considered as 'authors' of the project.
`classifiers`	`string[]`	List of Trove classifiers that describe the project. PyPI use the classifiers to categorize projects.
`dependencies`	`string[]`	An array of dependency specifier strings, each representing a mandatory dependent package of the project.
`description`	`string`	Summary description of the project in one line.
`dynamic`	`PyprojectTomlProjectDynamic[]`	Specifies which keys are intentionally unspecified under `[project]` table so build backend can/will provide such metadata dynamically.
`entryPoints`	`any`	Extra entry point groups that allow applications to load plugins. For example, Pygments (a syntax highlighting tool) can use additional styles from separately installed packages through `[project.entry-points."pygments.styles"]`. Each key is the name of the entry-point group, and each value is a table of entry points.
`guiScripts`	`{[ key: string ]: string}`	Table of entry points that allows package installers to create a GUI wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either `importable.module` or `importable.module:object.attr`. Windows platform treats `gui_scripts` specially in that they are wrapped in a GUI executable, so they can be started without a console, but cannot use standard streams unless application code redirects them.
`importNames`	`string[]`	An array of strings specifying the import names that the project exclusively provides when installed.
`importNamespaces`	`string[]`	An array of strings specifying the import names that the project provides when installed, but not exclusively.
`keywords`	`string[]`	List of keywords or tags that describe the project.
`license`	`any`	A string containing a valid SPDX license expression (recommended), or a table with either: - `file` key specifying a relative path to a license file (deprecated per PEP 639), or - `text` key containing full license content (deprecated per PEP 639).
`licenseFiles`	`string[]`	Relative paths or globs to paths of license files.
`maintainers`	`ProjectAuthor[]`	People or organizations considered as 'maintainers' of the project.
`optionalDependencies`	`any`	Each entry is a key/value pair, with the key specifying extra feature name (such as `socks` in `requests[socks]`), and value is an array of dependency specifier strings.
`readme`	`any`	Value can be a relative path to text / markdown (`.md` suffix) / reStructuredText (`.rst` suffix) readme file, or a table with either: - `file` key containing path of aforementioned readme file, or - `text` key containing the full readme text embedded inside `pyproject.toml`.
`requiresPython`	`string`	Specifies the Python version(s) that the distribution is compatible with.
`scripts`	`{[ key: string ]: string}`	Table of entry points that allows package installers to create a command-line wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either `importable.module` or `importable.module:object.attr`. Windows platform treats `console_scripts` specially in that they are wrapped in a console executable, so they are attached to a console and can use `sys.stdin`, `sys.stdout` and `sys.stderr` for I/O.
`urls`	`{[ key: string ]: string}`	Table consisting one or multiple `label: URL` pairs.
`version`	`string`	Version of the project, as defined in the Version specifier specification, and preferably already normalized.

`name`^Required

public readonly name: string;

Type: string

Valid name consists only of ASCII letters and numbers, period, underscore and hyphen.

It must start and end with a letter or number.

`authors`^Optional

public readonly authors: ProjectAuthor[];

Type: ProjectAuthor[]

People or organizations considered as 'authors' of the project.

Each author is a table with name key, email key, or both.

`classifiers`^Optional

public readonly classifiers: string[];

Type: string[]

List of Trove classifiers that describe the project. PyPI use the classifiers to categorize projects.

`dependencies`^Optional

public readonly dependencies: string[];

Type: string[]

An array of dependency specifier strings, each representing a mandatory dependent package of the project.

`description`^Optional

public readonly description: string;

Type: string

Summary description of the project in one line.

Tools may not accept multiple lines.

`dynamic`^Optional

public readonly dynamic: PyprojectTomlProjectDynamic[];

Type: PyprojectTomlProjectDynamic[]

Specifies which keys are intentionally unspecified under [project] table so build backend can/will provide such metadata dynamically.

Each key must be listed only once. It is an error to both list a key in dynamic and use the key directly in [project] unless the key is a list or table with arbitrary entries (PEP 808), in which case the build backend may extend it. One of the most common usage is version, which allows build backend to retrieve project version from source code or version control system instead of hardcoding it in pyproject.toml.

`entryPoints`^Optional

public readonly entryPoints: any;

Type: any

Extra entry point groups that allow applications to load plugins. For example, Pygments (a syntax highlighting tool) can use additional styles from separately installed packages through [project.entry-points."pygments.styles"]. Each key is the name of the entry-point group, and each value is a table of entry points.

`guiScripts`^Optional

public readonly guiScripts: {[ key: string ]: string};

Type: {[ key: string ]: string}

Table of entry points that allows package installers to create a GUI wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either importable.module or importable.module:object.attr. Windows platform treats gui_scripts specially in that they are wrapped in a GUI executable, so they can be started without a console, but cannot use standard streams unless application code redirects them.

`importNames`^Optional

public readonly importNames: string[];

Type: string[]

An array of strings specifying the import names that the project exclusively provides when installed.

`importNamespaces`^Optional

public readonly importNamespaces: string[];

Type: string[]

An array of strings specifying the import names that the project provides when installed, but not exclusively.

`keywords`^Optional

public readonly keywords: string[];

Type: string[]

List of keywords or tags that describe the project.

They could be used by search engines to categorize the project.

`license`^Optional

public readonly license: any;

Type: any

A string containing a valid SPDX license expression (recommended), or a table with either: - file key specifying a relative path to a license file (deprecated per PEP 639), or - text key containing full license content (deprecated per PEP 639).

`licenseFiles`^Optional

public readonly licenseFiles: string[];

Type: string[]

Relative paths or globs to paths of license files.

Can be an empty list.

`maintainers`^Optional

public readonly maintainers: ProjectAuthor[];

Type: ProjectAuthor[]

People or organizations considered as 'maintainers' of the project.

Each maintainer is a table with name key, email key, or both.

`optionalDependencies`^Optional

public readonly optionalDependencies: any;

Type: any

Each entry is a key/value pair, with the key specifying extra feature name (such as socks in requests[socks]), and value is an array of dependency specifier strings.

`readme`^Optional

public readonly readme: any;

Type: any

Value can be a relative path to text / markdown (.md suffix) / reStructuredText (.rst suffix) readme file, or a table with either: - file key containing path of aforementioned readme file, or - text key containing the full readme text embedded inside pyproject.toml.

`requiresPython`^Optional

public readonly requiresPython: string;

Type: string

Specifies the Python version(s) that the distribution is compatible with.

Must be in the format specified in Version specifiers.

`scripts`^Optional

public readonly scripts: {[ key: string ]: string};

Type: {[ key: string ]: string}

Table of entry points that allows package installers to create a command-line wrapper for. Each key is the name of the script to be created, and each value is the function or object to all, in form of either importable.module or importable.module:object.attr. Windows platform treats console_scripts specially in that they are wrapped in a console executable, so they are attached to a console and can use sys.stdin, sys.stdout and sys.stderr for I/O.

`urls`^Optional

public readonly urls: {[ key: string ]: string};

Type: {[ key: string ]: string}

Table consisting one or multiple label: URL pairs.

Common indexes like PyPI uses well-known Project URLs when presenting project pages.

`version`^Optional

public readonly version: string;

Type: string

Version of the project, as defined in the Version specifier specification, and preferably already normalized.

PyprojectTomlTool

Every tool that is used by the project can have users specify configuration data as long as they use a sub-table within [tool].

Generally a project can use the subtable tool.$NAME if, and only if, they own the entry for $NAME in the Cheeseshop/PyPI.

Initializer

import { python } from 'projen'

const pyprojectTomlTool: python.PyprojectTomlTool = { ... }

Properties

Name	Type	Description
`black`	`any`	The uncompromising Python code formatter.
`cibuildwheel`	`any`	Build Python wheels for all platforms.
`dfc`	`any`	A CLI tool to check and validate Python docstring formatting and completeness.
`docstringFormatChecker`	`any`	A CLI tool to check and validate Python docstring formatting and completeness.
`fastapi`	`any`	FastAPI web framework configuration.
`hatch`	`any`	Modern, extensible Python project management.
`maturin`	`any`	Build and publish crates with pyo3, cffi and uniffi bindings as well as rust binaries as python packages.
`mypy`	`any`	Optional static typing for Python.
`pdm`	`any`	A modern Python package manager with PEP 621 support.
`pixi`	`any`	A package manager and task runner.
`poe`	`any`	A task runner that works well with `pyproject.toml` files.
`poetry`	`any`	Python dependency management and packaging made easy.
`pyright`	`any`	Static type checker for Python.
`pytest`	`any`	Standardized automated testing of Python packages.
`quikrun`	`any`	A CLI tool to run code files instantly without typing complex commands in terminal.
`repoReview`	`any`	Review a repository for best practices.
`ruff`	`any`	An extremely fast Python linter and formatter, written in Rust.
`scheduled`	`any`	Scheduled jobs in Python's `pyproject.toml`.
`scikitBuild`	`any`	Improved build system generator for Python C/C++/Fortran extensions.
`setuptools`	`any`	Easily download, build, install, upgrade, and uninstall Python packages.
`setuptoolsScm`	`any`	Manage Python package versions using SCM (e.g. Git).
`taskipy`	`any`	The complementary task runner for python.
`tombi`	`any`	Tombi is a toolkit for TOML;
`tox`	`any`	Standardized automated testing of Python packages.
`ty`	`any`	An extremely fast Python type checker, written in Rust.
`uv`	`any`	An extremely fast Python package installer and resolver, written in Rust.

`black`^Optional

public readonly black: any;

Type: any

The uncompromising Python code formatter.

`cibuildwheel`^Optional

public readonly cibuildwheel: any;

Type: any

Build Python wheels for all platforms.

`dfc`^Optional

public readonly dfc: any;

Type: any

A CLI tool to check and validate Python docstring formatting and completeness.

`docstringFormatChecker`^Optional

public readonly docstringFormatChecker: any;

Type: any

A CLI tool to check and validate Python docstring formatting and completeness.

`fastapi`^Optional

public readonly fastapi: any;

Type: any

FastAPI web framework configuration.

`hatch`^Optional

public readonly hatch: any;

Type: any

Modern, extensible Python project management.

`maturin`^Optional

public readonly maturin: any;

Type: any

Build and publish crates with pyo3, cffi and uniffi bindings as well as rust binaries as python packages.

`mypy`^Optional

public readonly mypy: any;

Type: any

Optional static typing for Python.

`pdm`^Optional

public readonly pdm: any;

Type: any

A modern Python package manager with PEP 621 support.

`pixi`^Optional

public readonly pixi: any;

Type: any

A package manager and task runner.

`poe`^Optional

public readonly poe: any;

Type: any

A task runner that works well with pyproject.toml files.

`poetry`^Optional

public readonly poetry: any;

Type: any

Python dependency management and packaging made easy.

`pyright`^Optional

public readonly pyright: any;

Type: any

Static type checker for Python.

`pytest`^Optional

public readonly pytest: any;

Type: any

Standardized automated testing of Python packages.

`quikrun`^Optional

public readonly quikrun: any;

Type: any

A CLI tool to run code files instantly without typing complex commands in terminal.

`repoReview`^Optional

public readonly repoReview: any;

Type: any

Review a repository for best practices.

`ruff`^Optional

public readonly ruff: any;

Type: any

An extremely fast Python linter and formatter, written in Rust.

`scheduled`^Optional

public readonly scheduled: any;

Type: any

Scheduled jobs in Python's pyproject.toml.

This is a specification for declaring recurring scheduled jobs in Python projects, in pyproject.toml.

It defines how jobs are declared and how providers would run them.

It does not provide a specific implementation for running scheduled jobs, because that is provider specific.

For example, a file at app/jobs.py could define:

def clean_files():
print("Running cleanup...")

You could define a scheduled job to run that function once per day with:

[tool.scheduled.clean-files]
every = "day"
entrypoint = "app.jobs:clean_files"

`scikitBuild`^Optional

public readonly scikitBuild: any;

Type: any

Improved build system generator for Python C/C++/Fortran extensions.

`setuptools`^Optional

public readonly setuptools: any;

Type: any

Easily download, build, install, upgrade, and uninstall Python packages.

`setuptoolsScm`^Optional

public readonly setuptoolsScm: any;

Type: any

Manage Python package versions using SCM (e.g. Git).

`taskipy`^Optional

public readonly taskipy: any;

Type: any

The complementary task runner for python.

`tombi`^Optional

public readonly tombi: any;

Type: any

Tombi is a toolkit for TOML;

providing a formatter/linter and language server

`tox`^Optional

public readonly tox: any;

Type: any

Standardized automated testing of Python packages.

`ty`^Optional

public readonly ty: any;

Type: any

An extremely fast Python type checker, written in Rust.

`uv`^Optional

public readonly uv: any;

Type: any

An extremely fast Python package installer and resolver, written in Rust.

PytestOptions

Initializer

import { python } from 'projen'

const pytestOptions: python.PytestOptions = { ... }

Properties

Name	Type	Description
`maxFailures`	`number`	Stop the testing process after the first N failures.
`testMatch`	`string[]`	List of paths to test files or directories.
`version`	`string`	Pytest version.

`maxFailures`^Optional

public readonly maxFailures: number;

Type: number

Stop the testing process after the first N failures.

`testMatch`^Optional

public readonly testMatch: string[];

Type: string[]
Default: []

List of paths to test files or directories.

Useful when all project tests are in a known location to speed up test collection and to avoid picking up undesired tests by accident.

Leave empty to discover all test_*.py or *_test.py files, per Pytest default. Glob patterns are supported, including ** for recursive matching.

The entries form pytest's testpaths setting, which is parsed like a shell word list, so a path containing spaces has to be quoted: ["'my tests'"].

Example

["tests/unit", "tests/qa"]

`version`^Optional

public readonly version: string;

Type: string
Default: "8.3.5"

Pytest version.

PytestSampleOptions

Options for python test code sample.

Initializer

import { python } from 'projen'

const pytestSampleOptions: python.PytestSampleOptions = { ... }

Properties

Name	Type	Description
`moduleName`	`string`	Name of the python package as used in imports and filenames.
`testdir`	`string`	Test directory.

`moduleName`^Required

public readonly moduleName: string;

Type: string

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

`testdir`^Required

public readonly testdir: string;

Type: string

Test directory.

PythonExecutableOptions

Initializer

import { python } from 'projen'

const pythonExecutableOptions: python.PythonExecutableOptions = { ... }

Properties

Name	Type	Description
`pythonExec`	`string`	Path to the python executable to use.

`pythonExec`^Optional

public readonly pythonExec: string;

Type: string
Default: "python"

Path to the python executable to use.

PythonPackagingOptions

Initializer

import { python } from 'projen'

const pythonPackagingOptions: python.PythonPackagingOptions = { ... }

Properties

Name	Type	Description
`authorEmail`	`string`	Author's e-mail.
`authorName`	`string`	Author's name.
`version`	`string`	Version of the package.
`classifiers`	`string[]`	A list of PyPI trove classifiers that describe the project.
`description`	`string`	A short description of the package.
`homepage`	`string`	A URL to the website of the project.
`license`	`string`	License of this package as an SPDX identifier.
`packageName`	`string`	Package name.
`poetryOptions`	`PoetryPyprojectOptionsWithoutDeps`	Additional options to set for poetry if using poetry.
`setupConfig`	`{[ key: string ]: any}`	Additional fields to pass in the setup() function if using setuptools.
`uvOptions`	`UvOptions`	Additional options to set for uv if using uv.

`authorEmail`^Required

public readonly authorEmail: string;

Type: string
Default: $GIT_USER_EMAIL

Author's e-mail.

`authorName`^Required

public readonly authorName: string;

Type: string
Default: $GIT_USER_NAME

Author's name.

`version`^Required

public readonly version: string;

Type: string
Default: "0.1.0"

Version of the package.

`classifiers`^Optional

public readonly classifiers: string[];

Type: string[]

A list of PyPI trove classifiers that describe the project.

https://pypi.org/classifiers/

`description`^Optional

public readonly description: string;

Type: string

A short description of the package.

`homepage`^Optional

public readonly homepage: string;

Type: string

A URL to the website of the project.

`license`^Optional

public readonly license: string;

Type: string

License of this package as an SPDX identifier.

`packageName`^Optional

public readonly packageName: string;

Type: string

Package name.

`poetryOptions`^Optional

public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps;

Type: PoetryPyprojectOptionsWithoutDeps

Additional options to set for poetry if using poetry.

`setupConfig`^Optional

public readonly setupConfig: {[ key: string ]: any};

Type: {[ key: string ]: any}

Additional fields to pass in the setup() function if using setuptools.

`uvOptions`^Optional

public readonly uvOptions: UvOptions;

Type: UvOptions

Additional options to set for uv if using uv.

PythonProjectOptions

Options for PythonProject.

Initializer

import { python } from 'projen'

const pythonProjectOptions: python.PythonProjectOptions = { ... }

Properties

Name	Type	Description
`name`	`string`	This is the name of your project.
`commitGenerated`	`boolean`	Whether to commit the managed files by default.
`gitIgnoreOptions`	`projen.IgnoreFileOptions`	Configuration options for .gitignore file.
`gitOptions`	`projen.GitOptions`	Configuration options for git.
`logging`	`projen.LoggerOptions`	Configure logging options such as verbosity.
`outdir`	`string`	The root directory of the project.
`parent`	`projen.Project`	The parent project, if this project is part of a bigger project.
`projectTree`	`boolean`	Generate a project tree file (`.projen/tree.json`) that shows all components and their relationships. Useful for understanding your project structure and debugging.
`projenCommand`	`string`	The shell command to use in order to run the projen CLI.
`projenrcJson`	`boolean`	Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation.
`projenrcJsonOptions`	`projen.ProjenrcJsonOptions`	Options for .projenrc.json.
`renovatebot`	`boolean`	Use renovatebot to handle dependency upgrades.
`renovatebotOptions`	`projen.RenovatebotOptions`	Options for renovatebot.
`autoApproveOptions`	`projen.github.AutoApproveOptions`	Enable and configure the 'auto approve' workflow.
`autoMerge`	`boolean`	Enable automatic merging on GitHub.
`autoMergeOptions`	`projen.github.AutoMergeOptions`	Configure options for automatic merging on GitHub.
`clobber`	`boolean`	Add a `clobber` task which resets the repo to origin.
`devContainer`	`boolean`	Add a VSCode development environment (used for GitHub Codespaces).
`github`	`boolean`	Enable GitHub integration.
`githubOptions`	`projen.github.GitHubOptions`	Options for GitHub integration.
`gitpod`	`boolean`	Add a Gitpod development environment.
`projenCredentials`	`projen.github.GithubCredentials`	Choose a method of providing GitHub API access for projen workflows.
`readme`	`projen.SampleReadmeProps`	The README setup.
`stale`	`boolean`	Auto-close of stale issues and pull request.
`staleOptions`	`projen.github.StaleOptions`	Auto-close stale issues and pull requests.
`vscode`	`boolean`	Enable VSCode integration.
`authorEmail`	`string`	Author's e-mail.
`authorName`	`string`	Author's name.
`version`	`string`	Version of the package.
`classifiers`	`string[]`	A list of PyPI trove classifiers that describe the project.
`description`	`string`	A short description of the package.
`homepage`	`string`	A URL to the website of the project.
`license`	`string`	License of this package as an SPDX identifier.
`packageName`	`string`	Package name.
`poetryOptions`	`PoetryPyprojectOptionsWithoutDeps`	Additional options to set for poetry if using poetry.
`setupConfig`	`{[ key: string ]: any}`	Additional fields to pass in the setup() function if using setuptools.
`uvOptions`	`UvOptions`	Additional options to set for uv if using uv.
`pythonExec`	`string`	Path to the python executable to use.
`moduleName`	`string`	Name of the python package as used in imports and filenames.
`deps`	`string[]`	List of runtime dependencies for this project.
`devDeps`	`string[]`	List of dev dependencies for this project.
`pip`	`boolean`	Use pip with a requirements.txt file to track project dependencies.
`poetry`	`boolean`	Use poetry to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
`projenrcJs`	`boolean`	Use projenrc in javascript.
`projenrcJsOptions`	`projen.javascript.ProjenrcOptions`	Options related to projenrc in JavaScript.
`projenrcPython`	`boolean`	Use projenrc in Python.
`projenrcPythonOptions`	`ProjenrcOptions`	Options related to projenrc in python.
`projenrcTs`	`boolean`	Use projenrc in TypeScript.
`projenrcTsOptions`	`projen.typescript.ProjenrcTsOptions`	Options related to projenrc in TypeScript.
`pytest`	`boolean`	Include pytest tests.
`pytestOptions`	`PytestOptions`	pytest options.
`sample`	`boolean`	Include sample code and test if the relevant directories don't exist.
`sampleTestdir`	`string`	Location of sample tests.
`setuptools`	`boolean`	Use setuptools with a setup.py script for packaging and publishing.
`uv`	`boolean`	Use uv to manage your project dependencies, virtual environment, and (optional) packaging/publishing.
`venv`	`boolean`	Use venv to manage a virtual environment for installing dependencies inside.
`venvOptions`	`VenvOptions`	Venv options.

`name`^Required

public readonly name: string;

Type: string
Default: $BASEDIR

This is the name of your project.

`commitGenerated`^Optional

public readonly commitGenerated: boolean;

Type: boolean
Default: true

Whether to commit the managed files by default.

`gitIgnoreOptions`^Optional

public readonly gitIgnoreOptions: IgnoreFileOptions;

Type: projen.IgnoreFileOptions

Configuration options for .gitignore file.

`gitOptions`^Optional

public readonly gitOptions: GitOptions;

Type: projen.GitOptions

Configuration options for git.

`logging`^Optional

public readonly logging: LoggerOptions;

Type: projen.LoggerOptions
Default: {}

Configure logging options such as verbosity.

`outdir`^Optional

public readonly outdir: string;

Type: string
Default: "."

The root directory of the project.

Relative to this directory, all files are synthesized.

If this project has a parent, this directory is relative to the parent directory and it cannot be the same as the parent or any of it's other subprojects.

`parent`^Optional

public readonly parent: Project;

Type: projen.Project

The parent project, if this project is part of a bigger project.

`projectTree`^Optional

public readonly projectTree: boolean;

Type: boolean
Default: false

Generate a project tree file (.projen/tree.json) that shows all components and their relationships. Useful for understanding your project structure and debugging.

`projenCommand`^Optional

public readonly projenCommand: string;

Type: string
Default: "npx projen"

The shell command to use in order to run the projen CLI.

Inserted verbatim into task steps, workflows and IDE configuration, and run by each of their shells - locally, in CI and in dev containers. Keep it a plain unquoted command, since shell syntax in it executes in all of them.

Can be used to customize in special environments.

`projenrcJson`^Optional

public readonly projenrcJson: boolean;

Type: boolean
Default: false

Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation.

`projenrcJsonOptions`^Optional

public readonly projenrcJsonOptions: ProjenrcJsonOptions;

Type: projen.ProjenrcJsonOptions
Default: default options

Options for .projenrc.json.

`renovatebot`^Optional

public readonly renovatebot: boolean;

Type: boolean
Default: false

Use renovatebot to handle dependency upgrades.

`renovatebotOptions`^Optional

public readonly renovatebotOptions: RenovatebotOptions;

Type: projen.RenovatebotOptions
Default: default options

Options for renovatebot.

`autoApproveOptions`^Optional

public readonly autoApproveOptions: AutoApproveOptions;

Type: projen.github.AutoApproveOptions
Default: auto approve is disabled

Enable and configure the 'auto approve' workflow.

`autoMerge`^Optional

public readonly autoMerge: boolean;

Type: boolean
Default: true

Enable automatic merging on GitHub.

Has no effect if github.mergify is set to false.

`autoMergeOptions`^Optional

public readonly autoMergeOptions: AutoMergeOptions;

Type: projen.github.AutoMergeOptions
Default: see defaults in AutoMergeOptions

Configure options for automatic merging on GitHub.

Has no effect if github.mergify or autoMerge is set to false.

`clobber`^Optional

public readonly clobber: boolean;

Type: boolean
Default: true, but false for subprojects

Add a clobber task which resets the repo to origin.

`devContainer`^Optional

public readonly devContainer: boolean;

Type: boolean
Default: false

Add a VSCode development environment (used for GitHub Codespaces).

`github`^Optional

public readonly github: boolean;

Type: boolean
Default: true

Enable GitHub integration.

Enabled by default for root projects. Disabled for non-root projects.

`githubOptions`^Optional

public readonly githubOptions: GitHubOptions;

Type: projen.github.GitHubOptions
Default: see GitHubOptions

Options for GitHub integration.

`gitpod`^Optional

public readonly gitpod: boolean;

Type: boolean
Default: false

Add a Gitpod development environment.

`projenCredentials`^Optional

public readonly projenCredentials: GithubCredentials;

Type: projen.github.GithubCredentials
Default: use a personal access token named PROJEN_GITHUB_TOKEN

Choose a method of providing GitHub API access for projen workflows.

`readme`^Optional

public readonly readme: SampleReadmeProps;

Type: projen.SampleReadmeProps
Default: { filename: 'README.md', contents: '# replace this' }

The README setup.

Example

"{ filename: 'readme.md', contents: '# title' }"

`stale`^Optional

public readonly stale: boolean;

Type: boolean
Default: false

Auto-close of stale issues and pull request.

See staleOptions for options.

`staleOptions`^Optional

public readonly staleOptions: StaleOptions;

Type: projen.github.StaleOptions
Default: see defaults in StaleOptions

Auto-close stale issues and pull requests.

To disable set stale to false.

`vscode`^Optional

public readonly vscode: boolean;

Type: boolean
Default: true

Enable VSCode integration.

Enabled by default for root projects. Disabled for non-root projects.

`authorEmail`^Required

public readonly authorEmail: string;

Type: string
Default: $GIT_USER_EMAIL

Author's e-mail.

`authorName`^Required

public readonly authorName: string;

Type: string
Default: $GIT_USER_NAME

Author's name.

`version`^Required

public readonly version: string;

Type: string
Default: "0.1.0"

Version of the package.

`classifiers`^Optional

public readonly classifiers: string[];

Type: string[]

A list of PyPI trove classifiers that describe the project.

https://pypi.org/classifiers/

`description`^Optional

public readonly description: string;

Type: string

A short description of the package.

`homepage`^Optional

public readonly homepage: string;

Type: string

A URL to the website of the project.

`license`^Optional

public readonly license: string;

Type: string

License of this package as an SPDX identifier.

`packageName`^Optional

public readonly packageName: string;

Type: string

Package name.

`poetryOptions`^Optional

public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps;

Type: PoetryPyprojectOptionsWithoutDeps

Additional options to set for poetry if using poetry.

`setupConfig`^Optional

public readonly setupConfig: {[ key: string ]: any};

Type: {[ key: string ]: any}

Additional fields to pass in the setup() function if using setuptools.

`uvOptions`^Optional

public readonly uvOptions: UvOptions;

Type: UvOptions

Additional options to set for uv if using uv.

`pythonExec`^Optional

public readonly pythonExec: string;

Type: string
Default: "python"

Path to the python executable to use.

`moduleName`^Required

public readonly moduleName: string;

Type: string
Default: $PYTHON_MODULE_NAME

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

Must only consist of alphanumeric characters and underscores.

`deps`^Optional

public readonly deps: string[];

Type: string[]
Default: []

List of runtime dependencies for this project.

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

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

`devDeps`^Optional

public readonly devDeps: string[];

Type: string[]
Default: []

List of dev dependencies for this project.

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

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

`pip`^Optional

public readonly pip: boolean;

Type: boolean
Default: true, unless poetry is true, then false

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

`poetry`^Optional

public readonly poetry: boolean;

Type: boolean
Default: false

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

This feature is incompatible with pip, setuptools, or venv. If you set this option to true, then pip, setuptools, and venv must be set to false.

`projenrcJs`^Optional

public readonly projenrcJs: boolean;

Type: boolean
Default: false

Use projenrc in javascript.

This will install projen as a JavaScript dependency and add a synth task which will run .projenrc.js.

`projenrcJsOptions`^Optional

public readonly projenrcJsOptions: ProjenrcOptions;

Type: projen.javascript.ProjenrcOptions
Default: default options

Options related to projenrc in JavaScript.

`projenrcPython`^Optional

public readonly projenrcPython: boolean;

Type: boolean
Default: true

Use projenrc in Python.

This will install projen as a Python dependency and add a synth task which will run .projenrc.py.

`projenrcPythonOptions`^Optional

public readonly projenrcPythonOptions: ProjenrcOptions;

Type: ProjenrcOptions
Default: default options

Options related to projenrc in python.

`projenrcTs`^Optional

public readonly projenrcTs: boolean;

Type: boolean
Default: false

Use projenrc in TypeScript.

This will create a tsconfig file (default: tsconfig.projen.json) and use a typescript runner in the default task to parse the project source files.

`projenrcTsOptions`^Optional

public readonly projenrcTsOptions: ProjenrcTsOptions;

Type: projen.typescript.ProjenrcTsOptions
Default: default options

Options related to projenrc in TypeScript.

`pytest`^Optional

public readonly pytest: boolean;

Type: boolean
Default: true

Include pytest tests.

`pytestOptions`^Optional

public readonly pytestOptions: PytestOptions;

Type: PytestOptions
Default: defaults

pytest options.

`sample`^Optional

public readonly sample: boolean;

Type: boolean
Default: true

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

`sampleTestdir`^Optional

public readonly sampleTestdir: string;

Type: string
Default: "tests"

Location of sample tests.

Typically the same directory where project tests will be located.

`setuptools`^Optional

public readonly setuptools: boolean;

Type: boolean
Default: true, unless poetry is true, then false

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

`uv`^Optional

public readonly uv: boolean;

Type: boolean
Default: false

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

`venv`^Optional

public readonly venv: boolean;

Type: boolean
Default: true, unless poetry is true, then false

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

`venvOptions`^Optional

public readonly venvOptions: VenvOptions;

Type: VenvOptions
Default: defaults

Venv options.

PythonSampleOptions

Options for python sample code.

Initializer

import { python } from 'projen'

const pythonSampleOptions: python.PythonSampleOptions = { ... }

Properties

Name	Type	Description
`dir`	`string`	Sample code directory.

`dir`^Required

public readonly dir: string;

Type: string

Sample code directory.

RequirementsFileOptions

Initializer

import { python } from 'projen'

const requirementsFileOptions: python.RequirementsFileOptions = { ... }

Properties

Name	Type	Description
`packageProvider`	`IPackageProvider`	Provide a list of packages that can be dynamically updated.

`packageProvider`^Optional

public readonly packageProvider: IPackageProvider;

Type: IPackageProvider

Provide a list of packages that can be dynamically updated.

SetupPyOptions

Fields to pass in the setup() function of setup.py.

https://docs.python.org/3/distutils/setupscript.html

Initializer

import { python } from 'projen'

const setupPyOptions: python.SetupPyOptions = { ... }

Properties

Name	Type	Description
`additionalOptions`	`{[ key: string ]: any}`	Escape hatch to allow any value.
`authorEmail`	`string`	Author's e-mail.
`authorName`	`string`	Author's name.
`classifiers`	`string[]`	A list of PyPI trove classifiers that describe the project.
`description`	`string`	A short project description.
`homepage`	`string`	Package's Homepage / Website.
`license`	`string`	The project license.
`name`	`string`	Name of the package.
`packages`	`string[]`	List of submodules to be packaged.
`version`	`string`	Manually specify package version.

`additionalOptions`^Optional

public readonly additionalOptions: {[ key: string ]: any};

Type: {[ key: string ]: any}

Escape hatch to allow any value.

`authorEmail`^Optional

public readonly authorEmail: string;

Type: string

Author's e-mail.

`authorName`^Optional

public readonly authorName: string;

Type: string

Author's name.

`classifiers`^Optional

public readonly classifiers: string[];

Type: string[]

A list of PyPI trove classifiers that describe the project.

https://pypi.org/classifiers/

`description`^Optional

public readonly description: string;

Type: string

A short project description.

`homepage`^Optional

public readonly homepage: string;

Type: string

Package's Homepage / Website.

`license`^Optional

public readonly license: string;

Type: string

The project license.

`name`^Optional

public readonly name: string;

Type: string

Name of the package.

`packages`^Optional

public readonly packages: string[];

Type: string[]

List of submodules to be packaged.

`version`^Optional

public readonly version: string;

Type: string

Manually specify package version.

SetuptoolsOptions

Initializer

import { python } from 'projen'

const setuptoolsOptions: python.SetuptoolsOptions = { ... }

Properties

Name	Type	Description
`authorEmail`	`string`	Author's e-mail.
`authorName`	`string`	Author's name.
`version`	`string`	Version of the package.
`classifiers`	`string[]`	A list of PyPI trove classifiers that describe the project.
`description`	`string`	A short description of the package.
`homepage`	`string`	A URL to the website of the project.
`license`	`string`	License of this package as an SPDX identifier.
`packageName`	`string`	Package name.
`poetryOptions`	`PoetryPyprojectOptionsWithoutDeps`	Additional options to set for poetry if using poetry.
`setupConfig`	`{[ key: string ]: any}`	Additional fields to pass in the setup() function if using setuptools.
`uvOptions`	`UvOptions`	Additional options to set for uv if using uv.
`pythonExec`	`string`	Path to the python executable to use.

`authorEmail`^Required

public readonly authorEmail: string;

Type: string
Default: $GIT_USER_EMAIL

Author's e-mail.

`authorName`^Required

public readonly authorName: string;

Type: string
Default: $GIT_USER_NAME

Author's name.

`version`^Required

public readonly version: string;

Type: string
Default: "0.1.0"

Version of the package.

`classifiers`^Optional

public readonly classifiers: string[];

Type: string[]

A list of PyPI trove classifiers that describe the project.

https://pypi.org/classifiers/

`description`^Optional

public readonly description: string;

Type: string

A short description of the package.

`homepage`^Optional

public readonly homepage: string;

Type: string

A URL to the website of the project.

`license`^Optional

public readonly license: string;

Type: string

License of this package as an SPDX identifier.

`packageName`^Optional

public readonly packageName: string;

Type: string

Package name.

`poetryOptions`^Optional

public readonly poetryOptions: PoetryPyprojectOptionsWithoutDeps;

Type: PoetryPyprojectOptionsWithoutDeps

Additional options to set for poetry if using poetry.

`setupConfig`^Optional

public readonly setupConfig: {[ key: string ]: any};

Type: {[ key: string ]: any}

Additional fields to pass in the setup() function if using setuptools.

`uvOptions`^Optional

public readonly uvOptions: UvOptions;

Type: UvOptions

Additional options to set for uv if using uv.

`pythonExec`^Optional

public readonly pythonExec: string;

Type: string
Default: "python"

Path to the python executable to use.

UvOptions

Options for UV project.

Initializer

import { python } from 'projen'

const uvOptions: python.UvOptions = { ... }

Properties

Name	Type	Description
`pythonExec`	`string`	Path to the python executable to use.
`buildSystem`	`BuildSystem`	Declares any Python level dependencies that must be installed in order to run the project’s build system successfully.
`project`	`PyprojectTomlProject`	The project's basic metadata configuration.
`uv`	`UvConfiguration`	The configuration and metadata for uv.

`pythonExec`^Optional

public readonly pythonExec: string;

Type: string
Default: "python"

Path to the python executable to use.

`buildSystem`^Optional

public readonly buildSystem: BuildSystem;

Type: BuildSystem
Default: no build system

Declares any Python level dependencies that must be installed in order to run the project’s build system successfully.

`project`^Optional

public readonly project: PyprojectTomlProject;

Type: PyprojectTomlProject

The project's basic metadata configuration.

`uv`^Optional

public readonly uv: UvConfiguration;

Type: UvConfiguration

The configuration and metadata for uv.

VenvOptions

Options for venv.

Initializer

import { python } from 'projen'

const venvOptions: python.VenvOptions = { ... }

Properties

Name	Type	Description
`envdir`	`string`	Name of directory to store the environment in.
`pythonExec`	`string`	Path to the python executable to use.

`envdir`^Optional

public readonly envdir: string;

Type: string
Default: ".env"

Name of directory to store the environment in.

`pythonExec`^Optional

public readonly pythonExec: string;

Type: string
Default: "python"

Path to the python executable to use.

Protocols

IPackageProvider

Implemented By: IPackageProvider

Properties

Name	Type	Description
`packages`	`projen.Dependency[]`	An array of packages (may be dynamically generated).

`packages`^Required

public readonly packages: Dependency[];

Type: projen.Dependency[]

An array of packages (may be dynamically generated).

IPythonDeps

Implemented By: Pip, Poetry, Uv, IPythonDeps

Methods

Name	Description
`addDependency`	Adds a runtime dependency.
`addDevDependency`	Adds a dev dependency.
`installDependencies`	Installs dependencies (called during post-synthesis).

`addDependency`

public addDependency(spec: string): void

Adds a runtime dependency.

`spec`^Required

Type: string

Format <module>@<semver>.

`addDevDependency`

public addDevDependency(spec: string): void

Adds a dev dependency.

`spec`^Required

Type: string

Format <module>@<semver>.

`installDependencies`

public installDependencies(): void

Installs dependencies (called during post-synthesis).

Properties

Name	Type	Description
`installCiTask`	`projen.Task`	A task that installs and updates dependencies.

`installCiTask`^Required

public readonly installCiTask: Task;

Type: projen.Task

A task that installs and updates dependencies.

IPythonEnv

Implemented By: Poetry, Uv, Venv, IPythonEnv

Methods

Name	Description
`setupEnvironment`	Initializes the virtual environment if it doesn't exist (called during post-synthesis).

`setupEnvironment`

public setupEnvironment(): void

Initializes the virtual environment if it doesn't exist (called during post-synthesis).

IPythonPackaging

Implemented By: Poetry, Setuptools, Uv, IPythonPackaging

Properties

Name	Type	Description
`publishTask`	`projen.Task`	A task that uploads the package to a package repository.

`publishTask`^Required

public readonly publishTask: Task;

Type: projen.Task

A task that uploads the package to a package repository.

Enums

PyprojectTomlProjectDynamic

Members

Name	Description
`VERSION`	version.
`DESCRIPTION`	description.
`README`	readme.
`REQUIRES_HYPHEN_PYTHON`	requires-python.
`LICENSE`	license.
`LICENSE_HYPHEN_FILES`	license-files.
`AUTHORS`	authors.
`MAINTAINERS`	maintainers.
`KEYWORDS`	keywords.
`CLASSIFIERS`	classifiers.
`URLS`	urls.
`SCRIPTS`	scripts.
`GUI_HYPHEN_SCRIPTS`	gui-scripts.
`ENTRY_HYPHEN_POINTS`	entry-points.
`DEPENDENCIES`	dependencies.
`OPTIONAL_HYPHEN_DEPENDENCIES`	optional-dependencies.
`IMPORT_HYPHEN_NAMES`	import-names.
`IMPORT_HYPHEN_NAMESPACES`	import-namespaces.

`VERSION`

version.

`DESCRIPTION`

description.

`README`

readme.

`REQUIRES_HYPHEN_PYTHON`

requires-python.

`LICENSE`

license.

`LICENSE_HYPHEN_FILES`

license-files.

`AUTHORS`

authors.

`MAINTAINERS`

maintainers.

`KEYWORDS`

keywords.

`CLASSIFIERS`

classifiers.

`URLS`

urls.

`SCRIPTS`

scripts.

`GUI_HYPHEN_SCRIPTS`

gui-scripts.

`ENTRY_HYPHEN_POINTS`

entry-points.

`DEPENDENCIES`

dependencies.

`OPTIONAL_HYPHEN_DEPENDENCIES`

optional-dependencies.

`IMPORT_HYPHEN_NAMES`

import-names.

`IMPORT_HYPHEN_NAMESPACES`

import-namespaces.

Constructs ​

Pip ​

Initializers ​

projectRequired ​

_optionsOptional ​

Methods ​

toString ​

with ​

mixinsRequired ​

postProjectCreation ​

initProjectRequired ​

postSynthesize ​

preSynthesize ​

projectCreation ​

initProjectRequired ​

synthesize ​

addDependency ​

specRequired ​

addDevDependency ​

specRequired ​

installDependencies ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

Properties ​

nodeRequired ​

projectRequired ​

installCiTaskRequired ​

Poetry ​

Initializers ​

projectRequired ​

optionsRequired ​

Methods ​

toString ​

with ​

mixinsRequired ​

postProjectCreation ​

initProjectRequired ​

postSynthesize ​

preSynthesize ​

projectCreation ​

initProjectRequired ​

synthesize ​

addDependency ​

specRequired ​

addDevDependency ​

specRequired ​

installDependencies ​

setupEnvironment ​

Static Functions ​

isConstruct ​

xRequired ​

isComponent ​

xRequired ​

Properties ​

nodeRequired ​

projectRequired ​

installCiTaskRequired ​

installTaskRequired ​

publishTaskRequired ​

publishTestTaskRequired ​

PoetryPyproject ​

Initializers ​

scopeRequired ​

optionsRequired ​

Methods ​

toString ​

with ​

mixinsRequired ​

postProjectCreation ​

initProjectRequired ​

postSynthesize ​

preSynthesize ​

projectCreation ​

initProjectRequired ​

synthesize ​

Static Functions ​

isConstruct ​

Constructs

Pip

Initializers

`project`^Required

`_options`^Optional

Methods

`toString`

`with`

`mixins`^Required

`postProjectCreation`

`initProject`^Required

`postSynthesize`

`preSynthesize`

`projectCreation`

`initProject`^Required

`synthesize`

`addDependency`

`spec`^Required

`addDevDependency`

`spec`^Required

`installDependencies`

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

Properties

`node`^Required

`project`^Required

`installCiTask`^Required

Poetry

Initializers

`project`^Required

`options`^Required

Methods

`toString`

`with`

`mixins`^Required

`postProjectCreation`

`initProject`^Required

`postSynthesize`

`preSynthesize`

`projectCreation`

`initProject`^Required

`synthesize`

`addDependency`

`spec`^Required

`addDevDependency`

`spec`^Required

`installDependencies`

`setupEnvironment`

Static Functions

`isConstruct`

`x`^Required

`isComponent`

`x`^Required

Properties

`node`^Required

`project`^Required

`installCiTask`^Required

`installTask`^Required

`publishTask`^Required

`publishTestTask`^Required

PoetryPyproject

Initializers

`scope`^Required

`options`^Required

Methods

`toString`

`with`

`mixins`^Required

`postProjectCreation`

`initProject`^Required

`postSynthesize`

`preSynthesize`

`projectCreation`

`initProject`^Required

`synthesize`

Static Functions

`isConstruct`