fujin-cli 0.7.0__tar.gz → 0.8.0__tar.gz

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/.pre-commit-config.yaml

@@ -34,3 +34,10 @@ repos:
       - id: pyproject-fmt
         args: [ "pyproject.toml" ]
         exclude: ^(examples/)
+
+  # - repo: https://github.com/asottile/reorder_python_imports
+  #   rev: v3.13.0
+  #   hooks:
+  #     - id: reorder-python-imports
+  #       args:
+  #         - "--application-directories=src"

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project will be documented in this file.
 
 This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.0] - 2024-11-23
+
+### 🚀 Features
+
+- Rewrite hooks (#30)
+
+## [0.7.1] - 2024-11-23
+
+### 🐛 Bug Fixes
+
+- Broken .venv folder can fail deploy
+
 ## [0.7.0] - 2024-11-22
 
 ### 🚀 Features

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fujin-cli
-Version: 0.7.0
+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.0 → fujin_cli-0.8.0}/docs/commands/printenv.rst

@@ -1,4 +1,4 @@
-secrets
+printenv
 =======
 
 .. cappa:: fujin.commands.printenv.Printenv

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/docs/conf.py

@@ -20,7 +20,7 @@ extensions = [
     "sphinx.ext.autodoc",
     "sphinx_design",
     "sphinx_copybutton",
-    "jupyter_sphinx",
+    "sphinx_exec_code",
     "sphinx_togglebutton",
 ]
 

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/docs/configuration.rst

@@ -13,20 +13,24 @@ This is a minimal working example.
 
     .. tab-item:: python package
 
-        .. jupyter-execute::
-            :hide-code:
+        .. exec_code::
+            :language_output: toml
 
+            # --- hide: start ---
             from fujin.commands.init import simple_config
             from tomli_w import dumps
 
             print(dumps(simple_config("bookstore")))
+            #hide:toggle
 
     .. tab-item:: binary mode
 
-        .. jupyter-execute::
-            :hide-code:
+        .. exec_code::
+            :language_output: toml
 
+            # --- hide: start ---
             from fujin.commands.init import binary_config
             from tomli_w import dumps
 
             print(dumps(binary_config("bookstore")))
+            #hide:toggle

fujin_cli-0.8.0/docs/hooks.rst

@@ -0,0 +1,41 @@
+Hooks
+=====
+
+Hooks allow you to run scripts at specific points in the deployment process. These scripts can perform checks before deployment, run tests, or send a notification after a successful deployment.
+
+The currently available ``hooks`` are:
+
+- ``pre_build``: The first action executed when the ``deploy`` command is run, before your app is built.
+- ``pre_deploy``: Executed after app is built before the code is pushed to the remote server.
+- ``post_deploy``: Executed after a successful deployment.
+
+.. note::
+
+    Hooks are run on your local machine, not on the remote server. If they fail, the deployment process is stopped.
+
+You can specify hooks in the ``fujin.toml`` file like this:
+
+.. code-block::
+
+    [hooks]
+    pre_build = "echo 'hello'"
+
+.. tip::
+
+    Using a `justfile <https://just.systems/>`_ can be an easy way to write more complex scripts without adding new files.
+
+    .. code-block::
+
+        [hooks]
+        pre_build = "just run-some-checks"
+
+Alternatively, you can create a file with the hook's name in the ``.fujin/hooks`` folder and ensure the file is executable.
+
+.. code-block::
+    :caption: .fujin/hooks/pre_build
+
+    #!/usr/bin/env bash
+
+    echo 'hello'
+
+The ``hooks`` configuration takes precedence over files in the ``.fujin/hooks`` folder; you cannot mix and match both.

fujin_cli-0.8.0/docs/requirements.txt

@@ -0,0 +1,100 @@
+# This file was autogenerated by uv via the following command:
+#    uv export --no-hashes --group docs --format requirements-txt
+-e .
+alabaster==1.0.0
+annotated-types==0.7.0
+anyio==4.6.2.post1
+asgiref==3.8.1
+astroid==3.3.5
+babel==2.16.0
+bcrypt==4.2.1
+bracex==2.5.post1
+bump-my-version==0.28.1
+cappa==0.25.1
+certifi==2024.8.30
+cffi==1.17.1
+charset-normalizer==3.4.0
+click==8.1.7
+colorama==0.4.6
+cryptography==43.0.3
+decorator==5.1.1
+deprecated==1.2.15
+django==5.1.3
+docutils==0.21.2
+exceptiongroup==1.2.2 ; python_full_version < '3.11'
+fabric==3.2.2
+faker==33.0.0
+fastapi==0.115.5
+gevent==24.11.1
+git-cliff==2.7.0
+greenlet==3.1.1 ; platform_python_implementation == 'CPython'
+h11==0.14.0
+httpcore==1.0.7
+httpx==0.27.2
+idna==3.10
+imagesize==1.4.1
+invoke==2.2.0
+jinja2==3.1.4
+litestar==2.13.0
+litestar-htmx==0.3.0
+markdown-it-py==3.0.0
+markupsafe==3.0.2
+mdit-py-plugins==0.4.2
+mdurl==0.1.2
+msgspec==0.18.6
+multidict==6.1.0
+myst-parser==4.0.0
+packaging==24.2
+paramiko==3.5.0
+polyfactory==2.18.0
+prompt-toolkit==3.0.48
+psutil==6.1.0 ; sys_platform != 'win32' or platform_python_implementation == 'CPython'
+pycparser==2.22
+pydantic==2.10.1
+pydantic-core==2.27.1
+pydantic-settings==2.6.1
+pygments==2.18.0
+pynacl==1.5.0
+python-dateutil==2.9.0.post0
+python-dotenv==1.0.1
+pyyaml==6.0.2
+questionary==1.10.0
+requests==2.32.3
+rich==13.9.4
+rich-click==1.8.4
+setuptools==75.6.0
+shibuya==2024.10.15
+six==1.16.0
+sniffio==1.3.1
+snowballstemmer==2.2.0
+sphinx==8.1.3
+sphinx-autobuild==2024.10.3
+sphinx-autodoc2==0.5.0
+sphinx-copybutton==0.5.2
+sphinx-design==0.6.1
+sphinx-exec-code==0.14
+sphinx-togglebutton==0.3.2
+sphinxcontrib-applehelp==2.0.0
+sphinxcontrib-devhelp==2.0.0
+sphinxcontrib-htmlhelp==2.1.0
+sphinxcontrib-jsmath==1.0.1
+sphinxcontrib-qthelp==2.0.0
+sphinxcontrib-serializinghtml==2.0.0
+sqlparse==0.5.2
+starlette==0.41.3
+tomli==2.1.0 ; python_full_version < '3.11'
+tomli-w==1.1.0
+tomlkit==0.13.2
+type-lens==0.2.3
+typing-extensions==4.12.2
+tzdata==2024.2 ; sys_platform == 'win32'
+urllib3==2.2.3
+uvicorn==0.32.1
+watchfiles==0.24.0
+wcmatch==10.0
+wcwidth==0.2.13
+websockets==14.1
+wheel==0.45.1
+wrapt==1.17.0
+zope-event==5.0
+zope-interface==7.1.1

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/pyproject.toml

@@ -7,7 +7,7 @@ requires = [
 
 [project]
 name = "fujin-cli"
-version = "0.7.0"
+version = "0.8.0"
 description = "Get your project up and running in a few minutes on your own vps."
 readme = "README.md"
 keywords = [
@@ -61,13 +61,13 @@ dev = [
   "litestar>=2.12.1",
 ]
 docs = [
-  "jupyter-sphinx>=0.5.3",
   "myst-parser",
   "shibuya",
   "sphinx-autobuild",
   "sphinx-autodoc2>=0.5",
   "sphinx-copybutton",
   "sphinx-design",
+  "sphinx-exec-code>=0.14",
   "sphinx-togglebutton>=0.3.2",
 ]
 
@@ -116,12 +116,12 @@ lint.select = [
   "B",  # flake8-bugbear
   "E",  # Pycodestyle
   "F",  # Pyflakes
-  "I",  # isort
   "UP", # pyupgrade
 ]
 lint.ignore = [
   "E501",
   "E741",
+  "I",    # isort
 ] # temporary
 # Tests can use magic values, assertions, and relative imports
 lint.per-file-ignores."tests/**/*" = [
@@ -154,7 +154,7 @@ lint.isort.required-imports = [
 lint.pyupgrade.keep-runtime-typing = true
 
 [tool.bumpversion]
-current_version = "0.7.0"
+current_version = "0.8.0"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = [
   "{major}.{minor}.{patch}",

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/commands/__init__.py

@@ -1,2 +1 @@
 from ._base import BaseCommand  # noqa
-from ._base import BaseCommand  # noqa

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/commands/_base.py

@@ -6,7 +6,8 @@ from functools import cached_property
 import cappa
 
 from fujin.config import Config
-from fujin.connection import host_connection, Connection
+from fujin.connection import Connection
+from fujin.connection import host_connection
 from fujin.errors import ImproperlyConfiguredError
 from fujin.hooks import HookManager
 from fujin.process_managers import ProcessManager
@@ -32,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:
@@ -69,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_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/commands/deploy.py

@@ -7,8 +7,8 @@ import cappa
 
 from fujin.commands import BaseCommand
 from fujin.config import InstallationMode
-from fujin.secrets import resolve_secrets
 from fujin.connection import Connection
+from fujin.secrets import resolve_secrets
 
 
 @cappa.command(
@@ -16,15 +16,15 @@ from fujin.connection import Connection
 )
 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
@@ -100,6 +100,7 @@ export PATH=".venv/bin:$PATH"
         conn.run(f"echo '{appenv.strip()}' > {self.app_dir}/.appenv")
         versioned_assets_dir = f"{self.app_dir}/v{version}"
         if not skip_setup:
+            conn.run("rm -rf .venv")
             conn.run("uv venv")
             if self.config.requirements:
                 conn.run(f"uv pip install -r {versioned_assets_dir}/requirements.txt")

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/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_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/commands/init.py

@@ -8,7 +8,8 @@ import cappa
 import tomli_w
 
 from fujin.commands import BaseCommand
-from fujin.config import tomllib, InstallationMode
+from fujin.config import InstallationMode
+from fujin.config import tomllib
 
 
 @cappa.command(help="Generate a sample configuration file")

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/commands/printenv.py

@@ -5,12 +5,14 @@ from fujin.secrets import resolve_secrets
 
 
 @cappa.command(
-    help="Print the content of the envfile with extracted secrets (for debugging)"
+    help="Display the contents of the envfile with resolved secrets (for debugging purposes)"
 )
 class Printenv(BaseCommand):
     def __call__(self):
         if self.config.secret_config:
-            result = resolve_secrets(self.config.host.envfile, self.config.secret_config)
+            result = resolve_secrets(
+                self.config.host.envfile, self.config.secret_config
+            )
         else:
             result = self.config.host.envfile.read_text()
         self.stdout.output(result)

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/commands/redeploy.py

@@ -6,21 +6,20 @@ from pathlib import Path
 import cappa
 
 from fujin.commands import BaseCommand
-from .deploy import Deploy
 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_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/commands/rollback.py

@@ -1,7 +1,8 @@
 from dataclasses import dataclass
 
 import cappa
-from rich.prompt import Prompt, Confirm
+from rich.prompt import Confirm
+from rich.prompt import Prompt
 
 from fujin.commands import BaseCommand
 from fujin.commands.deploy import Deploy

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/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_cli-0.7.0 → fujin_cli-0.8.0}/src/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_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/connection.py

@@ -8,11 +8,9 @@ import cappa
 from fabric import Connection
 from invoke import Responder
 from invoke.exceptions import UnexpectedExit
-from paramiko.ssh_exception import (
-    AuthenticationException,
-    NoValidConnectionsError,
-    SSHException,
-)
+from paramiko.ssh_exception import AuthenticationException
+from paramiko.ssh_exception import NoValidConnectionsError
+from paramiko.ssh_exception import SSHException
 
 if TYPE_CHECKING:
     from fujin.config import HostConfig

fujin_cli-0.8.0/src/fujin/hooks.py

@@ -0,0 +1,59 @@
+import subprocess
+from dataclasses import dataclass
+from pathlib import Path
+
+import cappa
+from rich import print as rich_print
+
+try:
+    from enum import StrEnum
+except ImportError:
+    from enum import Enum
+
+    class StrEnum(str, Enum):
+        pass
+
+
+class Hook(StrEnum):
+    PRE_BUILD = "pre_build"
+    PRE_DEPLOY = "pre_deploy"
+    POST_DEPLOY = "post_deploy"
+
+
+HooksDict = dict[Hook, str]
+
+
+@dataclass(slots=True)
+class HookManager:
+    app_name: str
+    hooks: HooksDict
+    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 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)

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/secrets/__init__.py

@@ -1,13 +1,15 @@
 from __future__ import annotations
 
 from pathlib import Path
+from typing import Callable
+
 import gevent
 from dotenv import dotenv_values
-from typing import Callable
 
-from fujin.config import SecretConfig, SecretAdapter
 from .bitwarden import bitwarden
 from .onepassword import one_password
+from fujin.config import SecretAdapter
+from fujin.config import SecretConfig
 
 
 secret_reader = Callable[[str], str]

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/secrets/bitwarden.py

@@ -1,12 +1,14 @@
 from __future__ import annotations
-import cappa
+
 import os
+import subprocess
+from contextlib import contextmanager
+from typing import Generator
+from typing import TYPE_CHECKING
 
+import cappa
 
 from fujin.config import SecretConfig
-import subprocess
-from contextlib import contextmanager
-from typing import Generator, TYPE_CHECKING
 
 if TYPE_CHECKING:
     from . import secret_reader
@@ -25,7 +27,16 @@ def bitwarden(secret_config: SecretConfig) -> Generator[secret_reader, None, Non
 
     def read_secret(name: str) -> str:
         result = subprocess.run(
-            ["bw", "get", "password", name, "--raw", "--session", session, "--nointeraction"],
+            [
+                "bw",
+                "get",
+                "password",
+                name,
+                "--raw",
+                "--session",
+                session,
+                "--nointeraction",
+            ],
             capture_output=True,
             text=True,
         )

{fujin_cli-0.7.0 → fujin_cli-0.8.0}/src/fujin/secrets/onepassword.py

@@ -1,12 +1,13 @@
 from __future__ import annotations
-import cappa
-
 
-from fujin.config import SecretConfig
 import subprocess
-
 from contextlib import contextmanager
-from typing import Generator, TYPE_CHECKING
+from typing import Generator
+from typing import TYPE_CHECKING
+
+import cappa
+
+from fujin.config import SecretConfig
 
 if TYPE_CHECKING:
     from . import secret_reader