.circleci/config.yml

@@ -37,6 +37,8 @@ jobs:
       - run:
           name: Run jest
           command: |
+            curl -LsSf https://astral.sh/uv/0.5.5/install.sh | env UV_UNMANAGED_INSTALL="$HOME/uv" sh
+            export PATH=$PATH:$HOME/uv
             npm run test:ci
           environment:
                   JEST_JUNIT_OUTPUT_DIR: ./reports/junit/

README.md

@@ -5,10 +5,13 @@
 
 ![Demo GIF](./demo.gif)
 
+To know more about the story behind Sicarator and its philosophy, you can read [this blog article](https://www.sicara.fr/blog-technique/sicarator).
+
 ## Main components of the generated project
 
 - **Python** development environment with:
-  - [Poetry](https://python-poetry.org/) for dependency management
+  - [Astral/uv](https://github.com/astral-sh/uv) (recommended) or [poetry](https://python-poetry.org/) for dependency
+    management
   - [Pytest](https://docs.pytest.org/) for testing
   - [Ruff](https://docs.astral.sh/ruff/) for static analysis & code formatting
   - [Mypy](https://mypy.readthedocs.io/) for type checking
@@ -33,15 +36,23 @@
 
 ## Requirements
 
-### Pyenv
+### Astral/uv (recommended)
+
+Install [uv](https://github.com/astral-sh/uv) to manage your Python versions, virtual environments, dependencies and
+tooling configs:
+  ```bash
+  curl -LsSf https://astral.sh/uv/install.sh | sh
+  ```
+
+### Pyenv (if not using uv)
 
 Install [pyenv](https://github.com/pyenv/pyenv) to manage your Python versions and virtual environments:
   ```bash
   curl -sSL https://pyenv.run | bash
   ```
 *If you are on MacOS and experiencing errors on Python install with PyEnv, follow this [comment](https://github.com/pyenv/pyenv/issues/1740#issuecomment-738749988)*
 
-### Poetry
+### Poetry (if not using uv)
 
 Install [Poetry](https://python-poetry.org) to manage your dependencies and tooling configs:
   ```bash

__tests__/app.js

@@ -55,6 +55,7 @@ const GCP_PROJECT_ID = "gcp-project-id";
 const GCP_REGION = "us-west1";
 
 const DEFAULT_ANSWERS = {
+  packageManager: "pyenv + poetry",
   pythonVersion: LAST_PYTHON_VERSION,
   includeApi: false,
   apiInfrastructure: null,
@@ -82,6 +83,9 @@ const GCP_INFRA_ANSWERS = {
   gcpProjectId: GCP_PROJECT_ID,
   gcpRegion: GCP_REGION
 };
+const UV_PACKAGE_MANAGER_ANSWERS = {
+  packageManager: "astral/uv"
+};
 
 describe("generator-sicarator:app", () => {
   describe.each([
@@ -133,6 +137,11 @@ describe("generator-sicarator:app", () => {
       ...ALL_OPTIONS_EXCEPT_INFRA_ANSWERS,
       ...GCP_INFRA_ANSWERS
     },
+    {
+      description: "uv package manager",
+      ...DEFAULT_ANSWERS,
+      ...UV_PACKAGE_MANAGER_ANSWERS
+    },
     {
       description: "Python 3.10 (all options & AWS infra)",
       ...DEFAULT_ANSWERS,
@@ -143,6 +152,7 @@ describe("generator-sicarator:app", () => {
   ])(
     "Generate project with $description",
     ({
+      packageManager,
       pythonVersion,
       includeApi,
       apiInfrastructure,
@@ -160,6 +170,7 @@ describe("generator-sicarator:app", () => {
           .run(path.join(__dirname, "../generators/app"))
           .withPrompts({
             projectName: PROJECT_NAME,
+            packageManager,
             pythonVersion,
             includeApi,
             apiInfrastructure,
@@ -174,51 +185,26 @@ describe("generator-sicarator:app", () => {
           })
           .withLocalConfig({})
           .on("end", () => {
-            exec("make install", (error, stdout, stderr) => {
-              if (stdout) {
-                console.log(`stdout:\n ${stdout}`);
-              }
-
-              if (stderr) {
-                console.log(`stderr:\n ${stderr}`);
-              }
-
-              if (error) {
-                done(error);
-              } else {
-                done();
-              }
-            });
+            exec("make install", defaultCallback(done));
           });
       });
 
       afterAll(done => {
-        exec(
-          `pyenv virtualenv-delete --force ${PROJECT_SLUG}`,
-          (error, stdout, stderr) => {
-            if (stdout) {
-              console.log(`stdout:\n ${stdout}`);
-            }
-
-            if (stderr) {
-              console.log(`stderr:\n ${stderr}`);
-            }
-
-            if (error) {
-              done(error);
-            } else {
-              done();
-            }
-          }
-        );
+        let cleanVirtualenvCommand =
+          packageManager === "pyenv + poetry"
+            ? `pyenv virtualenv-delete --force ${PROJECT_SLUG}`
+            : "rm -rf .venv/";
+        exec(cleanVirtualenvCommand, defaultCallback(done));
       });
 
       it("creates common files", () => {
         assert.file(COMMON_FILES_PATHS);
       });
 
-      it("creates poetry.lock", () => {
-        assert.file("poetry.lock");
+      it("creates lock file", () => {
+        let lockfile =
+          packageManager === "pyenv + poetry" ? "poetry.lock" : "uv.lock";
+        assert.file(lockfile);
       });
 
       it("creates .gitignore", () => {
@@ -294,7 +280,11 @@ describe("generator-sicarator:app", () => {
       });
 
       it("has correct Python version", () => {
-        assert.fileContent("pyproject.toml", `python = "${pythonVersion}"`);
+        if (packageManager === "pyenv + poetry") {
+          assert.fileContent("pyproject.toml", `python = "${pythonVersion}"`);
+        } else {
+          assert.fileContent("pyproject.toml", `python = "==${pythonVersion}"`);
+        }
       });
 
       it("has correct terraform backend bucket name", () => {
@@ -327,84 +317,38 @@ describe("generator-sicarator:app", () => {
 
       it("runs unit tests successfully", done => {
         if (includeHelloWorld || includeApi || includeStreamlit) {
-          execInPyenvVenv("make test", (error, stdout, stderr) => {
-            if (stdout) {
-              console.log(`stdout:\n ${stdout}`);
-            }
-
-            if (stderr) {
-              console.log(`stderr:\n ${stderr}`);
-            }
-
-            if (error) {
-              done(error);
-            } else {
-              done();
-            }
-          });
+          execInVenv("make test", packageManager, defaultCallback(done));
         } else {
           // No tests to run
           done();
         }
       });
 
       it("runs linter successfully", done => {
-        execInPyenvVenv("make lint-check", (error, stdout, stderr) => {
-          if (stdout) {
-            console.log(`stdout:\n ${stdout}`);
-          }
-
-          if (stderr) {
-            console.log(`stderr:\n ${stderr}`);
-          }
-
-          if (error) {
-            done(error);
-          } else {
-            done();
-          }
-        });
+        execInVenv("make lint-check", packageManager, defaultCallback(done));
       });
 
       it("runs type checking successfully", done => {
-        execInPyenvVenv("make type-check", (error, stdout, stderr) => {
-          if (stdout) {
-            console.log(`stdout:\n ${stdout}`);
-          }
-
-          if (stderr) {
-            console.log(`stderr:\n ${stderr}`);
-          }
-
-          if (error) {
-            done(error);
-          } else {
-            done();
-          }
-        });
+        execInVenv("make type-check", packageManager, defaultCallback(done));
       });
 
       it("runs formatting check successfully", done => {
-        execInPyenvVenv("make format-check", (error, stdout, stderr) => {
-          if (stdout) {
-            console.log(`stdout:\n ${stdout}`);
-          }
-
-          if (stderr) {
-            console.log(`stderr:\n ${stderr}`);
-          }
-
-          if (error) {
-            done(error);
-          } else {
-            done();
-          }
-        });
+        execInVenv("make format-check", packageManager, defaultCallback(done));
       });
     }
   );
 });
 
+function execInVenv(command, packageManager, callback) {
+  if (packageManager === "pyenv + poetry") {
+    execInPyenvVenv(command, callback);
+  } else {
+    exec(command, { env: { ...process.env } }, (error, stdout, stderr) => {
+      callback(error, stdout, stderr);
+    });
+  }
+}
+
 function execInPyenvVenv(command, callback) {
   // Execute 'pyenv prefix' command to get the venv path
   exec("pyenv prefix", (error, stdout, stderr) => {
@@ -436,3 +380,21 @@ function execInPyenvVenv(command, callback) {
     );
   });
 }
+
+function defaultCallback(done) {
+  return (error, stdout, stderr) => {
+    if (stdout) {
+      console.log(`stdout:\n ${stdout}`);
+    }
+
+    if (stderr) {
+      console.log(`stderr:\n ${stderr}`);
+    }
+
+    if (error) {
+      done(error);
+    } else {
+      done();
+    }
+  };
+}

generators/app/index.js

@@ -80,6 +80,28 @@ module.exports = class extends Generator {
         default: this.user.git.email(),
         store: true
       },
+      {
+        name: "packageManager",
+        message: `${mainMessage(
+          "Which package manager do you want to use?"
+        )}${infoMessage(
+          `astral/uv (${chalk.underline(
+            "https://github.com/astral-sh/uv"
+          )}) is much more powerful and simple than pyenv + poetry, but has not been tested on a project yet.`
+        )}`,
+        type: "list",
+        default: "pyenv + poetry",
+        choices: [
+          {
+            name: "pyenv + poetry",
+            value: "pyenv + poetry"
+          },
+          {
+            name: "astral/uv",
+            value: "astral/uv"
+          }
+        ]
+      },
       {
         name: "pythonVersion",
         message: `${mainMessage(
@@ -91,7 +113,7 @@ module.exports = class extends Generator {
             "https://pyreadiness.org/"
           )}.`
         )}${infoMessage(
-          "If the chosen version is not installed on your machine, it will be automatically installed by PyEnv."
+          "If the chosen version is not installed on your machine, it will be automatically installed by PyEnv or uv."
         )}`,
         type: "list",
         default: "3.11.6",
@@ -515,25 +537,35 @@ module.exports = class extends Generator {
   }
 
   install() {
-    this.spawnCommandSync("pyenv", [
-      "install",
-      this.answers.pythonVersion,
-      "--skip-existing"
-    ]);
+    if (this.answers.packageManager === "pyenv + poetry") {
+      this.spawnCommandSync("pyenv", [
+        "install",
+        this.answers.pythonVersion,
+        "--skip-existing"
+      ]);
+
+      this.log(
+        `Generating Poetry lock file in a ${chalk.cyan.italic(
+          "temporary"
+        )} virtual environment ${chalk.cyan(this.answers.projectSlug)}`
+      );
+      this.spawnCommandSync("poetry", ["lock"], {
+        env: {
+          ...process.env,
+          PYENV_VERSION: this.answers.pythonVersion, // Allow Poetry to find the correct Python version
+          POETRY_VIRTUALENVS_IN_PROJECT: 1 // Allow to easily delete the .venv, see below
+        }
+      });
+    } else {
+      this.log(
+        `Generating uv lock file in a ${chalk.cyan.italic(
+          "temporary"
+        )} virtual environment ${chalk.cyan(this.answers.projectSlug)}`
+      );
+      this.spawnCommandSync("uv", ["lock"]);
+    }
 
-    this.log(
-      `Generating Poetry lock file in a ${chalk.cyan.italic(
-        "temporary"
-      )} virtual environment ${chalk.cyan(this.answers.projectSlug)}`
-    );
-    this.spawnCommandSync("poetry", ["lock"], {
-      env: {
-        ...process.env,
-        PYENV_VERSION: this.answers.pythonVersion, // Allow Poetry to find the correct Python version
-        POETRY_VIRTUALENVS_IN_PROJECT: 1 // Allow to easily delete the .venv, see below
-      }
-    });
-    // Delete Poetry environment, because the developer will create its own Pyenv environment when installing the project
+    // Delete virtual environment, because the developer will create their own when installing the project
     this.log(
       `Deleting ${chalk.cyan.italic(
         "temporary"
@@ -542,8 +574,8 @@ module.exports = class extends Generator {
     this.log(
       infoMessage(
         `You will create a new ${chalk.bold.italic(
-          "pyenv"
-        )} environment during project installation (see generated README.md).`,
+          "virtual environment"
+        )} during project installation (see generated README.md).`,
         0,
         false
       )