projen 0.71.13 → 0.71.15

package/lib/.types-compat/ts3.9/lib/python/poetry.d.ts

@@ -1,183 +0,0 @@
-import { IPythonDeps } from "./python-deps";
-import { IPythonEnv } from "./python-env";
-import { IPythonPackaging, PythonPackagingOptions } from "./python-packaging";
-import { Component } from "../component";
-import { Project } from "../project";
-import { Task } from "../task";
-import { TomlFile } from "../toml";
-/**
- * Manage project dependencies, virtual environments, and packaging through the
- * poetry CLI tool.
- */
-export declare class Poetry extends Component implements IPythonDeps, IPythonEnv, IPythonPackaging {
-    readonly installTask: Task;
-    readonly publishTask: Task;
-    /**
-     * A task that uploads the package to the Test PyPI repository.
-     */
-    readonly publishTestTask: Task;
-    constructor(project: Project, options: PythonPackagingOptions);
-    private synthDependencies;
-    private synthDevDependencies;
-    /**
-     * Allow for poetry dependencies to specify metadata, eg `mypackage@{ version="1.2.3", extras = ["my-package-extra"] }`
-     * @param dependencies poetry dependencies object
-     * @private
-     */
-    private permitDependenciesWithMetadata;
-    /**
-     * Adds a runtime dependency.
-     *
-     * @param spec Format `<module>@<semver>`
-     */
-    addDependency(spec: string): void;
-    /**
-     * Adds a dev dependency.
-     *
-     * @param spec Format `<module>@<semver>`
-     */
-    addDevDependency(spec: string): void;
-    /**
-     * Initializes the virtual environment if it doesn't exist (called during post-synthesis).
-     */
-    setupEnvironment(): void;
-    /**
-     * Installs dependencies (called during post-synthesis).
-     */
-    installDependencies(): void;
-}
-/**
- * Poetry-specific options.
- * @see https://python-poetry.org/docs/pyproject/
- */
-export interface PoetryPyprojectOptionsWithoutDeps {
-    /**
-     * Name of the package (required).
-     */
-    readonly name?: string;
-    /**
-     * Version of the package (required).
-     */
-    readonly version?: string;
-    /**
-     * A short description of the package (required).
-     */
-    readonly description?: 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".
-     */
-    readonly license?: string;
-    /**
-     * The authors of the package. Must be in the form "name <email>"
-     */
-    readonly authors?: string[];
-    /**
-     * the maintainers of the package. Must be in the form "name <email>"
-     */
-    readonly maintainers?: string[];
-    /**
-     * The name of the readme file of the package.
-     */
-    readonly readme?: string;
-    /**
-     * A URL to the website of the project.
-     */
-    readonly homepage?: string;
-    /**
-     * A URL to the repository of the project.
-     */
-    readonly repository?: string;
-    /**
-     * A URL to the documentation of the project.
-     */
-    readonly documentation?: string;
-    /**
-     * A list of keywords (max: 5) that the package is related to.
-     */
-    readonly keywords?: string[];
-    /**
-     * A list of PyPI trove classifiers that describe the project.
-     *
-     * @see https://pypi.org/classifiers/
-     */
-    readonly classifiers?: string[];
-    /**
-     * A list of packages and modules to include in the final distribution.
-     */
-    readonly packages?: any[];
-    /**
-     * A list of patterns that will be included in the final package.
-     */
-    readonly include?: 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).
-     */
-    readonly exclude?: string[];
-    /**
-     * The scripts or executables that will be installed when installing the package.
-     */
-    readonly scripts?: {
-        [key: string]: any;
-    };
-    /**
-     * Source registries from which packages are retrieved.
-     */
-    readonly source?: any[];
-    /**
-     * Package extras
-     */
-    readonly extras?: {
-        [key: string]: string[];
-    };
-    /**
-     * Plugins. Must be specified as a table.
-     * @see https://toml.io/en/v1.0.0#table
-     */
-    readonly plugins?: any;
-    /**
-     * Project custom URLs, in addition to homepage, repository and documentation.
-     * E.g. "Bug Tracker"
-     */
-    readonly urls?: {
-        [key: string]: string;
-    };
-}
-/**
- * Poetry-specific options.
- * @see https://python-poetry.org/docs/pyproject/
- */
-export interface PoetryPyprojectOptions extends PoetryPyprojectOptionsWithoutDeps {
-    /**
-     * A list of dependencies for the project.
-     *
-     * The python version for which your package is compatible is also required.
-     *
-     * @example { requests: "^2.13.0" }
-     */
-    readonly dependencies?: {
-        [key: string]: any;
-    };
-    /**
-     * A list of development dependencies for the project.
-     *
-     * @example { requests: "^2.13.0" }
-     */
-    readonly devDependencies?: {
-        [key: string]: any;
-    };
-}
-/**
- * Represents configuration of a pyproject.toml file for a Poetry project.
- *
- * @see https://python-poetry.org/docs/pyproject/
- */
-export declare class PoetryPyproject extends Component {
-    readonly file: TomlFile;
-    constructor(project: Project, options: PoetryPyprojectOptions);
-}

package/lib/.types-compat/ts3.9/lib/python/projenrc.d.ts

@@ -1,32 +0,0 @@
-import { Project } from "../project";
-import { ProjenrcFile } from "../projenrc";
-/**
- * Options for `Projenrc`.
- */
-export interface ProjenrcOptions {
-    /**
-     * The name of the projenrc file.
-     * @default ".projenrc.py"
-     */
-    readonly filename?: string;
-    /**
-     * The projen version to use
-     * @default - current version
-     */
-    readonly projenVersion?: string;
-}
-/**
- * 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`.
- */
-export declare class Projenrc extends ProjenrcFile {
-    /**
-     * The name of the projenrc file.
-     */
-    readonly filePath: string;
-    constructor(project: Project, options?: ProjenrcOptions);
-    private generateProjenrc;
-}
-export declare function resolvePythonImportName(jsiiFqn: string, jsiiManifest: any): string;

package/lib/.types-compat/ts3.9/lib/python/pytest-sample.d.ts

@@ -1,21 +0,0 @@
-import { Component } from "..";
-import { Project } from "../project";
-/**
- * Options for python test code sample.
- */
-export interface PytestSampleOptions {
-    /**
-     * Name of the python package as used in imports and filenames.
-     */
-    readonly moduleName: string;
-    /**
-     * Test directory
-     */
-    readonly testdir: string;
-}
-/**
- * Python test code sample.
- */
-export declare class PytestSample extends Component {
-    constructor(project: Project, options: PytestSampleOptions);
-}

package/lib/.types-compat/ts3.9/lib/python/pytest.d.ts

@@ -1,24 +0,0 @@
-import { Component } from "../component";
-import { Project } from "../project";
-export interface PytestOptions {
-    /**
-     * Pytest version
-     *
-     * @default "6.2.1"
-     */
-    readonly version?: string;
-    /**
-     * Directory with tests
-     *
-     * @default 'tests'
-     */
-    readonly testdir?: string;
-    /**
-     * Stop the testing process after the first N failures
-     */
-    readonly maxFailures?: number;
-}
-export declare class Pytest extends Component {
-    readonly testdir: string;
-    constructor(project: Project, options?: PytestOptions);
-}

package/lib/.types-compat/ts3.9/lib/python/python-deps.d.ts

@@ -1,30 +0,0 @@
-import { Dependency } from "../dependencies";
-import { Task } from "../task";
-export interface IPythonDeps {
-    /**
-     * A task that installs and updates dependencies.
-     */
-    readonly installTask: Task;
-    /**
-     * Adds a runtime dependency.
-     *
-     * @param spec Format `<module>@<semver>`
-     */
-    addDependency(spec: string): void;
-    /**
-     * Adds a dev dependency.
-     *
-     * @param spec Format `<module>@<semver>`
-     */
-    addDevDependency(spec: string): void;
-    /**
-     * Installs dependencies (called during post-synthesis).
-     */
-    installDependencies(): void;
-}
-export interface IPackageProvider {
-    /**
-     * An array of packages (may be dynamically generated).
-     */
-    readonly packages: Dependency[];
-}

package/lib/.types-compat/ts3.9/lib/python/python-env.d.ts

@@ -1,6 +0,0 @@
-export interface IPythonEnv {
-    /**
-     * Initializes the virtual environment if it doesn't exist (called during post-synthesis).
-     */
-    setupEnvironment(): void;
-}

package/lib/.types-compat/ts3.9/lib/python/python-packaging.d.ts

@@ -1,62 +0,0 @@
-import { PoetryPyprojectOptionsWithoutDeps } from "./poetry";
-import { Task } from "../task";
-export interface IPythonPackaging {
-    /**
-     * A task that uploads the package to a package repository.
-     */
-    readonly publishTask: Task;
-}
-export interface PythonPackagingOptions {
-    /**
-     * Author's name
-     *
-     * @default $GIT_USER_NAME
-     */
-    readonly authorName: string;
-    /**
-     * Package name.
-     */
-    readonly packageName?: string;
-    /**
-     * Author's e-mail
-     *
-     * @default $GIT_USER_EMAIL
-     */
-    readonly authorEmail: string;
-    /**
-     * Version of the package.
-     *
-     * @default "0.1.0"
-     * @featured
-     */
-    readonly version: string;
-    /**
-     * A short description of the package.
-     * @featured
-     */
-    readonly description?: string;
-    /**
-     * License of this package as an SPDX identifier.
-     */
-    readonly license?: string;
-    /**
-     * A URL to the website of the project.
-     */
-    readonly homepage?: string;
-    /**
-     * A list of PyPI trove classifiers that describe the project.
-     *
-     * @see https://pypi.org/classifiers/
-     */
-    readonly classifiers?: string[];
-    /**
-     * Additional fields to pass in the setup() function if using setuptools
-     */
-    readonly setupConfig?: {
-        [key: string]: any;
-    };
-    /**
-     * Additional options to set for poetry if using poetry
-     */
-    readonly poetryOptions?: PoetryPyprojectOptionsWithoutDeps;
-}

package/lib/.types-compat/ts3.9/lib/python/python-project.d.ts

@@ -1,190 +0,0 @@
-import { ProjenrcOptions as ProjenrcPythonOptions } from "./projenrc";
-import { Pytest, PytestOptions } from "./pytest";
-import { IPythonDeps } from "./python-deps";
-import { IPythonEnv } from "./python-env";
-import { IPythonPackaging, PythonPackagingOptions } from "./python-packaging";
-import { VenvOptions } from "./venv";
-import { GitHubProject, GitHubProjectOptions } from "../github";
-import { ProjenrcOptions as ProjenrcJsOptions } from "../javascript/projenrc";
-import { ProjenrcTsOptions } from "../typescript";
-/**
- * Options for `PythonProject`.
- */
-export interface PythonProjectOptions extends GitHubProjectOptions, PythonPackagingOptions {
-    /**
-     * Name of the python package as used in imports and filenames.
-     *
-     * Must only consist of alphanumeric characters and underscores.
-     *
-     * @default $PYTHON_MODULE_NAME
-     */
-    readonly moduleName: string;
-    /**
-     * List of runtime dependencies for this project.
-     *
-     * Dependencies use the format: `<module>@<semver>`
-     *
-     * Additional dependencies can be added via `project.addDependency()`.
-     *
-     * @default []
-     * @featured
-     */
-    readonly deps?: string[];
-    /**
-     * List of dev dependencies for this project.
-     *
-     * Dependencies use the format: `<module>@<semver>`
-     *
-     * Additional dependencies can be added via `project.addDevDependency()`.
-     *
-     * @default []
-     * @featured
-     */
-    readonly devDeps?: string[];
-    /**
-     * Use pip with a requirements.txt file to track project dependencies.
-     *
-     * @default - true, unless poetry is true, then false
-     * @featured
-     */
-    readonly pip?: boolean;
-    /**
-     * Use venv to manage a virtual environment for installing dependencies inside.
-     *
-     * @default - true, unless poetry is true, then false
-     * @featured
-     */
-    readonly venv?: boolean;
-    /**
-     * Venv options
-     * @default - defaults
-     */
-    readonly venvOptions?: VenvOptions;
-    /**
-     * Use setuptools with a setup.py script for packaging and publishing.
-     *
-     * @default - true, unless poetry is true, then false
-     * @featured
-     */
-    readonly setuptools?: boolean;
-    /**
-     * 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`.
-     *
-     * @default false
-     * @featured
-     */
-    readonly poetry?: boolean;
-    /**
-     * Include pytest tests.
-     * @default true
-     * @featured
-     */
-    readonly pytest?: boolean;
-    /**
-     * pytest options
-     * @default - defaults
-     */
-    readonly pytestOptions?: PytestOptions;
-    /**
-     * Include sample code and test if the relevant directories don't exist.
-     * @default true
-     */
-    readonly sample?: boolean;
-    /**
-     * Use projenrc in Python.
-     *
-     * This will install `projen` as a Python dependency and add a `synth`
-     * task which will run `.projenrc.py`.
-     *
-     * @default true
-     */
-    readonly projenrcPython?: boolean;
-    /**
-     * Options related to projenrc in python.
-     * @default - default options
-     */
-    readonly projenrcPythonOptions?: ProjenrcPythonOptions;
-    /**
-     * Use projenrc in javascript.
-     *
-     * This will install `projen` as a JavaScript dependency and add a `synth`
-     * task which will run `.projenrc.js`.
-     *
-     * @default false
-     */
-    readonly projenrcJs?: boolean;
-    /**
-     * Options related to projenrc in JavaScript.
-     * @default - default options
-     */
-    readonly projenrcJsOptions?: ProjenrcJsOptions;
-    /**
-     * Use projenrc in TypeScript.
-     *
-     * This will create a tsconfig file (default: `tsconfig.projen.json`)
-     * and use `ts-node` in the default task to parse the project source files.
-     *
-     * @default false
-     */
-    readonly projenrcTs?: boolean;
-    /**
-     * Options related to projenrc in TypeScript.
-     * @default - default options
-     */
-    readonly projenrcTsOptions?: ProjenrcTsOptions;
-}
-/**
- * Python project.
- *
- * @pjid python
- */
-export declare class PythonProject extends GitHubProject {
-    /**
-     * Python module name (the project name, with any hyphens or periods replaced
-     * with underscores).
-     */
-    readonly moduleName: string;
-    /**
-     * Version of the package for distribution (should follow semver).
-     */
-    readonly version: string;
-    /**
-     * API for managing dependencies.
-     */
-    readonly depsManager: IPythonDeps;
-    /**
-     * API for mangaging the Python runtime environment.
-     */
-    readonly envManager: IPythonEnv;
-    /**
-     * API for managing packaging the project as a library. Only applies when the `projectType` is LIB.
-     */
-    readonly packagingManager?: IPythonPackaging;
-    /**
-     * Pytest component.
-     */
-    pytest?: Pytest;
-    constructor(options: PythonProjectOptions);
-    /**
-     * Adds default gitignore options for a Python project based on
-     * https://github.com/github/gitignore/blob/master/Python.gitignore
-     */
-    private addDefaultGitIgnore;
-    /**
-     * Adds a runtime dependency.
-     *
-     * @param spec Format `<module>@<semver>`
-     */
-    addDependency(spec: string): void;
-    /**
-     * Adds a dev dependency.
-     *
-     * @param spec Format `<module>@<semver>`
-     */
-    addDevDependency(spec: string): void;
-    postSynthesize(): void;
-}

package/lib/.types-compat/ts3.9/lib/python/python-sample.d.ts

@@ -1,17 +0,0 @@
-import { Component } from "../component";
-import { Project } from "../project";
-/**
- * Options for python sample code.
- */
-export interface PythonSampleOptions {
-    /**
-     * Sample code directory
-     */
-    readonly dir: string;
-}
-/**
- * Python code sample.
- */
-export declare class PythonSample extends Component {
-    constructor(project: Project, options: PythonSampleOptions);
-}

package/lib/.types-compat/ts3.9/lib/python/requirements-file.d.ts

@@ -1,29 +0,0 @@
-import { IPackageProvider } from "./python-deps";
-import { FileBase, IResolver } from "../file";
-import { Project } from "../project";
-export interface RequirementsFileOptions {
-    /**
-     * Provide a list of packages that can be dynamically updated.
-     */
-    readonly packageProvider?: IPackageProvider;
-}
-/**
- * Specifies a list of packages to be installed using pip.
- *
- * @see https://pip.pypa.io/en/stable/reference/pip_install/#requirements-file-format
- */
-export declare class RequirementsFile extends FileBase {
-    private readonly packages;
-    private readonly packageProvider?;
-    constructor(project: Project, filePath: string, options: RequirementsFileOptions);
-    /**
-     * Adds the specified packages provided in semver format.
-     *
-     * Comment lines (start with `#`) are ignored.
-     *
-     * @param packages Package version in format `<module>@<semver>`
-     */
-    addPackages(...packages: string[]): void;
-    private formatDependency;
-    protected synthesizeContent(resolver: IResolver): string | undefined;
-}

package/lib/.types-compat/ts3.9/lib/python/setuppy.d.ts

@@ -1,70 +0,0 @@
-import { FileBase, IResolver } from "../file";
-import { Project } from "../project";
-/**
- * Fields to pass in the setup() function of setup.py
- *
- * @see https://docs.python.org/3/distutils/setupscript.html
- */
-export interface SetupPyOptions {
-    /**
-     * Name of the package
-     */
-    readonly name?: string;
-    /**
-     * List of submodules to be packaged
-     */
-    readonly packages?: string[];
-    /**
-     * Author's name
-     */
-    readonly authorName?: string;
-    /**
-     * Author's e-mail
-     */
-    readonly authorEmail?: string;
-    /**
-     * Manually specify package version
-     */
-    readonly version?: string;
-    /**
-     * A short project description
-     */
-    readonly description?: string;
-    /**
-     * The project license
-     */
-    readonly license?: string;
-    /**
-     * Package's Homepage / Website
-     */
-    readonly homepage?: string;
-    /**
-     * A list of PyPI trove classifiers that describe the project.
-     *
-     * @see https://pypi.org/classifiers/
-     */
-    readonly classifiers?: string[];
-    /**
-     * Escape hatch to allow any value
-     */
-    readonly additionalOptions?: {
-        [name: string]: any;
-    };
-    /**
-     * Escape hatch to allow any value (JS/TS only)
-     *
-     * @deprecated Prefer using `additionalOptions` instead.
-     *
-     * @jsii ignore
-     */
-    readonly [name: string]: any;
-}
-/**
- * Python packaging script where package metadata can be placed.
- */
-export declare class SetupPy extends FileBase {
-    private readonly setupConfig;
-    constructor(project: Project, options: SetupPyOptions);
-    protected synthesizeContent(resolver: IResolver): string | undefined;
-    private renameFields;
-}

package/lib/.types-compat/ts3.9/lib/python/setuptools.d.ts

@@ -1,15 +0,0 @@
-import { IPythonPackaging, PythonPackagingOptions } from "./python-packaging";
-import { Component } from "../component";
-import { Project } from "../project";
-import { Task } from "../task";
-/**
- * Manages packaging through setuptools with a setup.py script.
- */
-export declare class Setuptools extends Component implements IPythonPackaging {
-    readonly publishTask: Task;
-    /**
-     * A task that uploads the package to the Test PyPI repository.
-     */
-    readonly publishTestTask: Task;
-    constructor(project: Project, options: PythonPackagingOptions);
-}