plain.dev 0.32.0__tar.gz → 0.33.0__tar.gz

{plain_dev-0.32.0 → plain_dev-0.33.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.dev
-Version: 0.32.0
+Version: 0.33.0
 Summary: Local development tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
@@ -10,7 +10,6 @@ Requires-Dist: click>=8.0.0
 Requires-Dist: gunicorn>20
 Requires-Dist: inotify
 Requires-Dist: plain<1.0.0
-Requires-Dist: psycopg[binary]~=3.2.2
 Requires-Dist: python-dotenv~=1.0.0
 Requires-Dist: requests>=2.0.0
 Requires-Dist: rich
@@ -26,6 +25,7 @@ The `plain.dev` package can be [installed from PyPI](https://pypi.org/project/pl
 
 - [`plain dev`](#plain-dev)
 - [`plain dev services`](#plain-dev-services)
+- [`plain dev logs`](#plain-dev-logs)
 - [`plain pre-commit`](#plain-pre-commit)
 - [`plain contrib`](#plain-contrib)
 - [VS Code debugging](#vscode-debugging)
@@ -62,12 +62,26 @@ Unlike [services](#services), custom processes are _only_ run during `plain dev`
 ```toml
 # pyproject.toml
 [tool.plain.dev.run]
-ngrok = {command = "ngrok http $PORT"}
+    ngrok = {command = "ngrok http $PORT"}
 ```
 
 ## `plain dev services`
 
 Starts your [services](#services) by themselves.
+Logs are stored in `.plain/dev/logs/services/`.
+
+## `plain dev logs`
+
+Show output from recent `plain dev` runs.
+
+Logs are stored in `.plain/dev/logs/run/`.
+
+```bash
+plain dev logs        # print last log
+plain dev logs -f     # follow the latest log
+plain dev logs --pid 1234
+plain dev logs --path
+```
 
 ## `plain pre-commit`
 

plain_dev-0.33.0/plain/dev/CHANGELOG.md

@@ -0,0 +1,39 @@
+# plain-dev changelog
+
+## [0.33.0](https://github.com/dropseed/plain/releases/plain-dev@0.33.0) (2025-07-18)
+
+### What's changed
+
+- Added automatic background startup of dev services when running `plain dev` commands. Services defined in `pyproject.toml` will now start automatically ([0a5ffc6de5](https://github.com/dropseed/plain/commit/0a5ffc6de5)).
+- Added `plain dev logs` command to view output from recent `plain dev` runs. Supports options like `--follow`, `--pid`, `--path`, and `--services` to manage and view different log outputs ([0a5ffc6de5](https://github.com/dropseed/plain/commit/0a5ffc6de5)).
+- Added `--start` and `--stop` flags to both `plain dev` and `plain dev services` commands for running processes in the background. Use `plain dev --start` to launch the dev server in background mode and `plain dev --stop` to terminate it ([0a5ffc6de5](https://github.com/dropseed/plain/commit/0a5ffc6de5)).
+- Improved process management with better PID tracking and graceful shutdown handling for both dev server and services ([0a5ffc6de5](https://github.com/dropseed/plain/commit/0a5ffc6de5)).
+- Improved CLI error handling by using `click.UsageError` instead of manual error printing and `sys.exit()` ([88f06c5184](https://github.com/dropseed/plain/commit/88f06c5184)).
+- Removed `psycopg[binary]` dependency from plain-dev as database drivers should be installed separately based on project needs ([63224001c9](https://github.com/dropseed/plain/commit/63224001c9)).
+
+### Upgrade instructions
+
+- No changes required
+
+## [0.32.1](https://github.com/dropseed/plain/releases/plain-dev@0.32.1) (2025-06-27)
+
+### What's changed
+
+- Fixed an error when running `plain dev precommit` (or the `plain precommit` helper) that passed an extra `default` argument to `plain preflight --database`. The flag now correctly aligns with the current `plain preflight` CLI ([db65930](https://github.com/dropseed/plain/commit/db659304129a453676c0dcc20c13b606254ce1c2)).
+
+### Upgrade instructions
+
+- No changes required.
+
+## [0.32.0](https://github.com/dropseed/plain/releases/plain-dev@0.32.0) (2025-06-23)
+
+### What's changed
+
+- `plain dev` now writes a PID file and will refuse to start if it detects that another `plain dev` instance is already running in the same project ([75b7a50](https://github.com/dropseed/plain/commit/75b7a505ae3c60675099ffd440f35cf8f30665da)).
+- When no `--port` is provided, `plain dev` now checks if port 8443 is available and, if not, automatically selects the next free port. Supplying `--port` will error if that port is already in use ([3f5141f](https://github.com/dropseed/plain/commit/3f5141f54a65455f5784ed3f97be2d153ed10a23)).
+- The development request-log UI has been removed for now, along with its related endpoints and templates ([8ac6f71](https://github.com/dropseed/plain/commit/8ac6f7170efa72e6069bae3cc91809b5fe0f8a7d)).
+- `plain contrib --all` skips any installed `plainx-*` packages instead of erroring when it can’t locate their repository ([3a26aee](https://github.com/dropseed/plain/commit/3a26aee25e586a66e02a348aa24ee6e048ea0b71)).
+
+### Upgrade instructions
+
+- No changes required.

{plain_dev-0.32.0 → plain_dev-0.33.0}/plain/dev/README.md

@@ -8,6 +8,7 @@ The `plain.dev` package can be [installed from PyPI](https://pypi.org/project/pl
 
 - [`plain dev`](#plain-dev)
 - [`plain dev services`](#plain-dev-services)
+- [`plain dev logs`](#plain-dev-logs)
 - [`plain pre-commit`](#plain-pre-commit)
 - [`plain contrib`](#plain-contrib)
 - [VS Code debugging](#vscode-debugging)
@@ -44,12 +45,26 @@ Unlike [services](#services), custom processes are _only_ run during `plain dev`
 ```toml
 # pyproject.toml
 [tool.plain.dev.run]
-ngrok = {command = "ngrok http $PORT"}
+    ngrok = {command = "ngrok http $PORT"}
 ```
 
 ## `plain dev services`
 
 Starts your [services](#services) by themselves.
+Logs are stored in `.plain/dev/logs/services/`.
+
+## `plain dev logs`
+
+Show output from recent `plain dev` runs.
+
+Logs are stored in `.plain/dev/logs/run/`.
+
+```bash
+plain dev logs        # print last log
+plain dev logs -f     # follow the latest log
+plain dev logs --pid 1234
+plain dev logs --path
+```
 
 ## `plain pre-commit`
 

plain_dev-0.33.0/plain/dev/cli.py

@@ -0,0 +1,283 @@
+import os
+import subprocess
+import sys
+import time
+from importlib.metadata import entry_points
+
+import click
+
+from plain.cli import register_cli
+from plain.runtime import APP_PATH, PLAIN_TEMP_PATH
+
+from .core import ENTRYPOINT_GROUP, DevProcess
+from .services import ServicesProcess
+
+
+class DevGroup(click.Group):
+    """Custom group that ensures *services* are running on CLI startup."""
+
+    def __init__(self, *args, **kwargs):
+        super().__init__(*args, **kwargs)
+        self._auto_start_services()
+
+    @staticmethod
+    def _auto_start_services():
+        """Start dev *services* in the background if not already running."""
+
+        if os.environ.get("PLAIN_DEV_SERVICES_AUTO", "true") not in [
+            "1",
+            "true",
+            "yes",
+        ]:
+            return
+
+        # Don't do anything if it looks like a "services" command is being run explicitly
+        if "services" in sys.argv or "--stop" in sys.argv:
+            return
+
+        if not ServicesProcess.get_services(APP_PATH.parent):
+            return
+
+        if ServicesProcess.running_pid():
+            return
+
+        click.secho(
+            "Starting background dev services (terminate with `plain dev --stop`)...",
+            dim=True,
+        )
+
+        subprocess.Popen(
+            [sys.executable, "-m", "plain", "dev", "services", "--start"],
+            start_new_session=True,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+
+        time.sleep(0.5)  # Give it a moment to start
+
+        # If it's already dead, show the output and quit
+        if not ServicesProcess.running_pid():
+            click.secho(
+                "Failed to start dev services. Here are the logs:",
+                fg="red",
+            )
+            subprocess.run(
+                ["plain", "dev", "logs", "--services"],
+                check=False,
+            )
+            sys.exit(1)
+
+
+@register_cli("dev")
+@click.group(cls=DevGroup, invoke_without_command=True)
+@click.pass_context
+@click.option(
+    "--port",
+    "-p",
+    default="",
+    type=str,
+    help=(
+        "Port to run the web server on. "
+        "If omitted, tries 8443 and picks the next free port."
+    ),
+)
+@click.option(
+    "--hostname",
+    "-h",
+    default=None,
+    type=str,
+    help="Hostname to run the web server on",
+)
+@click.option(
+    "--log-level",
+    "-l",
+    default="",
+    type=click.Choice(["debug", "info", "warning", "error", "critical", ""]),
+    help="Log level",
+)
+@click.option(
+    "--start",
+    is_flag=True,
+    default=False,
+    help="Start in the background",
+)
+@click.option(
+    "--stop",
+    is_flag=True,
+    default=False,
+    help="Stop the background process",
+)
+def cli(ctx, port, hostname, log_level, start, stop):
+    """Start local development"""
+
+    if ctx.invoked_subcommand:
+        return
+
+    if start and stop:
+        raise click.UsageError(
+            "You cannot use both --start and --stop at the same time."
+        )
+
+    os.environ["PLAIN_DEV_SERVICES_AUTO"] = "false"
+
+    dev = DevProcess()
+
+    if stop:
+        if ServicesProcess.running_pid():
+            ServicesProcess().stop_process()
+            click.secho("Services stopped.", fg="green")
+
+        if not dev.running_pid():
+            click.secho("No development server running.", fg="yellow")
+            return
+
+        dev.stop_process()
+        click.secho("Development server stopped.", fg="green")
+        return
+
+    if running_pid := dev.running_pid():
+        click.secho(f"`plain dev` already running (pid={running_pid})", fg="yellow")
+        sys.exit(1)
+
+    if start:
+        args = [sys.executable, "-m", "plain", "dev"]
+        if port:
+            args.extend(["--port", port])
+        if hostname:
+            args.extend(["--hostname", hostname])
+        if log_level:
+            args.extend(["--log-level", log_level])
+
+        result = subprocess.Popen(
+            args=args,
+            start_new_session=True,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+        click.secho(
+            f"Development server started in the background (pid={result.pid}).",
+            fg="green",
+        )
+        return
+
+    dev.setup(port=port, hostname=hostname, log_level=log_level)
+    returncode = dev.run()
+    if returncode:
+        sys.exit(returncode)
+
+
+@cli.command()
+def debug():
+    """Connect to the remote debugger"""
+
+    def _connect():
+        if subprocess.run(["which", "nc"], capture_output=True).returncode == 0:
+            return subprocess.run(["nc", "-C", "localhost", "4444"])
+        else:
+            raise OSError("nc not found")
+
+    result = _connect()
+
+    # Try again once without a message
+    if result.returncode == 1:
+        time.sleep(1)
+        result = _connect()
+
+    # Keep trying...
+    while result.returncode == 1:
+        click.secho(
+            "Failed to connect. Make sure remote pdb is ready. Retrying...", fg="red"
+        )
+        result = _connect()
+        time.sleep(1)
+
+
+@cli.command()
+@click.option("--start", is_flag=True, help="Start in the background")
+@click.option("--stop", is_flag=True, help="Stop the background process")
+def services(start, stop):
+    """Start additional services defined in pyproject.toml"""
+
+    if start and stop:
+        raise click.UsageError(
+            "You cannot use both --start and --stop at the same time."
+        )
+
+    if stop:
+        if not ServicesProcess.running_pid():
+            click.secho("No services running.", fg="yellow")
+            return
+        ServicesProcess().stop_process()
+        click.secho("Services stopped.", fg="green")
+        return
+
+    if running_pid := ServicesProcess.running_pid():
+        click.secho(f"Services already running (pid={running_pid})", fg="yellow")
+        sys.exit(1)
+
+    if start:
+        result = subprocess.Popen(
+            args=[sys.executable, "-m", "plain", "dev", "services"],
+            start_new_session=True,
+            stdout=subprocess.DEVNULL,
+            stderr=subprocess.DEVNULL,
+        )
+        click.secho(
+            f"Services started in the background (pid={result.pid}).", fg="green"
+        )
+        return
+
+    ServicesProcess().run()
+
+
+@cli.command()
+@click.option("--follow", "-f", is_flag=True, help="Follow log output")
+@click.option("--pid", type=int, help="PID to show logs for")
+@click.option("--path", is_flag=True, help="Output log file path")
+@click.option("--services", is_flag=True, help="Show logs for services")
+def logs(follow, pid, path, services):
+    """Show logs from recent plain dev runs."""
+
+    if services:
+        log_dir = PLAIN_TEMP_PATH / "dev" / "logs" / "services"
+    else:
+        log_dir = PLAIN_TEMP_PATH / "dev" / "logs" / "run"
+
+    if pid:
+        log_path = log_dir / f"{pid}.log"
+        if not log_path.exists():
+            click.secho(f"No log found for pid {pid}", fg="red")
+            return
+    else:
+        logs = sorted(log_dir.glob("*.log"), key=lambda p: p.stat().st_mtime)
+        if not logs:
+            click.secho("No logs found", fg="yellow")
+            return
+        log_path = logs[-1]
+
+    if path:
+        click.echo(str(log_path))
+        return
+
+    if follow:
+        subprocess.run(["tail", "-f", str(log_path)])
+    else:
+        with log_path.open() as f:
+            click.echo(f.read())
+
+
+@cli.command()
+@click.option(
+    "--list", "-l", "show_list", is_flag=True, help="List available entrypoints"
+)
+@click.argument("entrypoint", required=False)
+def entrypoint(show_list, entrypoint):
+    """Entrypoints registered under plain.dev"""
+    if not show_list and not entrypoint:
+        raise click.UsageError("Please provide an entrypoint name or use --list")
+
+    for entry_point in entry_points().select(group=ENTRYPOINT_GROUP):
+        if show_list:
+            click.echo(entry_point.name)
+        elif entrypoint == entry_point.name:
+            entry_point.load()()

{plain_dev-0.32.0 → plain_dev-0.33.0}/plain/dev/contribute/cli.py

@@ -96,8 +96,7 @@ def cli(packages, repo, reset, all_packages):
         elif package.startswith("plainx-"):
             plainx_packages.append(str(repo))
         else:
-            click.secho(f"Unknown package {package}", fg="red")
-            sys.exit(2)
+            raise click.UsageError(f"Unknown package {package}")
 
     if plain_packages:
         result = subprocess.run(["uv", "add", "--editable", "--dev"] + plain_packages)