plain.dev 0.5.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

plain/dev/cli.py

@@ -1,32 +1,31 @@
 import json
 import os
+import platform
+import shutil
 import subprocess
 import sys
+import urllib.request
 from importlib.util import find_spec
 from pathlib import Path
 
 import click
+import tomllib
 from honcho.manager import Manager as HonchoManager
 
-from plain.runtime import APP_PATH
+from plain.runtime import APP_PATH, settings
 
 from .db import cli as db_cli
 from .pid import Pid
 from .services import Services
 from .utils import has_pyproject_toml, plainpackage_installed
 
-try:
-    import tomllib
-except ModuleNotFoundError:
-    import tomli as tomllib
-
 
 @click.group(invoke_without_command=True)
 @click.pass_context
 @click.option(
     "--port",
     "-p",
-    default=8000,
+    default=8443,
     type=int,
     help="Port to run the web server on",
     envvar="PORT",
@@ -61,31 +60,187 @@ class Dev:
             "PORT": str(self.port),
             "PYTHONPATH": os.path.join(APP_PATH.parent, "app"),
         }
+        self.project_name = os.path.basename(os.getcwd())
+        self.domain = f"{self.project_name}.localhost"
+
+        # Paths for mkcert and certificates
+        self.mkcert_dir = Path.home() / ".plain" / "dev"
+        self.mkcert_bin = self.mkcert_dir / "mkcert"
+        self.certs_dir = (
+            Path(settings.PLAIN_TEMP_PATH) / "dev" / "certs"
+        )  # Local project directory for certs
+
+        # Define certificate and key paths with clear filenames
+        self.cert_path = self.certs_dir / f"{self.domain}-cert.pem"
+        self.key_path = self.certs_dir / f"{self.domain}-key.pem"
 
     def run(self):
         pid = Pid()
         pid.write()
 
         try:
+            self.setup_mkcert()
+            self.generate_certs()
+            self.modify_hosts_file()
             self.add_csrf_trusted_origins()
+            self.add_allowed_hosts()
             self.run_preflight()
             self.add_gunicorn()
             self.add_tailwind()
             self.add_pyproject_run()
             self.add_services()
 
+            # Output the clickable link before starting the manager loop
+            url = f"https://{self.domain}:{self.port}/"
+            click.secho(
+                f"\nYour application is running at: {click.style(url, fg='green', underline=True)}\n",
+                bold=True,
+            )
+
             self.manager.loop()
 
             return self.manager.returncode
         finally:
             pid.rm()
 
-    def add_csrf_trusted_origins(self):
-        if "PLAIN_CSRF_TRUSTED_ORIGINS" in os.environ:
+    def setup_mkcert(self):
+        """Set up mkcert by checking if it's installed or downloading the binary and installing the local CA."""
+        if mkcert_path := shutil.which("mkcert"):
+            # mkcert is already installed somewhere
+            self.mkcert_bin = mkcert_path
+        else:
+            self.mkcert_dir.mkdir(parents=True, exist_ok=True)
+            if not self.mkcert_bin.exists():
+                system = platform.system()
+                arch = platform.machine()
+
+                # Map platform.machine() to mkcert's expected architecture strings
+                arch_map = {
+                    "x86_64": "amd64",
+                    "amd64": "amd64",
+                    "AMD64": "amd64",
+                    "arm64": "arm64",
+                    "aarch64": "arm64",
+                }
+                arch = arch_map.get(
+                    arch.lower(), "amd64"
+                )  # Default to amd64 if unknown
+
+                if system == "Darwin":
+                    os_name = "darwin"
+                elif system == "Linux":
+                    os_name = "linux"
+                elif system == "Windows":
+                    os_name = "windows"
+                else:
+                    click.secho("Unsupported OS", fg="red")
+                    sys.exit(1)
+
+                mkcert_url = f"https://dl.filippo.io/mkcert/latest?for={os_name}/{arch}"
+                click.secho(f"Downloading mkcert from {mkcert_url}...", bold=True)
+                urllib.request.urlretrieve(mkcert_url, self.mkcert_bin)
+                self.mkcert_bin.chmod(0o755)
+            self.mkcert_bin = str(self.mkcert_bin)  # Convert Path object to string
+
+        if not self.is_mkcert_ca_installed():
+            click.secho(
+                "Installing mkcert local CA. You may be prompted for your password.",
+                bold=True,
+            )
+            subprocess.run([self.mkcert_bin, "-install"], check=True)
+
+    def is_mkcert_ca_installed(self):
+        """Check if mkcert local CA is already installed using mkcert -check."""
+        try:
+            result = subprocess.run([self.mkcert_bin, "-check"], capture_output=True)
+            output = result.stdout.decode() + result.stderr.decode()
+            if "The local CA is not installed" in output:
+                return False
+            return True
+        except Exception as e:
+            click.secho(f"Error checking mkcert CA installation: {e}", fg="red")
+            return False
+
+    def generate_certs(self):
+        if self.cert_path.exists() and self.key_path.exists():
             return
 
+        self.certs_dir.mkdir(parents=True, exist_ok=True)
+
+        # Generate SSL certificates using mkcert
+        click.secho(f"Generating SSL certificates for {self.domain}...", bold=True)
+        subprocess.run(
+            [
+                self.mkcert_bin,
+                "-cert-file",
+                str(self.cert_path),
+                "-key-file",
+                str(self.key_path),
+                self.domain,
+            ],
+            check=True,
+        )
+
+    def modify_hosts_file(self):
+        """Modify the hosts file to map the custom domain to 127.0.0.1."""
+        entry_identifier = "# Added by plain"
+        hosts_entry = f"127.0.0.1 {self.domain}  {entry_identifier}"
+
+        if platform.system() == "Windows":
+            hosts_path = Path(r"C:\Windows\System32\drivers\etc\hosts")
+            try:
+                with hosts_path.open("r") as f:
+                    content = f.read()
+
+                if hosts_entry in content:
+                    return  # Entry already exists; no action needed
+
+                # Entry does not exist; add it
+                with hosts_path.open("a") as f:
+                    f.write(f"{hosts_entry}\n")
+                click.secho(f"Added {self.domain} to {hosts_path}", bold=True)
+            except PermissionError:
+                click.secho(
+                    "Permission denied while modifying hosts file. Please run the script as an administrator.",
+                    fg="red",
+                )
+                sys.exit(1)
+        else:
+            # For macOS and Linux
+            hosts_path = Path("/etc/hosts")
+            try:
+                with hosts_path.open("r") as f:
+                    content = f.read()
+
+                if hosts_entry in content:
+                    return  # Entry already exists; no action needed
+
+                # Entry does not exist; append it using sudo
+                click.secho(
+                    "Modifying /etc/hosts file. You may be prompted for your password.",
+                    bold=True,
+                )
+                cmd = f"echo '{hosts_entry}' | sudo tee -a {hosts_path} >/dev/null"
+                subprocess.run(cmd, shell=True, check=True)
+                click.secho(f"Added {self.domain} to {hosts_path}", bold=True)
+            except PermissionError:
+                click.secho(
+                    "Permission denied while accessing hosts file.",
+                    fg="red",
+                )
+                sys.exit(1)
+            except subprocess.CalledProcessError:
+                click.secho(
+                    "Failed to modify hosts file. Please ensure you have sudo privileges.",
+                    fg="red",
+                )
+                sys.exit(1)
+
+    def add_csrf_trusted_origins(self):
         csrf_trusted_origins = json.dumps(
-            [f"http://localhost:{self.port}", f"http://127.0.0.1:{self.port}"]
+            [
+                f"https://{self.domain}:{self.port}",
+            ]
         )
 
         click.secho(
@@ -93,10 +248,22 @@ class Dev:
             bold=True,
         )
 
-        # Set BASE_URL for plain and custom processes
+        # Set environment variables
         self.plain_env["PLAIN_CSRF_TRUSTED_ORIGINS"] = csrf_trusted_origins
         self.custom_process_env["PLAIN_CSRF_TRUSTED_ORIGINS"] = csrf_trusted_origins
 
+    def add_allowed_hosts(self):
+        allowed_hosts = json.dumps([self.domain])
+
+        click.secho(
+            f"Automatically set PLAIN_ALLOWED_HOSTS={click.style(allowed_hosts, underline=True)}",
+            bold=True,
+        )
+
+        # Set environment variables
+        self.plain_env["PLAIN_ALLOWED_HOSTS"] = allowed_hosts
+        self.custom_process_env["PLAIN_ALLOWED_HOSTS"] = allowed_hosts
+
     def run_preflight(self):
         if subprocess.run(["plain", "preflight"], env=self.plain_env).returncode:
             click.secho("Preflight check failed!", fg="red")
@@ -105,16 +272,34 @@ class Dev:
     def add_gunicorn(self):
         plain_db_installed = find_spec("plain.models") is not None
 
-        # TODO not necessarily watching the right .env...
-        # could return path from env.load?
+        # Watch .env files for reload
         extra_watch_files = []
         for f in os.listdir(APP_PATH.parent):
             if f.startswith(".env"):
-                # Will include some extra, but good enough for now
                 extra_watch_files.append(f)
 
         reload_extra = " ".join(f"--reload-extra-file {f}" for f in extra_watch_files)
-        gunicorn = f"gunicorn --bind 127.0.0.1:{self.port} --reload plain.wsgi:app --timeout 60 --access-logfile - --error-logfile - {reload_extra} --access-logformat '\"%(r)s\" status=%(s)s length=%(b)s dur=%(M)sms'"
+        gunicorn_cmd = [
+            "gunicorn",
+            "--bind",
+            f"{self.domain}:{self.port}",
+            "--certfile",
+            str(self.cert_path),
+            "--keyfile",
+            str(self.key_path),
+            "--reload",
+            "plain.wsgi:app",
+            "--timeout",
+            "60",
+            "--access-logfile",
+            "-",
+            "--error-logfile",
+            "-",
+            *reload_extra.split(),
+            "--access-logformat",
+            "'\"%(r)s\" status=%(s)s length=%(b)s dur=%(M)sms'",
+        ]
+        gunicorn = " ".join(gunicorn_cmd)
 
         if plain_db_installed:
             runserver_cmd = f"plain models db-wait && plain migrate && {gunicorn}"
@@ -122,8 +307,7 @@ class Dev:
             runserver_cmd = gunicorn
 
         if "WEB_CONCURRENCY" not in self.plain_env:
-            # Default to two workers so request log etc are less
-            # likely to get locked up
+            # Default to two workers to prevent lockups
             self.plain_env["WEB_CONCURRENCY"] = "2"
 
         self.manager.add_process("plain", runserver_cmd, env=self.plain_env)
@@ -141,9 +325,10 @@ class Dev:
         with open(Path(APP_PATH.parent, "pyproject.toml"), "rb") as f:
             pyproject = tomllib.load(f)
 
-        for name, data in (
+        run_commands = (
             pyproject.get("tool", {}).get("plain", {}).get("dev", {}).get("run", {})
-        ).items():
+        )
+        for name, data in run_commands.items():
             env = {
                 **self.custom_process_env,
                 **data.get("env", {}),

plain/dev/precommit/cli.py

@@ -4,17 +4,13 @@ import sys
 from importlib.util import find_spec
 from pathlib import Path
 
+import click
+import tomllib
+
 from plain.cli.print import print_event
 
 from ..services import Services
 
-try:
-    import tomllib
-except ModuleNotFoundError:
-    import tomli as tomllib
-
-import click
-
 
 def install_git_hook():
     hook_path = os.path.join(".git", "hooks", "pre-commit")

plain/dev/services.py

@@ -5,6 +5,7 @@ from importlib.util import find_spec
 from pathlib import Path
 
 import click
+import tomllib
 from honcho.manager import Manager as HonchoManager
 
 from plain.runtime import APP_PATH
@@ -12,11 +13,6 @@ from plain.runtime import APP_PATH
 from .pid import Pid
 from .utils import has_pyproject_toml
 
-try:
-    import tomllib
-except ModuleNotFoundError:
-    import tomli as tomllib
-
 
 class Services:
     @staticmethod

{plain_dev-0.5.0.dist-info → plain_dev-0.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: plain.dev
-Version: 0.5.0
+Version: 0.6.0
 Summary: Local development tools for Plain.
 Home-page: https://plainframework.com
 License: BSD-3-Clause
@@ -18,7 +18,6 @@ Requires-Dist: honcho (>=1.1.0,<2.0.0)
 Requires-Dist: plain (<1.0.0)
 Requires-Dist: psycopg[binary] (>=3.2.2,<4.0.0)
 Requires-Dist: requests (>=2.0.0)
-Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
 Project-URL: Documentation, https://plainframework.com/docs/
 Project-URL: Repository, https://github.com/dropseed/plain
 Description-Content-Type: text/markdown

{plain_dev-0.5.0.dist-info → plain_dev-0.6.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 plain/dev/README.md,sha256=BQDaRKfsafIPzx7vtVt-zS-a8l6sxbQThhQTvu7tp3Y,3699
 plain/dev/__init__.py,sha256=C1JrkNE5XX2DLgBXXLAV_UyhofwVd0ZPL59fPUMbOKo,139
-plain/dev/cli.py,sha256=4JOdOVvL4jjWad286g4lm4L9sdaFt7UJejaUK-TW3PU,4820
+plain/dev/cli.py,sha256=7MyA2-XExzFwYtv6q_TFEUXxelcPt2u3Ou51r9fGcDY,11740
 plain/dev/config.py,sha256=h6o5YZtJhg-cFIWoqIDWuMCC5T09cxEsBaa3BP4Nii0,632
 plain/dev/contribute/__init__.py,sha256=9ByBOIdM8DebChjNz-RH2atdz4vWe8somlwNEsbhwh4,40
 plain/dev/contribute/cli.py,sha256=qZ7YmE_upbw-Y5NRpvaHnJTPp9kvn21fPQ7G0n1LAkg,2277
@@ -11,15 +11,15 @@ plain/dev/debug.py,sha256=fIrecLfAK_lXSDyn3WmYikzZSse3KY47xcVVbZqJGhk,294
 plain/dev/default_settings.py,sha256=uXWYORWP_aRDwXIFXdu5kHyiBFUZzARIJdhPeFaX35c,75
 plain/dev/pid.py,sha256=gRMBf7aGndrra1TnmKtPghTijnd0i0Xeo63mzfPWp7M,436
 plain/dev/precommit/__init__.py,sha256=9ByBOIdM8DebChjNz-RH2atdz4vWe8somlwNEsbhwh4,40
-plain/dev/precommit/cli.py,sha256=gwpFcH267Kbqc2Ci3MHFxxAXsuDDblGxcicVVNi1NdY,3488
+plain/dev/precommit/cli.py,sha256=UNrQmWRKrkZ6WbzrrcnjZl8VHwNorOVTHGoRQsR4jp8,3422
 plain/dev/requests.py,sha256=0HyCH7iZ32ne94ypMdE96z5iYb_Qbd705WItVik1SyA,6839
-plain/dev/services.py,sha256=m4XOcY8qcUVA4u8vsFZmU-wChgQvy5uiu5abOR9wZfg,2127
+plain/dev/services.py,sha256=Ypat8YFum0K_CLtkUuU2L6Y9Rg8GJBvJ0OqeVGMVT9g,2061
 plain/dev/templates/dev/requests.html,sha256=kQKJZq5L77juuL_t8UjcAehEU61U4RXNnKaAET-wAm8,7627
 plain/dev/urls.py,sha256=b4NL2I6Ok-t7nTPjRnKoz_LQRttE3_mp8l2NlmeYQ9I,146
 plain/dev/utils.py,sha256=mL3C3l3GsKmtI6eF4sRjv7w9n7Y9lLVqJulj81JrqWw,312
 plain/dev/views.py,sha256=r2Ivk7OXytpRhXq4DZpsb7FXNP9vzmEE3D5kLajYG4w,1073
-plain_dev-0.5.0.dist-info/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
-plain_dev-0.5.0.dist-info/METADATA,sha256=BUN9CnXC6gRHWTrI3S1_awfvuPONdIwala0ln9j6M5E,4727
-plain_dev-0.5.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-plain_dev-0.5.0.dist-info/entry_points.txt,sha256=rBo-S4THn07f55UwHBuUhIbDhlUq3EzTOD8mIb5fGQg,99
-plain_dev-0.5.0.dist-info/RECORD,,
+plain_dev-0.6.0.dist-info/LICENSE,sha256=cvKM3OlqHx3ijD6e34zsSUkPvzl-ya3Dd63A6EHL94U,1500
+plain_dev-0.6.0.dist-info/METADATA,sha256=1kaH9Gal5Got6ltGlMJne_GI6Mqjd8Bz4CILkVujmTo,4663
+plain_dev-0.6.0.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+plain_dev-0.6.0.dist-info/entry_points.txt,sha256=rBo-S4THn07f55UwHBuUhIbDhlUq3EzTOD8mIb5fGQg,99
+plain_dev-0.6.0.dist-info/RECORD,,