projen 0.70.2 → 0.70.4

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

@@ -0,0 +1,32 @@
+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

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,24 @@
+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

@@ -0,0 +1,30 @@
+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

@@ -0,0 +1,6 @@
+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

@@ -0,0 +1,62 @@
+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

@@ -0,0 +1,190 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,70 @@
+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

@@ -0,0 +1,15 @@
+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);
+}

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

@@ -0,0 +1,28 @@
+import { IPythonEnv } from "./python-env";
+import { Component } from "../component";
+import { Project } from "../project";
+/**
+ * Options for venv.
+ */
+export interface VenvOptions {
+    /**
+     * Name of directory to store the environment in
+     *
+     * @default ".env"
+     */
+    readonly envdir?: string;
+}
+/**
+ * Manages a virtual environment through the Python venv module.
+ */
+export declare class Venv extends Component implements IPythonEnv {
+    /**
+     * Name of directory to store the environment in
+     */
+    private readonly envdir;
+    constructor(project: Project, options?: VenvOptions);
+    /**
+     * Initializes the virtual environment if it doesn't exist (called during post-synthesis).
+     */
+    setupEnvironment(): void;
+}

package/lib/.types-compat/ts3.9/lib/readme.d.ts

@@ -0,0 +1,28 @@
+import { Project } from "./project";
+import { SampleFile } from "./sample-file";
+/**
+ * SampleReadme Properties
+ */
+export interface SampleReadmeProps {
+    /**
+     * The name of the README.md file
+     *
+     * @default "README.md"
+     * @example "readme.md"
+     */
+    readonly filename?: string;
+    /**
+     * The contents
+     * @default "# replace this"
+     */
+    readonly contents?: string;
+}
+/**
+ * Represents a README.md sample file.
+ * You are expected to manage this file after creation.
+ *
+ * @param text - The initial contents of the README.md file. Defaults to '# replace this'
+ */
+export declare class SampleReadme extends SampleFile {
+    constructor(project: Project, props?: SampleReadmeProps);
+}

package/lib/.types-compat/ts3.9/lib/release/bump-version.d.ts

@@ -0,0 +1,72 @@
+import { Config } from "conventional-changelog-config-spec";
+export interface BumpOptions {
+    /**
+     * The name of a .json file to set `version`.
+     */
+    readonly versionFile: string;
+    /**
+     * The name of the changelog file to generate.
+     */
+    readonly changelog: string;
+    /**
+     * Use a pre-release suffix.
+     * @default - normal versioning
+     */
+    readonly prerelease?: string;
+    /**
+     * Defines the major version line. This is used to select the latest version
+     * and also enforce that new major versions are not released accidentally.
+     *
+     * Can not be set together with `minMajorVersion`.
+     *
+     * @default - any version is supported
+     */
+    readonly majorVersion?: number;
+    /**
+     * Defines the minimal major version. This is used if you want to start with
+     * a specific major version, and increment from there on.
+     * This can be useful to set to 1, as breaking changes before the 1.x major
+     * release are not incrementing the major version number.
+     *
+     * Can not be set together with `majorVersion`.
+     *
+     * @default - No minimum version is being enforced
+     */
+    readonly minMajorVersion?: number;
+    /**
+     * The name of a file which will include the output version number (a text file).
+     *
+     * Relative to cwd.
+     *
+     * @example ".version.txt"
+     */
+    readonly bumpFile: string;
+    /**
+     * The name of the file which will include the release tag (a text file).
+     *
+     * Relative to cwd.
+     *
+     * @example ".releasetag.txt"
+     */
+    readonly releaseTagFile: string;
+    /**
+     * The prefix applied to release tags. Bumps will be made based on the latest
+     * version found with this prefix.
+     */
+    readonly tagPrefix?: string;
+    /**
+     * Conguration values that would append to versionrc file or overwrite values
+     * coming to that from default one.
+     */
+    readonly versionrcOptions?: Config;
+}
+/**
+ * Resolves the latest version from git tags and uses `standard-version` to bump
+ * to the next version based on commits.
+ *
+ * This expects `standard-version` to be installed in the path.
+ *
+ * @param cwd working directory (git repository)
+ * @param options options
+ */
+export declare function bump(cwd: string, options: BumpOptions): Promise<void>;

package/lib/.types-compat/ts3.9/lib/release/bump-version.task.d.ts

@@ -0,0 +1 @@
+export {};

package/lib/.types-compat/ts3.9/lib/release/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./release";
+export * from "./publisher";
+export * from "./release-trigger";