projen-modules 0.1.2__py3-none-any.whl → 0.1.4__py3-none-any.whl

projen_modules/__init__.py

@@ -1,6 +1,8 @@
 r'''
 # projen-modules
 
+A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
+
 ## Getting Started
 
 ```sh
@@ -241,6 +243,7 @@ class JsiiProject(
         pull_request_template: typing.Optional[builtins.bool] = None,
         pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
         python: typing.Optional[typing.Union[_projen_cdk_04054675.JsiiPythonTarget, typing.Dict[builtins.str, typing.Any]]] = None,
+        readme: typing.Optional[typing.Union["ReadmeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
         releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
         release: typing.Optional[builtins.bool] = None,
         release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -404,6 +407,7 @@ class JsiiProject(
         :param pull_request_template: (experimental) Include a GitHub pull request template. Default: true
         :param pull_request_template_contents: (experimental) The contents of the pull request template. Default: - default content
         :param python: 
+        :param readme: Configuration of the README.md file.
         :param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
         :param release: (experimental) Add release management to this project. Default: - true (false for subprojects)
         :param release_branches: (experimental) Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch *must* be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the ``majorVersion`` field must also be provided for the default branch. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
@@ -567,6 +571,7 @@ class JsiiProject(
             pull_request_template=pull_request_template,
             pull_request_template_contents=pull_request_template_contents,
             python=python,
+            readme=readme,
             releasable_commits=releasable_commits,
             release=release,
             release_branches=release_branches,
@@ -749,6 +754,7 @@ class JsiiProject(
         "pull_request_template": "pullRequestTemplate",
         "pull_request_template_contents": "pullRequestTemplateContents",
         "python": "python",
+        "readme": "readme",
         "releasable_commits": "releasableCommits",
         "release": "release",
         "release_branches": "releaseBranches",
@@ -916,6 +922,7 @@ class JsiiProjectOptions:
         pull_request_template: typing.Optional[builtins.bool] = None,
         pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
         python: typing.Optional[typing.Union[_projen_cdk_04054675.JsiiPythonTarget, typing.Dict[builtins.str, typing.Any]]] = None,
+        readme: typing.Optional[typing.Union["ReadmeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
         releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
         release: typing.Optional[builtins.bool] = None,
         release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -1080,6 +1087,7 @@ class JsiiProjectOptions:
         :param pull_request_template: (experimental) Include a GitHub pull request template. Default: true
         :param pull_request_template_contents: (experimental) The contents of the pull request template. Default: - default content
         :param python: 
+        :param readme: Configuration of the README.md file.
         :param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
         :param release: (experimental) Add release management to this project. Default: - true (false for subprojects)
         :param release_branches: (experimental) Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch *must* be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the ``majorVersion`` field must also be provided for the default branch. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
@@ -1178,6 +1186,8 @@ class JsiiProjectOptions:
             publish_to_pypi = _projen_cdk_04054675.JsiiPythonTarget(**publish_to_pypi)
         if isinstance(python, dict):
             python = _projen_cdk_04054675.JsiiPythonTarget(**python)
+        if isinstance(readme, dict):
+            readme = ReadmeOptions(**readme)
         if isinstance(renovatebot_options, dict):
             renovatebot_options = _projen_04054675.RenovatebotOptions(**renovatebot_options)
         if isinstance(stale_options, dict):
@@ -1316,6 +1326,7 @@ class JsiiProjectOptions:
             check_type(argname="argument pull_request_template", value=pull_request_template, expected_type=type_hints["pull_request_template"])
             check_type(argname="argument pull_request_template_contents", value=pull_request_template_contents, expected_type=type_hints["pull_request_template_contents"])
             check_type(argname="argument python", value=python, expected_type=type_hints["python"])
+            check_type(argname="argument readme", value=readme, expected_type=type_hints["readme"])
             check_type(argname="argument releasable_commits", value=releasable_commits, expected_type=type_hints["releasable_commits"])
             check_type(argname="argument release", value=release, expected_type=type_hints["release"])
             check_type(argname="argument release_branches", value=release_branches, expected_type=type_hints["release_branches"])
@@ -1594,6 +1605,8 @@ class JsiiProjectOptions:
             self._values["pull_request_template_contents"] = pull_request_template_contents
         if python is not None:
             self._values["python"] = python
+        if readme is not None:
+            self._values["readme"] = readme
         if releasable_commits is not None:
             self._values["releasable_commits"] = releasable_commits
         if release is not None:
@@ -3163,6 +3176,12 @@ class JsiiProjectOptions:
         result = self._values.get("python")
         return typing.cast(typing.Optional[_projen_cdk_04054675.JsiiPythonTarget], result)
 
+    @builtins.property
+    def readme(self) -> typing.Optional["ReadmeOptions"]:
+        '''Configuration of the README.md file.'''
+        result = self._values.get("readme")
+        return typing.cast(typing.Optional["ReadmeOptions"], result)
+
     @builtins.property
     def releasable_commits(self) -> typing.Optional[_projen_04054675.ReleasableCommits]:
         '''(experimental) Find commits that should be considered releasable Used to decide if a release is required.
@@ -3812,6 +3831,7 @@ class NpmPackage(
         publish_tasks: typing.Optional[builtins.bool] = None,
         pull_request_template: typing.Optional[builtins.bool] = None,
         pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
+        readme: typing.Optional[typing.Union["ReadmeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
         releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
         release: typing.Optional[builtins.bool] = None,
         release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -3959,6 +3979,7 @@ class NpmPackage(
         :param publish_tasks: (experimental) Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. Default: false
         :param pull_request_template: (experimental) Include a GitHub pull request template. Default: true
         :param pull_request_template_contents: (experimental) The contents of the pull request template. Default: - default content
+        :param readme: Configuration of the README.md file.
         :param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
         :param release: (experimental) Add release management to this project. Default: - true (false for subprojects)
         :param release_branches: (experimental) Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch *must* be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the ``majorVersion`` field must also be provided for the default branch. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
@@ -4106,6 +4127,7 @@ class NpmPackage(
             publish_tasks=publish_tasks,
             pull_request_template=pull_request_template,
             pull_request_template_contents=pull_request_template_contents,
+            readme=readme,
             releasable_commits=releasable_commits,
             release=release,
             release_branches=release_branches,
@@ -4150,6 +4172,18 @@ class NpmPackage(
 
         jsii.create(self.__class__, self, [options])
 
+    @builtins.property
+    @jsii.member(jsii_name="readme")
+    def readme(self) -> "Readme":
+        return typing.cast("Readme", jsii.get(self, "readme"))
+
+    @readme.setter
+    def readme(self, value: "Readme") -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__6cb7da275ba82f1b6bb477c4c22f7721642ea0759b39a4fc1874a92b34daa7eb)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "readme", value) # pyright: ignore[reportArgumentType]
+
 
 @jsii.data_type(
     jsii_type="projen-modules.NpmPackageOptions",
@@ -4260,6 +4294,7 @@ class NpmPackage(
         "publish_tasks": "publishTasks",
         "pull_request_template": "pullRequestTemplate",
         "pull_request_template_contents": "pullRequestTemplateContents",
+        "readme": "readme",
         "releasable_commits": "releasableCommits",
         "release": "release",
         "release_branches": "releaseBranches",
@@ -4411,6 +4446,7 @@ class NpmPackageOptions:
         publish_tasks: typing.Optional[builtins.bool] = None,
         pull_request_template: typing.Optional[builtins.bool] = None,
         pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
+        readme: typing.Optional[typing.Union["ReadmeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
         releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
         release: typing.Optional[builtins.bool] = None,
         release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -4559,6 +4595,7 @@ class NpmPackageOptions:
         :param publish_tasks: (experimental) Define publishing tasks that can be executed manually as well as workflows. Normally, publishing only happens within automated workflows. Enable this in order to create a publishing task for each publishing activity. Default: false
         :param pull_request_template: (experimental) Include a GitHub pull request template. Default: true
         :param pull_request_template_contents: (experimental) The contents of the pull request template. Default: - default content
+        :param readme: Configuration of the README.md file.
         :param releasable_commits: (experimental) Find commits that should be considered releasable Used to decide if a release is required. Default: ReleasableCommits.everyCommit()
         :param release: (experimental) Add release management to this project. Default: - true (false for subprojects)
         :param release_branches: (experimental) Defines additional release branches. A workflow will be created for each release branch which will publish releases from commits in this branch. Each release branch *must* be assigned a major version number which is used to enforce that versions published from that branch always use that major version. If multiple branches are used, the ``majorVersion`` field must also be provided for the default branch. Default: - no additional branches are used for release. you can use ``addBranch()`` to add additional branches.
@@ -4644,6 +4681,8 @@ class NpmPackageOptions:
             projenrc_js_options = _projen_javascript_04054675.ProjenrcOptions(**projenrc_js_options)
         if isinstance(projenrc_ts_options, dict):
             projenrc_ts_options = _projen_typescript_04054675.ProjenrcOptions(**projenrc_ts_options)
+        if isinstance(readme, dict):
+            readme = ReadmeOptions(**readme)
         if isinstance(renovatebot_options, dict):
             renovatebot_options = _projen_04054675.RenovatebotOptions(**renovatebot_options)
         if isinstance(stale_options, dict):
@@ -4767,6 +4806,7 @@ class NpmPackageOptions:
             check_type(argname="argument publish_tasks", value=publish_tasks, expected_type=type_hints["publish_tasks"])
             check_type(argname="argument pull_request_template", value=pull_request_template, expected_type=type_hints["pull_request_template"])
             check_type(argname="argument pull_request_template_contents", value=pull_request_template_contents, expected_type=type_hints["pull_request_template_contents"])
+            check_type(argname="argument readme", value=readme, expected_type=type_hints["readme"])
             check_type(argname="argument releasable_commits", value=releasable_commits, expected_type=type_hints["releasable_commits"])
             check_type(argname="argument release", value=release, expected_type=type_hints["release"])
             check_type(argname="argument release_branches", value=release_branches, expected_type=type_hints["release_branches"])
@@ -5017,6 +5057,8 @@ class NpmPackageOptions:
             self._values["pull_request_template"] = pull_request_template
         if pull_request_template_contents is not None:
             self._values["pull_request_template_contents"] = pull_request_template_contents
+        if readme is not None:
+            self._values["readme"] = readme
         if releasable_commits is not None:
             self._values["releasable_commits"] = releasable_commits
         if release is not None:
@@ -6403,6 +6445,12 @@ class NpmPackageOptions:
         result = self._values.get("pull_request_template_contents")
         return typing.cast(typing.Optional[typing.List[builtins.str]], result)
 
+    @builtins.property
+    def readme(self) -> typing.Optional["ReadmeOptions"]:
+        '''Configuration of the README.md file.'''
+        result = self._values.get("readme")
+        return typing.cast(typing.Optional["ReadmeOptions"], result)
+
     @builtins.property
     def releasable_commits(self) -> typing.Optional[_projen_04054675.ReleasableCommits]:
         '''(experimental) Find commits that should be considered releasable Used to decide if a release is required.
@@ -6986,6 +7034,7 @@ class PythonPackage(
         pytest: typing.Optional[builtins.bool] = None,
         pytest_options: typing.Optional[typing.Union[_projen_python_04054675.PytestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         python_exec: typing.Optional[builtins.str] = None,
+        readme: typing.Optional[typing.Union["ReadmeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
         renovatebot: typing.Optional[builtins.bool] = None,
         renovatebot_options: typing.Optional[typing.Union[_projen_04054675.RenovatebotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         sample: typing.Optional[builtins.bool] = None,
@@ -7047,6 +7096,7 @@ class PythonPackage(
         :param pytest: (experimental) Include pytest tests. Default: true
         :param pytest_options: (experimental) pytest options. Default: - defaults
         :param python_exec: (experimental) Path to the python executable to use. Default: "python"
+        :param readme: Configuration of the README.md file.
         :param renovatebot: (experimental) Use renovatebot to handle dependency upgrades. Default: false
         :param renovatebot_options: (experimental) Options for renovatebot. Default: - default options
         :param sample: (experimental) Include sample code and test if the relevant directories don't exist. Default: true
@@ -7108,6 +7158,7 @@ class PythonPackage(
             pytest=pytest,
             pytest_options=pytest_options,
             python_exec=python_exec,
+            readme=readme,
             renovatebot=renovatebot,
             renovatebot_options=renovatebot_options,
             sample=sample,
@@ -7122,6 +7173,18 @@ class PythonPackage(
 
         jsii.create(self.__class__, self, [options])
 
+    @builtins.property
+    @jsii.member(jsii_name="readme")
+    def readme(self) -> "Readme":
+        return typing.cast("Readme", jsii.get(self, "readme"))
+
+    @readme.setter
+    def readme(self, value: "Readme") -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__1a456e663d7da59de9fd68ca5bb5f5bc98971d99102fdb04adfe975c14215095)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "readme", value) # pyright: ignore[reportArgumentType]
+
 
 @jsii.data_type(
     jsii_type="projen-modules.PythonPackageOptions",
@@ -7176,6 +7239,7 @@ class PythonPackage(
         "pytest": "pytest",
         "pytest_options": "pytestOptions",
         "python_exec": "pythonExec",
+        "readme": "readme",
         "renovatebot": "renovatebot",
         "renovatebot_options": "renovatebotOptions",
         "sample": "sample",
@@ -7241,6 +7305,7 @@ class PythonPackageOptions:
         pytest: typing.Optional[builtins.bool] = None,
         pytest_options: typing.Optional[typing.Union[_projen_python_04054675.PytestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         python_exec: typing.Optional[builtins.str] = None,
+        readme: typing.Optional[typing.Union["ReadmeOptions", typing.Dict[builtins.str, typing.Any]]] = None,
         renovatebot: typing.Optional[builtins.bool] = None,
         renovatebot_options: typing.Optional[typing.Union[_projen_04054675.RenovatebotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
         sample: typing.Optional[builtins.bool] = None,
@@ -7303,6 +7368,7 @@ class PythonPackageOptions:
         :param pytest: (experimental) Include pytest tests. Default: true
         :param pytest_options: (experimental) pytest options. Default: - defaults
         :param python_exec: (experimental) Path to the python executable to use. Default: "python"
+        :param readme: Configuration of the README.md file.
         :param renovatebot: (experimental) Use renovatebot to handle dependency upgrades. Default: false
         :param renovatebot_options: (experimental) Options for renovatebot. Default: - default options
         :param sample: (experimental) Include sample code and test if the relevant directories don't exist. Default: true
@@ -7340,6 +7406,8 @@ class PythonPackageOptions:
             projenrc_ts_options = _projen_typescript_04054675.ProjenrcTsOptions(**projenrc_ts_options)
         if isinstance(pytest_options, dict):
             pytest_options = _projen_python_04054675.PytestOptions(**pytest_options)
+        if isinstance(readme, dict):
+            readme = ReadmeOptions(**readme)
         if isinstance(renovatebot_options, dict):
             renovatebot_options = _projen_04054675.RenovatebotOptions(**renovatebot_options)
         if isinstance(stale_options, dict):
@@ -7397,6 +7465,7 @@ class PythonPackageOptions:
             check_type(argname="argument pytest", value=pytest, expected_type=type_hints["pytest"])
             check_type(argname="argument pytest_options", value=pytest_options, expected_type=type_hints["pytest_options"])
             check_type(argname="argument python_exec", value=python_exec, expected_type=type_hints["python_exec"])
+            check_type(argname="argument readme", value=readme, expected_type=type_hints["readme"])
             check_type(argname="argument renovatebot", value=renovatebot, expected_type=type_hints["renovatebot"])
             check_type(argname="argument renovatebot_options", value=renovatebot_options, expected_type=type_hints["renovatebot_options"])
             check_type(argname="argument sample", value=sample, expected_type=type_hints["sample"])
@@ -7501,6 +7570,8 @@ class PythonPackageOptions:
             self._values["pytest_options"] = pytest_options
         if python_exec is not None:
             self._values["python_exec"] = python_exec
+        if readme is not None:
+            self._values["readme"] = readme
         if renovatebot is not None:
             self._values["renovatebot"] = renovatebot
         if renovatebot_options is not None:
@@ -8111,6 +8182,12 @@ class PythonPackageOptions:
         result = self._values.get("python_exec")
         return typing.cast(typing.Optional[builtins.str], result)
 
+    @builtins.property
+    def readme(self) -> typing.Optional["ReadmeOptions"]:
+        '''Configuration of the README.md file.'''
+        result = self._values.get("readme")
+        return typing.cast(typing.Optional["ReadmeOptions"], result)
+
     @builtins.property
     def renovatebot(self) -> typing.Optional[builtins.bool]:
         '''(experimental) Use renovatebot to handle dependency upgrades.
@@ -8246,14 +8323,22 @@ class Readme(
     metaclass=jsii.JSIIMeta,
     jsii_type="projen-modules.Readme",
 ):
-    def __init__(self, project: _projen_04054675.Project) -> None:
+    def __init__(
+        self,
+        project: _projen_04054675.Project,
+        *,
+        description: typing.Optional[builtins.str] = None,
+    ) -> None:
         '''
         :param project: -
+        :param description: The description of the project.
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__5cc1200292e645dca3ec7cf2cbf9f2c41def9f24ed1dbb485999955eb69cadd7)
             check_type(argname="argument project", value=project, expected_type=type_hints["project"])
-        jsii.create(self.__class__, self, [project])
+        options = ReadmeOptions(description=description)
+
+        jsii.create(self.__class__, self, [project, options])
 
     @jsii.member(jsii_name="addSection")
     def add_section(self, title: builtins.str, body: builtins.str) -> None:
@@ -8293,6 +8378,53 @@ class Readme(
             check_type(argname="argument value", value=value, expected_type=type_hints["value"])
         jsii.set(self, "sections", value) # pyright: ignore[reportArgumentType]
 
+    @builtins.property
+    @jsii.member(jsii_name="description")
+    def description(self) -> typing.Optional[builtins.str]:
+        return typing.cast(typing.Optional[builtins.str], jsii.get(self, "description"))
+
+    @description.setter
+    def description(self, value: typing.Optional[builtins.str]) -> None:
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__3be025b008bae89967f33ac0d0514c1355ca95d6c065b6e4bf039717a4005b50)
+            check_type(argname="argument value", value=value, expected_type=type_hints["value"])
+        jsii.set(self, "description", value) # pyright: ignore[reportArgumentType]
+
+
+@jsii.data_type(
+    jsii_type="projen-modules.ReadmeOptions",
+    jsii_struct_bases=[],
+    name_mapping={"description": "description"},
+)
+class ReadmeOptions:
+    def __init__(self, *, description: typing.Optional[builtins.str] = None) -> None:
+        '''
+        :param description: The description of the project.
+        '''
+        if __debug__:
+            type_hints = typing.get_type_hints(_typecheckingstub__96a11fa5d843f4f5d45e2690ef6a6b6e0851eb4e74c4330cfe550d6b63ce62b8)
+            check_type(argname="argument description", value=description, expected_type=type_hints["description"])
+        self._values: typing.Dict[builtins.str, typing.Any] = {}
+        if description is not None:
+            self._values["description"] = description
+
+    @builtins.property
+    def description(self) -> typing.Optional[builtins.str]:
+        '''The description of the project.'''
+        result = self._values.get("description")
+        return typing.cast(typing.Optional[builtins.str], result)
+
+    def __eq__(self, rhs: typing.Any) -> builtins.bool:
+        return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+    def __ne__(self, rhs: typing.Any) -> builtins.bool:
+        return not (rhs == self)
+
+    def __repr__(self) -> str:
+        return "ReadmeOptions(%s)" % ", ".join(
+            k + "=" + repr(v) for k, v in self._values.items()
+        )
+
 
 class Section(metaclass=jsii.JSIIMeta, jsii_type="projen-modules.Section"):
     def __init__(self, options: ISectionOptions) -> None:
@@ -8323,6 +8455,7 @@ __all__ = [
     "PythonPackage",
     "PythonPackageOptions",
     "Readme",
+    "ReadmeOptions",
     "Section",
 ]
 
@@ -8468,6 +8601,7 @@ def _typecheckingstub__bcc0f0f3d874afabc142961b7ca192083fcad906385166f2e47f7e739
     pull_request_template: typing.Optional[builtins.bool] = None,
     pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
     python: typing.Optional[typing.Union[_projen_cdk_04054675.JsiiPythonTarget, typing.Dict[builtins.str, typing.Any]]] = None,
+    readme: typing.Optional[typing.Union[ReadmeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
     release: typing.Optional[builtins.bool] = None,
     release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -8513,6 +8647,12 @@ def _typecheckingstub__bcc0f0f3d874afabc142961b7ca192083fcad906385166f2e47f7e739
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__6cb7da275ba82f1b6bb477c4c22f7721642ea0759b39a4fc1874a92b34daa7eb(
+    value: Readme,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__b17dce6f2f04ceb519c781a818d66bcf4fef528d5b613028b126fd373e7b4048(
     *,
     code_owners: typing.Sequence[builtins.str],
@@ -8620,6 +8760,7 @@ def _typecheckingstub__b17dce6f2f04ceb519c781a818d66bcf4fef528d5b613028b126fd373
     publish_tasks: typing.Optional[builtins.bool] = None,
     pull_request_template: typing.Optional[builtins.bool] = None,
     pull_request_template_contents: typing.Optional[typing.Sequence[builtins.str]] = None,
+    readme: typing.Optional[typing.Union[ReadmeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     releasable_commits: typing.Optional[_projen_04054675.ReleasableCommits] = None,
     release: typing.Optional[builtins.bool] = None,
     release_branches: typing.Optional[typing.Mapping[builtins.str, typing.Union[_projen_release_04054675.BranchOptions, typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -8664,6 +8805,12 @@ def _typecheckingstub__b17dce6f2f04ceb519c781a818d66bcf4fef528d5b613028b126fd373
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__1a456e663d7da59de9fd68ca5bb5f5bc98971d99102fdb04adfe975c14215095(
+    value: Readme,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__882525f8fb69251a060fbbe97c2383313ea4b9c0269874cb1d13172a5420010c(
     *,
     author_email: builtins.str,
@@ -8715,6 +8862,7 @@ def _typecheckingstub__882525f8fb69251a060fbbe97c2383313ea4b9c0269874cb1d13172a5
     pytest: typing.Optional[builtins.bool] = None,
     pytest_options: typing.Optional[typing.Union[_projen_python_04054675.PytestOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     python_exec: typing.Optional[builtins.str] = None,
+    readme: typing.Optional[typing.Union[ReadmeOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     renovatebot: typing.Optional[builtins.bool] = None,
     renovatebot_options: typing.Optional[typing.Union[_projen_04054675.RenovatebotOptions, typing.Dict[builtins.str, typing.Any]]] = None,
     sample: typing.Optional[builtins.bool] = None,
@@ -8731,6 +8879,8 @@ def _typecheckingstub__882525f8fb69251a060fbbe97c2383313ea4b9c0269874cb1d13172a5
 
 def _typecheckingstub__5cc1200292e645dca3ec7cf2cbf9f2c41def9f24ed1dbb485999955eb69cadd7(
     project: _projen_04054675.Project,
+    *,
+    description: typing.Optional[builtins.str] = None,
 ) -> None:
     """Type checking stubs"""
     pass
@@ -8754,6 +8904,19 @@ def _typecheckingstub__b866744efc0f7f57d44f27762344fc5d2fc2a11698dc4f0fe4a59965b
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__3be025b008bae89967f33ac0d0514c1355ca95d6c065b6e4bf039717a4005b50(
+    value: typing.Optional[builtins.str],
+) -> None:
+    """Type checking stubs"""
+    pass
+
+def _typecheckingstub__96a11fa5d843f4f5d45e2690ef6a6b6e0851eb4e74c4330cfe550d6b63ce62b8(
+    *,
+    description: typing.Optional[builtins.str] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__1e42be693dde8cd80a4e05381ff22f05cb4318ab11dab8a9118ec46f997b6b78(
     options: ISectionOptions,
 ) -> None:

projen_modules/_jsii/__init__.py

@@ -32,7 +32,7 @@ import constructs._jsii
 import projen._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "projen-modules", "0.1.2", __name__[0:-6], "projen-modules@0.1.2.jsii.tgz"
+    "projen-modules", "0.1.4", __name__[0:-6], "projen-modules@0.1.4.jsii.tgz"
 )
 
 __all__ = [

{projen_modules-0.1.2.dist-info → projen_modules-0.1.4.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.1
 Name: projen_modules
-Version: 0.1.2
-Summary: projen-modules
+Version: 0.1.4
+Summary: A collection of projen modules
 Home-page: https://github.com/daveshepherd/projen-modules.git
 Author: Dave Shepherd<dave.shepherd@endor.me.uk>
 License: Apache-2.0
@@ -28,6 +28,8 @@ Requires-Dist: typeguard<4.3.0,>=2.13.3
 
 # projen-modules
 
+A collection of custom projen modules, that can be used to bootstrap and maintain consistent project configuration, tooling, dependencies, and builds.
+
 ## Getting Started
 
 ```sh

projen_modules-0.1.4.dist-info/RECORD

@@ -0,0 +1,9 @@
+projen_modules/__init__.py,sha256=ZV3aG54Sc6KfjzQbp_LIyI6r2vGMuERsj1kuo_AtLGA,517379
+projen_modules/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+projen_modules/_jsii/__init__.py,sha256=JKs2217UCnltdT_iLWdxMGzh7pE5EDmcge7pfJ09Rvs,1438
+projen_modules/_jsii/projen-modules@0.1.4.jsii.tgz,sha256=Z4d736THEvI-2aRS40zXrzykX2sdkA2jJrjTyHagSaA,138910
+projen_modules-0.1.4.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
+projen_modules-0.1.4.dist-info/METADATA,sha256=a6D1uaEOd4hC1c6A22eiOVD1Fee7OhXyapGQaQECSMQ,1391
+projen_modules-0.1.4.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
+projen_modules-0.1.4.dist-info/top_level.txt,sha256=YhmVEeu2LoZS5cqGRszYa1QjC4sk2iA12CJBzxieX8I,15
+projen_modules-0.1.4.dist-info/RECORD,,

projen_modules-0.1.2.dist-info/RECORD

@@ -1,9 +0,0 @@
-projen_modules/__init__.py,sha256=tjF5y0F8UGw0SYxW6np4SLcvNKd50et9YIxijwt28cE,510080
-projen_modules/py.typed,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
-projen_modules/_jsii/__init__.py,sha256=DXBsAagi5iKyrWhbv_x86YOiz3g15mqzIs-_vSarDHA,1438
-projen_modules/_jsii/projen-modules@0.1.2.jsii.tgz,sha256=4qV87Rovnq-tPhXEHKOTRoSxO739nMjFHeq0Qj8eBKQ,137076
-projen_modules-0.1.2.dist-info/LICENSE,sha256=z8d0m5b2O9McPEK1xHG_dWgUBT6EfBDz6wA0F7xSPTA,11358
-projen_modules-0.1.2.dist-info/METADATA,sha256=LCGY2m7AbM8lYQ0ZM7ODdO1TzBHl_4sJsniw3cm8HPM,1223
-projen_modules-0.1.2.dist-info/WHEEL,sha256=eOLhNAGa2EW3wWl_TU484h7q1UNgy0JXjjoqKoxAAQc,92
-projen_modules-0.1.2.dist-info/top_level.txt,sha256=YhmVEeu2LoZS5cqGRszYa1QjC4sk2iA12CJBzxieX8I,15
-projen_modules-0.1.2.dist-info/RECORD,,