fix(type-safe-api): add empty README.md to initial install for genera…

…ted python projects

The poetry install that runs as part of post synthesis expects there to be some
code present, but code isn't generated until build time. This means that the
first install will fail when either generating the project for the first time or
checking out a fresh copy (since generated code is not checked in to version
control).

To fix this, we add a blank README.md file in addition to the __init__.py file
as the first install step to keep poetry happy until the generator overwrites
it.

Fixes aws#813

packages/type-safe-api/src/project/codegen/infrastructure/cdk/generated-python-cdk-infrastructure-base-project.ts

@@ -120,13 +120,13 @@ export abstract class GeneratedPythonCdkInfrastructureBaseProject extends Python
     // The poetry install that runs as part of post synthesis expects there to be some code present, but code isn't
     // generated until build time. This means that the first install will fail when either generating the project for
     // the first time or checking out a fresh copy (since generated code is not checked in to version control). We
-    // therefore add a blank __init__.py as our first install step to keep poetry happy until the generator overwrites
-    // it.
+    // therefore add a blank __init__.py and README.md as our first install step to keep poetry happy until the
+    // generator overwrites it.
     ["install", "install:ci"].forEach((t) =>
       this.tasks
         .tryFind(t)
         ?.prependExec(
-          `mkdir -p ${this.moduleName} && touch ${this.moduleName}/__init__.py`
+          `mkdir -p ${this.moduleName} && touch ${this.moduleName}/__init__.py README.md`
         )
     );
   }

packages/type-safe-api/src/project/codegen/runtime/generated-python-runtime-base-project.ts

@@ -113,13 +113,13 @@ export abstract class GeneratedPythonRuntimeBaseProject extends PythonProject {
     // The poetry install that runs as part of post synthesis expects there to be some code present, but code isn't
     // generated until build time. This means that the first install will fail when either generating the project for
     // the first time or checking out a fresh copy (since generated code is not checked in to version control). We
-    // therefore add a blank __init__.py as our first install step to keep poetry happy until the generator overwrites
-    // it.
+    // therefore add a blank __init__.py and README.md as our first install step to keep poetry happy until the
+    // generator overwrites it.
     ["install", "install:ci"].forEach((t) =>
       this.tasks
         .tryFind(t)
         ?.prependExec(
-          `mkdir -p ${this.moduleName} && touch ${this.moduleName}/__init__.py`
+          `mkdir -p ${this.moduleName} && touch ${this.moduleName}/__init__.py README.md`
         )
     );
   }