feat: add --qe flag to dbx project add with --wagtail stacking

Adds --qe/-q to configure Queryable Encryption automatically on project
creation, mirroring the --wagtail flag. Stacking --qe --wagtail selects
medical_records.wagtail instead of medical_records.django in QE_INSTALLED_APPS.
pymongocrypt is added to main dependencies when --qe is used.

Author: aclark4life

src/dbx_python_cli/commands/project.py

@@ -231,6 +231,12 @@ def add_project(
         "-w/-W",
         help="Enable Wagtail CMS (default: False)",
     ),
+    add_qe: bool = typer.Option(
+        False,
+        "--qe/--no-qe",
+        "-q/-Q",
+        help="Enable Queryable Encryption (default: False)",
+    ),
     auto_install: bool = typer.Option(
         True,
         "--install/--no-install",
@@ -246,20 +252,23 @@ def add_project(
     """
     Create a new Django project using bundled templates.
     Frontend is added by default. Use --no-frontend to skip frontend creation.
-    Use --wagtail to enable Wagtail CMS.
+    Use --wagtail to enable Wagtail CMS. Use --qe to enable Queryable Encryption.
+    Flags can be stacked: --qe --wagtail enables a Wagtail site with QE.
 
     Projects are created in base_dir/projects/ by default.
     If no name is provided, a random name is generated.
 
     Examples::
 
-        dbx project add                    # Create with random name (includes frontend)
-        dbx project add myproject          # Create with explicit name (includes frontend)
+        dbx project add                          # Create with random name (includes frontend)
+        dbx project add myproject                # Create with explicit name (includes frontend)
         dbx project add myproject --no-frontend  # Create without frontend
         dbx project add myproject --wagtail      # Create with Wagtail CMS enabled
-        dbx project add -d ~/custom/path   # Create with random name in custom directory
-        dbx project add myproject -d ~/custom/path  # Create in custom directory
-        dbx project add myproject --base-dir ~/path/to/myproject  # Create directly at ~/path/to/myproject
+        dbx project add myproject --qe           # Create with Queryable Encryption enabled
+        dbx project add myproject --qe --wagtail # Create with QE + Wagtail
+        dbx project add -d ~/custom/path         # Create with random name in custom directory
+        dbx project add myproject -d ~/custom/path        # Create in custom directory
+        dbx project add myproject --base-dir ~/path/to/myproject  # Create directly at path
     """
     # Normalize parameters when called programmatically (not via CLI).
     # When called directly, typer.Option/Argument defaults are OptionInfo/ArgumentInfo objects.
@@ -273,6 +282,8 @@ def add_project(
         add_frontend = True
     if not isinstance(add_wagtail, bool):
         add_wagtail = False
+    if not isinstance(add_qe, bool):
+        add_qe = False
     if not isinstance(auto_install, bool):
         auto_install = True
     if not isinstance(python_path_override, (str, type(None))):
@@ -453,7 +464,9 @@ def add_project(
         raise typer.Exit(code=1)
 
     # Add pyproject.toml after project creation
-    _create_pyproject_toml(project_path, name, settings_path, wagtail=add_wagtail)
+    _create_pyproject_toml(
+        project_path, name, settings_path, wagtail=add_wagtail, qe=add_qe
+    )
 
     # Enable Wagtail CMS if requested
     if add_wagtail:
@@ -466,6 +479,17 @@ def add_project(
                 err=True,
             )
 
+    # Enable Queryable Encryption if requested
+    if add_qe:
+        typer.echo(f"🔐 Enabling Queryable Encryption for project '{name}'...")
+        try:
+            _enable_qe(project_path, name, wagtail=add_wagtail)
+        except Exception as e:
+            typer.echo(
+                f"⚠️  Project created successfully, but QE setup failed: {e}",
+                err=True,
+            )
+
     # Create frontend by default (unless --no-frontend is specified)
     if add_frontend:
         typer.echo(f"🎨 Adding frontend to project '{name}'...")
@@ -711,6 +735,7 @@ def _create_pyproject_toml(
     project_name: str,
     settings_path: str = "settings.base",
     wagtail: bool = False,
+    qe: bool = False,
 ):
     """Create a pyproject.toml file for the Django project."""
     base_deps = [
@@ -721,6 +746,8 @@ def _create_pyproject_toml(
     ]
     if wagtail:
         base_deps.append('"wagtail"')
+    if qe:
+        base_deps.append('"pymongocrypt"')
     deps_str = ",\n    ".join(base_deps)
 
     pyproject_content = f"""[build-system]
@@ -814,6 +841,30 @@ def _enable_wagtail(project_path: Path, project_name: str) -> None:
             f.write(wagtail_block)
 
 
+def _enable_qe(project_path: Path, project_name: str, wagtail: bool = False) -> None:
+    """Uncomment the QE block in settings and select the correct medical_records app."""
+    settings_file = project_path / project_name / "settings" / f"{project_name}.py"
+    if settings_file.exists():
+        content = settings_file.read_text()
+        content = content.replace(
+            "# from .qe import *  # noqa\n"
+            "# INSTALLED_APPS += QE_INSTALLED_APPS  # noqa: F405",
+            "from .qe import *  # noqa\n"
+            "INSTALLED_APPS += QE_INSTALLED_APPS  # noqa: F405",
+        )
+        settings_file.write_text(content)
+
+    if wagtail:
+        qe_settings_file = project_path / project_name / "settings" / "qe.py"
+        if qe_settings_file.exists():
+            qe_content = qe_settings_file.read_text()
+            qe_content = qe_content.replace(
+                '"medical_records.django"',
+                '"medical_records.wagtail"',
+            )
+            qe_settings_file.write_text(qe_content)
+
+
 def _setup_wagtail_initial_data(
     python_path: str,
     proj,

src/dbx_python_cli/templates/project_template/project_name/settings/qe.py

@@ -3,7 +3,7 @@
 from pymongo.encryption_options import AutoEncryptionOpts
 
 QE_INSTALLED_APPS = [
-    "medical_records",
+    "medical_records.django",
 ]
 
 DATABASES = {

tests/test_project_command.py

@@ -479,4 +479,100 @@ def test_project_run_uses_django_group_venv(tmp_path):
                         call_args = call[0][0]
                         if len(call_args) > 1 and "manage.py" in str(call_args):
                             assert "django/.venv" in call_args[0]
-                            break
+
+
+def test_project_add_help_shows_qe():
+    """Test that the project add help shows the --qe flag."""
+    result = runner.invoke(app, ["project", "add", "--help"])
+    assert result.exit_code == 0
+    output = strip_ansi(result.stdout)
+    assert "--qe" in output
+
+
+def test_enable_qe_activates_settings(tmp_path):
+    """Test that _enable_qe uncomments the QE settings block."""
+    from dbx_python_cli.commands.project import _enable_qe
+
+    settings_dir = tmp_path / "myproject" / "settings"
+    settings_dir.mkdir(parents=True)
+    settings_file = settings_dir / "myproject.py"
+    settings_file.write_text(
+        "# Queryable Encryption (QE) Configuration\n"
+        "# Uncomment the two lines below to enable Queryable Encryption settings.\n"
+        "# from .qe import *  # noqa\n"
+        "# INSTALLED_APPS += QE_INSTALLED_APPS  # noqa: F405\n"
+    )
+    (settings_dir / "qe.py").write_text(
+        'QE_INSTALLED_APPS = ["medical_records.django"]\n'
+    )
+
+    _enable_qe(tmp_path, "myproject")
+
+    content = settings_file.read_text()
+    assert "# from .qe import *" not in content
+    assert "from .qe import *  # noqa" in content
+    assert "INSTALLED_APPS += QE_INSTALLED_APPS  # noqa: F405" in content
+
+
+def test_enable_qe_uses_django_app_by_default(tmp_path):
+    """Test that _enable_qe leaves medical_records.django when wagtail=False."""
+    from dbx_python_cli.commands.project import _enable_qe
+
+    settings_dir = tmp_path / "myproject" / "settings"
+    settings_dir.mkdir(parents=True)
+    (settings_dir / "myproject.py").write_text(
+        "# from .qe import *  # noqa\n"
+        "# INSTALLED_APPS += QE_INSTALLED_APPS  # noqa: F405\n"
+    )
+    qe_file = settings_dir / "qe.py"
+    qe_file.write_text('QE_INSTALLED_APPS = ["medical_records.django"]\n')
+
+    _enable_qe(tmp_path, "myproject", wagtail=False)
+
+    assert '"medical_records.django"' in qe_file.read_text()
+
+
+def test_enable_qe_uses_wagtail_app_when_stacked(tmp_path):
+    """Test that _enable_qe replaces app with medical_records.wagtail when wagtail=True."""
+    from dbx_python_cli.commands.project import _enable_qe
+
+    settings_dir = tmp_path / "myproject" / "settings"
+    settings_dir.mkdir(parents=True)
+    (settings_dir / "myproject.py").write_text(
+        "# from .qe import *  # noqa\n"
+        "# INSTALLED_APPS += QE_INSTALLED_APPS  # noqa: F405\n"
+    )
+    qe_file = settings_dir / "qe.py"
+    qe_file.write_text('QE_INSTALLED_APPS = ["medical_records.django"]\n')
+
+    _enable_qe(tmp_path, "myproject", wagtail=True)
+
+    qe_content = qe_file.read_text()
+    assert '"medical_records.wagtail"' in qe_content
+    assert '"medical_records.django"' not in qe_content
+
+
+def test_create_pyproject_toml_includes_pymongocrypt_when_qe(tmp_path):
+    """Test that _create_pyproject_toml adds pymongocrypt to dependencies when qe=True."""
+    from dbx_python_cli.commands.project import _create_pyproject_toml
+
+    _create_pyproject_toml(tmp_path, "myproject", qe=True)
+
+    content = (tmp_path / "pyproject.toml").read_text()
+    deps_section = content[
+        content.index("dependencies") : content.index("[project.optional-dependencies]")
+    ]
+    assert '"pymongocrypt"' in deps_section
+
+
+def test_create_pyproject_toml_excludes_pymongocrypt_by_default(tmp_path):
+    """Test that _create_pyproject_toml does not add pymongocrypt by default."""
+    from dbx_python_cli.commands.project import _create_pyproject_toml
+
+    _create_pyproject_toml(tmp_path, "myproject")
+
+    content = (tmp_path / "pyproject.toml").read_text()
+    deps_section = content[
+        content.index("dependencies") : content.index("[project.optional-dependencies]")
+    ]
+    assert '"pymongocrypt"' not in deps_section