plain.dev 0.19.2__py3-none-any.whl → 0.20.0__py3-none-any.whl

plain/dev/cli.py

@@ -17,7 +17,6 @@ from rich.text import Text
 
 from plain.runtime import APP_PATH, settings
 
-from .db import cli as db_cli
 from .mkcert import MkcertManager
 from .pid import Pid
 from .poncho.manager import Manager as PonchoManager
@@ -342,7 +341,9 @@ class Dev:
         gunicorn = " ".join(gunicorn_cmd)
 
         if plain_db_installed:
-            runserver_cmd = f"plain models db-wait && plain migrate && {gunicorn}"
+            runserver_cmd = (
+                f"plain models db-wait && plain migrate --backup && {gunicorn}"
+            )
         else:
             runserver_cmd = gunicorn
 
@@ -388,6 +389,3 @@ class Dev:
                 **data.get("env", {}),
             }
             self.poncho.add_process(name, data["cmd"], env=env)
-
-
-cli.add_command(db_cli)

plain/dev/contribute/README.md

@@ -0,0 +1,5 @@
+## FAQs
+
+### What if the plain cli isn't working?
+
+When working on packages locally you can sometimes end up in a weird state where Plain can't load. The `plain contrib` command is also available as `plain-contrib`, which won't go through any of the setup processes for Plain, so you can always run that directly if you need to.

plain/dev/requests.py

@@ -184,7 +184,7 @@ def should_capture_request(request):
     if not settings.DEBUG:
         return False
 
-    if request.resolver_match and request.resolver_match.default_namespace == "dev":
+    if request.resolver_match and request.resolver_match.namespace == "dev":
         return False
 
     if request.path in settings.DEV_REQUESTS_IGNORE_PATHS:

plain/dev/urls.py

@@ -1,9 +1,11 @@
-from plain.urls import path
+from plain.urls import RouterBase, path, register_router
 
 from . import views
 
-default_namespace = "dev"
 
-urlpatterns = [
-    path("", views.RequestsView, name="requests"),
-]
+@register_router
+class Router(RouterBase):
+    namespace = "dev"
+    urls = [
+        path("", views.RequestsView, name="requests"),
+    ]

{plain_dev-0.19.2.dist-info → plain_dev-0.20.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: plain.dev
-Version: 0.19.2
+Version: 0.20.0
 Summary: Local development tools for Plain.
 Author-email: Dave Gaeddert <dave.gaeddert@dropseed.dev>
 License-Expression: BSD-3-Clause
@@ -8,6 +8,7 @@ License-File: LICENSE
 Requires-Python: >=3.11
 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
@@ -15,8 +16,6 @@ Requires-Dist: requests>=2.0.0
 Requires-Dist: rich
 Description-Content-Type: text/markdown
 
-<!-- This file is compiled from plain-dev/plain/dev/README.md. Do not edit this file directly. -->
-
 # plain.dev
 
 A single command that runs everything you need for local development.

{plain_dev-0.19.2.dist-info → plain_dev-0.20.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 plain/dev/README.md,sha256=-yR4qzwEP7vDVvCAHJ22aaQHQ7rXVW9uy0KEZjCzmz4,3662
 plain/dev/__init__.py,sha256=nRX1B0Br8gmqhJLqo5Z9PqzReDahBtbmwH6C-7hzuls,103
-plain/dev/cli.py,sha256=4QYJuADGccwAZl0e_jSGO70NPabtiTB43IFXb2hNi30,12926
+plain/dev/cli.py,sha256=DkuMpWpfP0FxSFyl4jI7iXkChDWs7cfv_u4RM34rwH4,12911
 plain/dev/debug.py,sha256=Ka84K8zUdF0kMYNyqiLYDrdzU1jU8LSOkts3hcw_Gok,1005
 plain/dev/default_settings.py,sha256=uXWYORWP_aRDwXIFXdu5kHyiBFUZzARIJdhPeFaX35c,75
 plain/dev/entrypoints.py,sha256=TCjX9aCLQag_0UjWE6PU5MnuaNWHAqsZQh7opSjr8zM,386
@@ -8,16 +8,14 @@ plain/dev/gunicorn_logging.json,sha256=yU23jzs5G4YGdDWBNiyAc3KypR4HirR6afIkD7w6D
 plain/dev/mkcert.py,sha256=u284XXQeTgwSkKKh0gMrYpnNGdd9OOUJKLQAXcvGnr4,3459
 plain/dev/pdb.py,sha256=4ru3rlIIyuYVXteyI7v42i4MmdBIjpJP0IJemBpf83A,3742
 plain/dev/pid.py,sha256=gRMBf7aGndrra1TnmKtPghTijnd0i0Xeo63mzfPWp7M,436
-plain/dev/requests.py,sha256=v4ucDL8d6I0s5kF8O8HRvSc6Snq1Z_SMQv7wGGAI_Us,6847
+plain/dev/requests.py,sha256=D1NX0qC8ADtf_zwsGMTp9aiE6Sh9QmoxFJCU_V8Wers,6839
 plain/dev/services.py,sha256=26WnVNjNAh37BA-wHQSGQY_9Ofw8oGgJdHhxnFaSKkg,2059
-plain/dev/urls.py,sha256=b4NL2I6Ok-t7nTPjRnKoz_LQRttE3_mp8l2NlmeYQ9I,146
+plain/dev/urls.py,sha256=AzGhzJ_6nnHQCqGgiriykOnXmQUvUQSa3ji9NKHjk4I,219
 plain/dev/utils.py,sha256=4wMzpvj1Is_c0QxhsTu34_P9wAYlzw4glNPfVtZr_0A,123
 plain/dev/views.py,sha256=r2Ivk7OXytpRhXq4DZpsb7FXNP9vzmEE3D5kLajYG4w,1073
+plain/dev/contribute/README.md,sha256=v9Ympugu2wvDEe_045WJnF1dmC4ZH7v_Bnxkpfaf_rM,329
 plain/dev/contribute/__init__.py,sha256=9ByBOIdM8DebChjNz-RH2atdz4vWe8somlwNEsbhwh4,40
 plain/dev/contribute/cli.py,sha256=mIK4u1rhee8iMovUpuHTNjfWolqNgS24_gTb8ZaSY-8,2432
-plain/dev/db/__init__.py,sha256=9ByBOIdM8DebChjNz-RH2atdz4vWe8somlwNEsbhwh4,40
-plain/dev/db/cli.py,sha256=058HjRKLGz-FxauQEpwsPoh_LCiy-_NEIpRZl9W1ZKM,2855
-plain/dev/db/container.py,sha256=RlPJU_CCMKA-zN8Kp0sYAu3jabOizxYAj8fSCsjCf60,5147
 plain/dev/poncho/__init__.py,sha256=MDOk2rhhoR3V-I-rg6tMHFeX60vTGJuQ14RI-_N6tQY,97
 plain/dev/poncho/color.py,sha256=Dk77inPR9qNc9vCaZOGk8W9skXfRgoUlxp_E6mhPNns,610
 plain/dev/poncho/compat.py,sha256=l66WZLR7kRpO8P8DI5-aUsbNlohPaXEurQ5xXESQYDs,1276
@@ -27,8 +25,8 @@ plain/dev/poncho/process.py,sha256=JJOKy-C6vMCg7-6JMCtu6C649h7HmOBSJqDP_hnX49I,2
 plain/dev/precommit/__init__.py,sha256=9ByBOIdM8DebChjNz-RH2atdz4vWe8somlwNEsbhwh4,40
 plain/dev/precommit/cli.py,sha256=divzCT1LY_aH89nJuzdFqFHhyA4R7jEcV_R6uZsu4bo,3383
 plain/dev/templates/dev/requests.html,sha256=kQKJZq5L77juuL_t8UjcAehEU61U4RXNnKaAET-wAm8,7627
-plain_dev-0.19.2.dist-info/METADATA,sha256=QCcnxdO7IBSw7yuGVpbTjhyXl_IJ2gM9YC4feFMogZA,4244
-plain_dev-0.19.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-plain_dev-0.19.2.dist-info/entry_points.txt,sha256=u3RYQlK2jhQvM0yi40D-oV-x2Hot6Ygw07MZ6QQg_28,159
-plain_dev-0.19.2.dist-info/licenses/LICENSE,sha256=Cx4Dq9yR2fLHthf8Ke36B8QJvE1bZFXVzDIGE8wGzsY,4132
-plain_dev-0.19.2.dist-info/RECORD,,
+plain_dev-0.20.0.dist-info/METADATA,sha256=AoaaHtDPcdIQOHsFAI6XTRw9A8HhTrljtzKpjK17Kwg,4167
+plain_dev-0.20.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+plain_dev-0.20.0.dist-info/entry_points.txt,sha256=UtjUbxI-2TMZJGCfRTeU-YGr48XLwnc_pMuzDGD9uTg,219
+plain_dev-0.20.0.dist-info/licenses/LICENSE,sha256=Cx4Dq9yR2fLHthf8Ke36B8QJvE1bZFXVzDIGE8wGzsY,4132
+plain_dev-0.20.0.dist-info/RECORD,,

{plain_dev-0.19.2.dist-info → plain_dev-0.20.0.dist-info}/entry_points.txt

@@ -1,3 +1,6 @@
+[console_scripts]
+plain-contrib = plain.dev.contribute:cli
+
 [plain.cli]
 contrib = plain.dev.contribute:cli
 dev = plain.dev:cli

plain/dev/db/__init__.py

@@ -1,3 +0,0 @@
-from .cli import cli
-
-__all__ = ["cli"]

plain/dev/db/cli.py

@@ -1,113 +0,0 @@
-import os
-import sys
-
-import click
-
-from ..services import Services
-from .container import DBContainer
-
-
-@click.group("db")
-def cli():
-    """Start, stop, and manage the local Postgres database"""
-    pass
-
-
-# @cli.command()
-# def reset():
-#     DBContainer().reset(create=True)
-#     click.secho("Local development database reset", fg="green")
-
-
-@cli.command()
-@click.argument("export_path", default="")
-def export(export_path):
-    """Export the local database to a file"""
-    if not export_path:
-        current_dir_name = os.path.basename(os.getcwd())
-        export_path = f"{current_dir_name}-dev-db.sql"
-    with Services():
-        export_successful = DBContainer().export(export_path)
-
-    if export_successful:
-        click.secho(f"Local development database exported to {export_path}", fg="green")
-    else:
-        click.secho("Export failed", fg="red")
-        sys.exit(1)
-
-
-@cli.command("import")
-@click.argument("sql_file")
-def import_db(sql_file):
-    """Import a database file into the local database"""
-
-    print(f"Importing {sql_file} ({os.path.getsize(sql_file) / 1024 / 1024:.2f} MB)")
-
-    with Services():
-        successful = DBContainer().import_sql(sql_file)
-
-    if successful:
-        click.secho(f"Local development database imported from {sql_file}", fg="green")
-    else:
-        click.secho("Import failed", fg="red")
-        sys.exit(1)
-
-
-@cli.group()
-def snapshot():
-    """Manage local database snapshots"""
-    pass
-
-
-@snapshot.command("create")
-@click.argument("name")
-@click.pass_context
-def snapshot_create(ctx, name):
-    """Create a snapshot of the main database"""
-    created = DBContainer().create_snapshot(name)
-    if not created:
-        click.secho(f'Snapshot "{name}" already exists', fg="red")
-        sys.exit(1)
-
-    click.secho(f'Snapshot "{name}" created', fg="green")
-    print()
-    ctx.invoke(snapshot_list)
-
-
-@snapshot.command("list")
-def snapshot_list():
-    """List all snapshots"""
-    DBContainer().list_snapshots()
-
-
-@snapshot.command("restore")
-@click.argument("name")
-@click.option("--yes", "-y", is_flag=True)
-def snapshot_restore(name, yes):
-    """Restore a snapshot to the main database"""
-    if not yes:
-        click.confirm(
-            f'Are you sure you want to restore snapshot "{name}" to the main database?',
-            abort=True,
-        )
-
-    DBContainer().restore_snapshot(name)
-    click.secho(f'Snapshot "{name}" restored', fg="green")
-
-
-@snapshot.command("delete")
-@click.argument("name")
-@click.pass_context
-def snapshot_delete(ctx, name):
-    """Delete a snapshot"""
-    deleted = DBContainer().delete_snapshot(name)
-    if not deleted:
-        click.secho(f'Snapshot "{name}" does not exist', fg="red")
-        sys.exit(1)
-    click.secho(f'Snapshot "{name}" deleted', fg="green")
-    print()
-    ctx.invoke(snapshot_list)
-
-
-if __name__ == "__main__":
-    cli()

plain/dev/db/container.py

@@ -1,151 +0,0 @@
-import os
-import shlex
-import subprocess
-
-from plain.runtime import APP_PATH, settings
-
-SNAPSHOT_DB_PREFIX = "plaindb_snapshot_"
-
-
-class DBContainer:
-    def __init__(self):
-        project_root = APP_PATH.parent
-        tmp_dir = settings.PLAIN_TEMP_PATH
-
-        name = os.path.basename(project_root) + "-postgres-1"
-
-        if "DATABASE_URL" in os.environ:
-            from plain.models import database_url
-
-            postgres_version = os.environ.get("POSTGRES_VERSION")
-            parsed_db_url = database_url.parse(os.environ.get("DATABASE_URL"))
-
-        self.name = name
-        self.tmp_dir = os.path.abspath(tmp_dir)
-        self.postgres_version = postgres_version or "13"
-        self.postgres_port = parsed_db_url.get("PORT", "5432")
-        self.postgres_db = parsed_db_url.get("NAME", "postgres")
-        self.postgres_user = parsed_db_url.get("USER", "postgres")
-        self.postgres_password = parsed_db_url.get("PASSWORD", "postgres")
-
-    def execute(self, command, *args, **kwargs):
-        docker_flags = kwargs.pop("docker_flags", "-it")
-        return subprocess.run(
-            [
-                "docker",
-                "exec",
-                docker_flags,
-                self.name,
-                *shlex.split(command),
-            ]
-            + list(args),
-            check=True,
-            **kwargs,
-        )
-
-    def reset(self, create=False):
-        try:
-            self.execute(
-                f"dropdb {self.postgres_db} --force -U {self.postgres_user}",
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
-            )
-        except subprocess.CalledProcessError as e:
-            if "does not exist" not in e.stdout.decode():
-                print(e.stderr.decode())
-                raise
-
-        if create:
-            self.execute(
-                f"createdb {self.postgres_db} -U {self.postgres_user}",
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
-            )
-
-    def terminate_connections(self):
-        self.execute(
-            f"psql -U {self.postgres_user} {self.postgres_db} -c",
-            f"SELECT pg_terminate_backend(pg_stat_activity.pid) FROM pg_stat_activity WHERE pg_stat_activity.datname = '{self.postgres_db}' AND pid <> pg_backend_pid();",
-            stdout=subprocess.DEVNULL,
-        )
-
-    def create_snapshot(self, name):
-        snapshot_name = f"{SNAPSHOT_DB_PREFIX}{name}"
-        current_git_branch = (
-            subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"])
-            .decode()
-            .strip()
-        )
-        description = f"branch={current_git_branch}"
-
-        self.terminate_connections()
-        try:
-            self.execute(
-                f"createdb {snapshot_name} '{description}' -U {self.postgres_user} -T {self.postgres_db}",
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
-            )
-        except subprocess.CalledProcessError as e:
-            if "already exists" in e.stdout.decode():
-                return False
-            else:
-                raise
-
-        return True
-
-    def list_snapshots(self):
-        self.execute(
-            f"psql -U {self.postgres_user} {self.postgres_db} -c",
-            f"SELECT REPLACE(datname, '{SNAPSHOT_DB_PREFIX}', '') as name, pg_size_pretty(pg_database_size(datname)) as size, pg_catalog.shobj_description(oid, 'pg_database') AS description, (pg_stat_file('base/'||oid ||'/PG_VERSION')).modification as created FROM pg_catalog.pg_database WHERE datname LIKE '{SNAPSHOT_DB_PREFIX}%' ORDER BY created;",
-        )
-
-    def delete_snapshot(self, name):
-        snapshot_name = f"{SNAPSHOT_DB_PREFIX}{name}"
-        try:
-            self.execute(
-                f"dropdb {snapshot_name} -U {self.postgres_user}",
-                stdout=subprocess.PIPE,
-                stderr=subprocess.PIPE,
-            )
-        except subprocess.CalledProcessError as e:
-            if "does not exist" in e.stdout.decode():
-                return False
-            else:
-                raise
-
-        return True
-
-    def restore_snapshot(self, name):
-        snapshot_name = f"{SNAPSHOT_DB_PREFIX}{name}"
-        self.reset(create=False)
-        self.execute(
-            f"createdb {self.postgres_db} -U {self.postgres_user} -T {snapshot_name}",
-        )
-
-    def export(self, export_path):
-        successful = (
-            subprocess.run(
-                [
-                    "docker",
-                    "exec",
-                    self.name,
-                    "/bin/bash",
-                    "-c",
-                    f"pg_dump -U {self.postgres_user} {self.postgres_db}",
-                ],
-                stdout=open(export_path, "w+"),
-            ).returncode
-            == 0
-        )
-        return successful
-
-    def import_sql(self, sql_file):
-        self.reset(create=True)
-        successful = (
-            subprocess.run(
-                f"docker exec -i {self.name} psql -U {self.postgres_user} {self.postgres_db} < {shlex.quote(sql_file)}",
-                shell=True,
-            ).returncode
-            == 0
-        )
-        return successful