Add fixed install mode and deprecate direct mode (issue #54)

This change adds support for non-editable installations to enable
production/Docker deployments while maintaining backward compatibility.

Changes:
- Add 'fixed' install mode for non-editable installations (no -e prefix)
- Add 'editable' install mode (with -e prefix) as the new default
- Deprecate 'direct' mode as alias for 'editable' with warning
- Keep 'skip' mode unchanged

Test-Driven Development approach:
- Added 4 new test configuration files
- Added 4 new configuration tests
- Added 2 new processing tests
- Updated 1 existing test for new default
- All 172 tests pass

Fixes #54

Author: jensens

src/mxdev/config.py

@@ -50,9 +50,22 @@ def __init__(
         # overlapping credential prompts)
         settings.setdefault("smart-threading", "true")
 
-        mode = settings.get("default-install-mode", "direct")
-        if mode not in ["direct", "skip"]:
-            raise ValueError("default-install-mode must be one of 'direct' or 'skip'")
+        mode = settings.get("default-install-mode", "editable")
+
+        # Handle deprecated "direct" mode
+        if mode == "direct":
+            logger.warning(
+                "install-mode 'direct' is deprecated and will be removed in a future version. "
+                "Please use 'editable' instead."
+            )
+            mode = "editable"
+            settings["default-install-mode"] = "editable"
+
+        if mode not in ["editable", "fixed", "skip"]:
+            raise ValueError(
+                "default-install-mode must be one of 'editable', 'fixed', or 'skip' "
+                "('direct' is deprecated, use 'editable')"
+            )
 
         default_use = to_bool(settings.get("default-use", True))
         raw_overrides = settings.get("version-overrides", "").strip()
@@ -108,9 +121,21 @@ def is_ns_member(name) -> bool:
             package.setdefault("path", os.path.join(package["target"], name))
             if not package.get("url"):
                 raise ValueError(f"Section {name} has no URL set!")
-            if package.get("install-mode") not in ["direct", "skip"]:
+
+            # Handle deprecated "direct" mode for per-package install-mode
+            pkg_mode = package.get("install-mode")
+            if pkg_mode == "direct":
+                logger.warning(
+                    f"install-mode 'direct' is deprecated and will be removed in a future version. "
+                    f"Please use 'editable' instead (package: {name})."
+                )
+                package["install-mode"] = "editable"
+                pkg_mode = "editable"
+
+            if pkg_mode not in ["editable", "fixed", "skip"]:
                 raise ValueError(
-                    f"install-mode in [{name}] must be one of 'direct' or 'skip'"
+                    f"install-mode in [{name}] must be one of 'editable', 'fixed', or 'skip' "
+                    f"('direct' is deprecated, use 'editable')"
                 )
 
             # repo_dir = os.path.abspath(f"{package['target']}/{name}")

src/mxdev/processing.py

@@ -220,9 +220,13 @@ def write_dev_sources(fio, packages: typing.Dict[str, typing.Dict[str, typing.An
             continue
         extras = f"[{package['extras']}]" if package["extras"] else ""
         subdir = f"/{package['subdirectory']}" if package["subdirectory"] else ""
-        editable = f"""-e ./{package['target']}/{name}{subdir}{extras}\n"""
-        logger.debug(f"-> {editable.strip()}")
-        fio.write(editable)
+
+        # Add -e prefix only for 'editable' mode (not for 'fixed')
+        prefix = "-e " if package["install-mode"] == "editable" else ""
+        install_line = f"""{prefix}./{package['target']}/{name}{subdir}{extras}\n"""
+
+        logger.debug(f"-> {install_line.strip()}")
+        fio.write(install_line)
     fio.write("\n\n")
 
 

tests/data/config_samples/config_deprecated_direct.ini

@@ -0,0 +1,5 @@
+[settings]
+default-install-mode = direct
+
+[example.package]
+url = git+https://github.com/example/package.git

tests/data/config_samples/config_editable_mode.ini

@@ -0,0 +1,5 @@
+[settings]
+default-install-mode = editable
+
+[example.package]
+url = git+https://github.com/example/package.git

tests/data/config_samples/config_fixed_mode.ini

@@ -0,0 +1,5 @@
+[settings]
+default-install-mode = fixed
+
+[example.package]
+url = git+https://github.com/example/package.git

tests/data/config_samples/config_package_direct.ini

@@ -0,0 +1,6 @@
+[settings]
+default-install-mode = editable
+
+[example.package]
+url = git+https://github.com/example/package.git
+install-mode = direct

tests/test_config.py

@@ -89,12 +89,72 @@ def test_configuration_with_ignores():
     assert "another.ignored" in config.ignore_keys
 
 
+def test_configuration_editable_install_mode():
+    """Test Configuration with editable install mode."""
+    from mxdev.config import Configuration
+
+    base = pathlib.Path(__file__).parent / "data" / "config_samples"
+    config = Configuration(str(base / "config_editable_mode.ini"))
+
+    assert config.settings["default-install-mode"] == "editable"
+    assert config.packages["example.package"]["install-mode"] == "editable"
+
+
+def test_configuration_fixed_install_mode():
+    """Test Configuration with fixed install mode."""
+    from mxdev.config import Configuration
+
+    base = pathlib.Path(__file__).parent / "data" / "config_samples"
+    config = Configuration(str(base / "config_fixed_mode.ini"))
+
+    assert config.settings["default-install-mode"] == "fixed"
+    assert config.packages["example.package"]["install-mode"] == "fixed"
+
+
+def test_configuration_direct_mode_deprecated(caplog):
+    """Test Configuration with deprecated 'direct' mode logs warning."""
+    from mxdev.config import Configuration
+
+    base = pathlib.Path(__file__).parent / "data" / "config_samples"
+    config = Configuration(str(base / "config_deprecated_direct.ini"))
+
+    # Mode should be treated as 'editable' internally
+    assert config.settings["default-install-mode"] == "editable"
+    assert config.packages["example.package"]["install-mode"] == "editable"
+
+    # Should have logged deprecation warning
+    assert any(
+        "install-mode 'direct' is deprecated" in record.message
+        for record in caplog.records
+    )
+
+
+def test_configuration_package_direct_mode_deprecated(caplog):
+    """Test per-package 'direct' mode logs deprecation warning."""
+    from mxdev.config import Configuration
+
+    base = pathlib.Path(__file__).parent / "data" / "config_samples"
+    config = Configuration(str(base / "config_package_direct.ini"))
+
+    # Package mode should be treated as 'editable' internally
+    assert config.packages["example.package"]["install-mode"] == "editable"
+
+    # Should have logged deprecation warning
+    assert any(
+        "install-mode 'direct' is deprecated" in record.message
+        for record in caplog.records
+    )
+
+
 def test_configuration_invalid_default_install_mode():
     """Test Configuration with invalid default-install-mode."""
     from mxdev.config import Configuration
 
     base = pathlib.Path(__file__).parent / "data" / "config_samples"
-    with pytest.raises(ValueError, match="default-install-mode must be one of"):
+    with pytest.raises(
+        ValueError,
+        match=r"default-install-mode must be one of 'editable', 'fixed', or 'skip'",
+    ):
         Configuration(str(base / "config_invalid_mode.ini"))
 
 
@@ -103,7 +163,10 @@ def test_configuration_invalid_package_install_mode():
     from mxdev.config import Configuration
 
     base = pathlib.Path(__file__).parent / "data" / "config_samples"
-    with pytest.raises(ValueError, match="install-mode in .* must be one of"):
+    with pytest.raises(
+        ValueError,
+        match=r"install-mode in .* must be one of 'editable', 'fixed', or 'skip'",
+    ):
         Configuration(str(base / "config_package_invalid_mode.ini"))
 
 
@@ -182,7 +245,7 @@ def test_configuration_package_defaults():
     assert pkg["extras"] == ""
     assert pkg["subdirectory"] == ""
     assert pkg["target"] == "sources"  # default-target not set, should be "sources"
-    assert pkg["install-mode"] == "direct"  # default mode
+    assert pkg["install-mode"] == "editable"  # default mode changed from 'direct'
     assert pkg["vcs"] == "git"
     assert "path" in pkg
 

tests/test_processing.py

@@ -215,7 +215,7 @@ def test_write_dev_sources(tmp_path):
             "target": "sources",
             "extras": "",
             "subdirectory": "",
-            "install-mode": "direct",
+            "install-mode": "editable",
         },
         "skip.package": {
             "target": "sources",
@@ -227,7 +227,7 @@ def test_write_dev_sources(tmp_path):
             "target": "sources",
             "extras": "test,docs",
             "subdirectory": "packages/core",
-            "install-mode": "direct",
+            "install-mode": "editable",
         },
     }
 
@@ -241,6 +241,76 @@ def test_write_dev_sources(tmp_path):
     assert "-e ./sources/extras.package/packages/core[test,docs]" in content
 
 
+def test_write_dev_sources_fixed_mode(tmp_path):
+    """Test write_dev_sources with fixed install mode (no -e prefix)."""
+    from mxdev.processing import write_dev_sources
+
+    packages = {
+        "fixed.package": {
+            "target": "sources",
+            "extras": "",
+            "subdirectory": "",
+            "install-mode": "fixed",
+        },
+        "fixed.with.extras": {
+            "target": "sources",
+            "extras": "test",
+            "subdirectory": "packages/core",
+            "install-mode": "fixed",
+        },
+    }
+
+    outfile = tmp_path / "requirements.txt"
+    with open(outfile, "w") as fio:
+        write_dev_sources(fio, packages)
+
+    content = outfile.read_text()
+    # Fixed mode should NOT have -e prefix
+    assert "./sources/fixed.package" in content
+    assert "-e ./sources/fixed.package" not in content
+    assert "./sources/fixed.with.extras/packages/core[test]" in content
+    assert "-e ./sources/fixed.with.extras/packages/core[test]" not in content
+
+
+def test_write_dev_sources_mixed_modes(tmp_path):
+    """Test write_dev_sources with mixed install modes."""
+    from mxdev.processing import write_dev_sources
+
+    packages = {
+        "editable.package": {
+            "target": "sources",
+            "extras": "",
+            "subdirectory": "",
+            "install-mode": "editable",
+        },
+        "fixed.package": {
+            "target": "sources",
+            "extras": "",
+            "subdirectory": "",
+            "install-mode": "fixed",
+        },
+        "skip.package": {
+            "target": "sources",
+            "extras": "",
+            "subdirectory": "",
+            "install-mode": "skip",
+        },
+    }
+
+    outfile = tmp_path / "requirements.txt"
+    with open(outfile, "w") as fio:
+        write_dev_sources(fio, packages)
+
+    content = outfile.read_text()
+    # Editable should have -e prefix
+    assert "-e ./sources/editable.package" in content
+    # Fixed should NOT have -e prefix
+    assert "./sources/fixed.package" in content
+    assert "-e ./sources/fixed.package" not in content
+    # Skip should not appear at all
+    assert "skip.package" not in content
+
+
 def test_write_dev_sources_empty():
     """Test write_dev_sources with no packages."""
     from mxdev.processing import write_dev_sources