fujin-cli 0.7.1__py3-none-any.whl → 0.8.0__py3-none-any.whl

fujin/commands/_base.py

@@ -33,6 +33,14 @@ class BaseCommand:
     def app_dir(self) -> str:
         return self.config.host.get_app_dir(app_name=self.config.app_name)
 
+    @cached_property
+    def hook_manager(self) -> HookManager:
+        return HookManager(
+            hooks=self.config.hooks,
+            app_name=self.config.app_name,
+            local_config_dir=self.config.local_config_dir,
+        )
+
     @contextmanager
     def connection(self):
         with host_connection(host=self.config.host) as conn:
@@ -70,8 +78,3 @@ class BaseCommand:
 
     def create_process_manager(self, conn: Connection) -> ProcessManager:
         return self.process_manager_class.create(conn=conn, config=self.config)
-
-    def create_hook_manager(self, conn: Connection) -> HookManager:
-        return HookManager(
-            conn=conn, hooks=self.config.hooks, app_name=self.config.app_name
-        )

fujin/commands/deploy.py

@@ -16,15 +16,15 @@ from fujin.secrets import resolve_secrets
 )
 class Deploy(BaseCommand):
     def __call__(self):
+        self.hook_manager.pre_build()
         parsed_env = self.parse_envfile()
         self.build_app()
-
+        self.hook_manager.pre_deploy()
         with self.connection() as conn:
             process_manager = self.create_process_manager(conn)
             conn.run(f"mkdir -p {self.app_dir}")
             conn.run(f"mkdir -p {self.versioned_assets_dir}")
             with conn.cd(self.app_dir):
-                self.create_hook_manager(conn).pre_deploy()
                 self.transfer_files(conn, env=parsed_env)
                 self.install_project(conn)
             with self.app_environment() as app_conn:
@@ -35,7 +35,7 @@ class Deploy(BaseCommand):
                 self.create_web_proxy(app_conn).setup()
                 self.update_version_history(app_conn)
                 self.prune_assets(app_conn)
-            self.create_hook_manager(conn).post_deploy()
+        self.hook_manager.post_deploy()
         self.stdout.output("[green]Project deployment completed successfully![/green]")
         self.stdout.output(
             f"[blue]Access the deployed project at: https://{self.config.host.domain_name}[/blue]"
@@ -60,7 +60,7 @@ class Deploy(BaseCommand):
         return self.config.host.envfile.read_text()
 
     def transfer_files(
-        self, conn: Connection, env: str, skip_requirements: bool = False
+            self, conn: Connection, env: str, skip_requirements: bool = False
     ):
         conn.run(f"echo '{env}' > {self.app_dir}/.env")
         distfile_path = self.config.get_distfile_path()
@@ -78,7 +78,7 @@ class Deploy(BaseCommand):
             )
 
     def install_project(
-        self, conn: Connection, version: str | None = None, *, skip_setup: bool = False
+            self, conn: Connection, version: str | None = None, *, skip_setup: bool = False
     ):
         version = version or self.config.version
         if self.config.installation_mode == InstallationMode.PY_PACKAGE:
@@ -87,7 +87,7 @@ class Deploy(BaseCommand):
             self._install_binary(conn, version)
 
     def _install_python_package(
-        self, conn: Connection, version: str, skip_setup: bool = False
+            self, conn: Connection, version: str, skip_setup: bool = False
     ):
         appenv = f"""
 set -a  # Automatically export all variables

fujin/commands/down.py

@@ -33,8 +33,6 @@ class Down(BaseCommand):
         if not confirm:
             return
         with self.connection() as conn:
-            hook_manager = self.create_hook_manager(conn)
-            hook_manager.pre_teardown()
             process_manager = self.create_process_manager(conn)
             conn.run(f"rm -rf {self.app_dir}")
             self.create_web_proxy(conn).teardown()
@@ -42,7 +40,6 @@ class Down(BaseCommand):
             process_manager.reload_configuration()
             if self.full:
                 self.create_web_proxy(conn).uninstall()
-            hook_manager.post_teardown()
             self.stdout.output(
                 "[green]Project teardown completed successfully![/green]"
             )

fujin/commands/redeploy.py

@@ -5,22 +5,21 @@ from pathlib import Path
 
 import cappa
 
-from .deploy import Deploy
 from fujin.commands import BaseCommand
 from fujin.config import InstallationMode
 from fujin.connection import Connection
+from .deploy import Deploy
 
 
 @cappa.command(help="Redeploy the application to apply code and environment changes")
 class Redeploy(BaseCommand):
     def __call__(self):
         deploy = Deploy()
+        self.hook_manager.pre_build()
         parsed_env = deploy.parse_envfile()
         deploy.build_app()
-
+        self.hook_manager.pre_deploy()
         with self.app_environment() as conn:
-            hook_manager = self.create_hook_manager(conn)
-            hook_manager.pre_deploy()
             conn.run(f"mkdir -p {deploy.versioned_assets_dir}")
             requirements_copied = self._copy_requirements_if_needed(conn)
             deploy.transfer_files(
@@ -30,13 +29,13 @@ class Redeploy(BaseCommand):
             deploy.release(conn)
             self.create_process_manager(conn).restart_services()
             deploy.update_version_history(conn)
-            hook_manager.post_deploy()
-            self.stdout.output("[green]Redeployment completed successfully![/green]")
+        self.hook_manager.post_deploy()
+        self.stdout.output("[green]Redeployment completed successfully![/green]")
 
     def _copy_requirements_if_needed(self, conn: Connection) -> bool:
         if (
-            not self.config.requirements
-            or self.config.installation_mode == InstallationMode.BINARY
+                not self.config.requirements
+                or self.config.installation_mode == InstallationMode.BINARY
         ):
             return False
         local_requirements = hashlib.md5(

fujin/commands/server.py

@@ -23,8 +23,6 @@ class Server(BaseCommand):
     @cappa.command(help="Setup uv, web proxy, and install necessary dependencies")
     def bootstrap(self):
         with self.connection() as conn:
-            hook_manager = self.create_hook_manager(conn)
-            hook_manager.pre_bootstrap()
             conn.run("sudo apt update && sudo apt upgrade -y", pty=True)
             conn.run("sudo apt install -y sqlite3 curl rsync", pty=True)
             result = conn.run("command -v uv", warn=True)
@@ -33,7 +31,6 @@ class Server(BaseCommand):
                 conn.run("uv tool update-shell")
             conn.run("uv tool install fastfetch-bin-edge")
             self.create_web_proxy(conn).install()
-            hook_manager.post_bootstrap()
             self.stdout.output(
                 "[green]Server bootstrap completed successfully![/green]"
             )

fujin/config.py

@@ -176,6 +176,9 @@ Example:
     dbconsole = "app exec -i dbshell" # open an interactive django database shell
     shell = "server exec --appenv -i bash" # SSH into the project directory with environment variables loaded
 
+hooks
+-----
+Run custom scripts at specific points with hooks. Check out the `secrets </hooks.html>`_ page for more information.
 
 """
 

fujin/hooks.py

@@ -1,9 +1,10 @@
+import subprocess
 from dataclasses import dataclass
+from pathlib import Path
 
+import cappa
 from rich import print as rich_print
 
-from fujin.connection import Connection
-
 try:
     from enum import StrEnum
 except ImportError:
@@ -14,43 +15,45 @@ except ImportError:
 
 
 class Hook(StrEnum):
+    PRE_BUILD = "pre_build"
     PRE_DEPLOY = "pre_deploy"
     POST_DEPLOY = "post_deploy"
-    PRE_BOOTSTRAP = "pre_bootstrap"
-    POST_BOOTSTRAP = "post_bootstrap"
-    PRE_TEARDOWN = "pre_teardown"
-    POST_TEARDOWN = "post_teardown"
 
 
-HooksDict = dict[Hook, dict]
+HooksDict = dict[Hook, str]
 
 
-@dataclass(frozen=True, slots=True)
+@dataclass(slots=True)
 class HookManager:
     app_name: str
     hooks: HooksDict
-    conn: Connection
+    local_config_dir: Path
+
+    def __post_init__(self):
+        if self.hooks:
+            return
+        hooks_folder = self.local_config_dir / "hooks"
+        if not hooks_folder.exists():
+            return
+        self.hooks = {
+            h.value: f"./{hooks_folder / h.value}"  # noqa
+            for h in Hook
+            if (hooks_folder / h.value).exists()  # noqa
+        }
 
     def _run_hook(self, type_: Hook) -> None:
-        if hooks := self.hooks.get(type_):
-            for name, command in hooks.items():
-                rich_print(f"[blue]Running {type_} hook {name} [/blue]")
-                self.conn.run(command, pty=True)
+        if cmd := self.hooks.get(type_):
+            rich_print(f"[blue]Running {type_} hook[/blue]")
+            result = subprocess.run(cmd, shell=True, capture_output=True, text=True)
+            if result.returncode != 0:
+                raise cappa.Exit(result.stderr)
+            rich_print(result.stdout)
+
+    def pre_build(self) -> None:
+        self._run_hook(Hook.PRE_BUILD)
 
     def pre_deploy(self) -> None:
         self._run_hook(Hook.PRE_DEPLOY)
 
     def post_deploy(self) -> None:
         self._run_hook(Hook.POST_DEPLOY)
-
-    def pre_bootstrap(self) -> None:
-        self._run_hook(Hook.PRE_BOOTSTRAP)
-
-    def post_bootstrap(self) -> None:
-        self._run_hook(Hook.POST_BOOTSTRAP)
-
-    def pre_teardown(self) -> None:
-        self._run_hook(Hook.PRE_TEARDOWN)
-
-    def post_teardown(self) -> None:
-        self._run_hook(Hook.POST_TEARDOWN)

{fujin_cli-0.7.1.dist-info → fujin_cli-0.8.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fujin-cli
-Version: 0.7.1
+Version: 0.8.0
 Summary: Get your project up and running in a few minutes on your own vps.
 Project-URL: Documentation, https://github.com/falcopackages/fujin#readme
 Project-URL: Issues, https://github.com/falcopackages/fujin/issues

{fujin_cli-0.7.1.dist-info → fujin_cli-0.8.0.dist-info}/RECORD

@@ -1,23 +1,23 @@
 fujin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fujin/__main__.py,sha256=VJMBzuQuxkQaAKNEySktGnms944bkRsrIAjj-XeaWR8,1813
-fujin/config.py,sha256=pdWK4fM3BITpz0MAv_ydCXRcQbgC3eLz--APdOpehiQ,10412
+fujin/config.py,sha256=FDHCkfAEt6sEjdK1szSCRqCvBfH7LMs_DQeAFHuR6wg,10540
 fujin/connection.py,sha256=LL7LhX9p0X9FmiGdlSroD3Ht216QY0Kd51xkSrXmM3s,2479
 fujin/errors.py,sha256=74Rh-Sgql1YspPdR_akQ2G3xZ48zecyafYCptpaFo1A,73
-fujin/hooks.py,sha256=nTn2PHpFuKbl_iAXUxagkrGcuwT2Exx8zIq4YfleX8A,1351
+fujin/hooks.py,sha256=EDVYNozlDJ5kc1xHtZrXgtuKplUMEMPTp65TLMP02Ek,1449
 fujin/commands/__init__.py,sha256=g0b13vzidPUbxne_Zo_Wv5jpEmwCiSK4AokCinH9uo4,39
-fujin/commands/_base.py,sha256=NfBdRBx_l7tYnVg0L8A3tPFC_XmtuHq-toU66KT5CiE,2553
+fujin/commands/_base.py,sha256=Rtf7kcO_Pg2JxPNKsXEx0UdhqfzYU6g7IiezC8cqEPQ,2610
 fujin/commands/app.py,sha256=mazb4dCTdR5juh79bL3a9b68Nd6O8u_nR9IgYqQlqWE,5279
 fujin/commands/config.py,sha256=xdfd1OZLxw2YZldiAbW5rq5EBXEaXbUC-I7FKLRfzIQ,2387
-fujin/commands/deploy.py,sha256=PfEdLS-rkdF12BfjtLEyqbnn1K4dEYRh7h6CFtWb2zs,5934
+fujin/commands/deploy.py,sha256=UFWraUDx2EmfD_riGq79fCWNGfytCJ9UR_eYKOfDYXY,5945
 fujin/commands/docs.py,sha256=b5FZ8AgoAfn4q4BueEQvM2w5HCuh8-rwBqv_CRFVU8E,349
-fujin/commands/down.py,sha256=v1lAq70ApktjeHRB_1sCzjmKH8t6EXqyL4RTt7OE-f0,1716
+fujin/commands/down.py,sha256=aw_mxl_TMC66plKTXwlYP1W2XQBmHeROltQqOpQssyE,1577
 fujin/commands/init.py,sha256=zREfkIQyC6etqqQ6hgvDqpNNWQT4bk_8IOPBBT5-YUE,3983
 fujin/commands/printenv.py,sha256=bpGmOfc1t_dKWb8gy7EILYtwEyI9pIwhKg2XPKyJ9cQ,527
 fujin/commands/proxy.py,sha256=ajXwboS0gDDiMWW7b9rtWU6WPF1h7JYYeycDyU-hQfg,3053
 fujin/commands/prune.py,sha256=C2aAN6AUS84jgRg1eiCroyiuZyaZDmf5yvGAQY9xkcg,1517
-fujin/commands/redeploy.py,sha256=z1giY9SpINdJt8UagPlvUkJu30c8fgqapNqOxG4Jfuo,2378
+fujin/commands/redeploy.py,sha256=PuXgrEc4fj_88WQXXBBvEtD46IeqzbPeMo-5pDlAuJQ,2363
 fujin/commands/rollback.py,sha256=JsocJzQcdQelSnYD94klhjBh8UKkkdiRD9shfUfo4FI,2032
-fujin/commands/server.py,sha256=0N_P_Luj31t56riZ8GfgRqW3vRHiw0cDrlp3PFoyWn8,3453
+fujin/commands/server.py,sha256=-3-PyBNR0fGm-RYE3fz50kP-LSDYGU9BzUxrbGZEghc,3312
 fujin/commands/up.py,sha256=OEK_n-6-mnnIUffFpR7QtVunr1V1F04pxlAAS1U62BY,419
 fujin/process_managers/__init__.py,sha256=MhhfTBhm64zWRAKgjvsZRIToOUJus60vGScbAjqpQ6Y,994
 fujin/process_managers/systemd.py,sha256=qG_4Ew8SEWtaTFOAW_XZXsMO2WjFWZ4dp5nBwAPBObk,5603
@@ -31,8 +31,8 @@ fujin/secrets/onepassword.py,sha256=6Xj3XWttKfcjMbcoMZvXVpJW1KHxlD785DysmX_mqvk,
 fujin/templates/simple.service,sha256=-lyKjmSyfHGucP4O_vRQE1NNaHq0Qjsc0twdwoRLgI0,321
 fujin/templates/web.service,sha256=NZ7ZeaFvV_MZTBn8QqRQeu8PIrWHf3aWYWNzjOQeqCw,685
 fujin/templates/web.socket,sha256=2lJsiOHlMJL0YlN7YBLLnr5zqsytPEt81yP34nk0dmc,173
-fujin_cli-0.7.1.dist-info/METADATA,sha256=kqTIyfQ_EtbpdoaSkBmrF5Wy6y838HLaqLJHbLko3L4,4576
-fujin_cli-0.7.1.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
-fujin_cli-0.7.1.dist-info/entry_points.txt,sha256=Y_TBtKt3j11qhwquMexZR5yqnDEqOBDACtresqQFE-s,46
-fujin_cli-0.7.1.dist-info/licenses/LICENSE.txt,sha256=0QF8XfuH0zkIHhSet6teXfiCze6JSdr8inRkmLLTDyo,1099
-fujin_cli-0.7.1.dist-info/RECORD,,
+fujin_cli-0.8.0.dist-info/METADATA,sha256=S-SNZujrKy0Omj5KlcHlWSCPynXWrrm-HtLc9fo17BA,4576
+fujin_cli-0.8.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+fujin_cli-0.8.0.dist-info/entry_points.txt,sha256=Y_TBtKt3j11qhwquMexZR5yqnDEqOBDACtresqQFE-s,46
+fujin_cli-0.8.0.dist-info/licenses/LICENSE.txt,sha256=0QF8XfuH0zkIHhSet6teXfiCze6JSdr8inRkmLLTDyo,1099
+fujin_cli-0.8.0.dist-info/RECORD,,