fujin-cli 0.11.5__tar.gz → 0.12.1__tar.gz

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/CHANGELOG.md

@@ -4,43 +4,36 @@ 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.11.4] - 2025-03-08
+## [0.12.1] - 2025-03-12
 
 ### 🐛 Bug Fixes
 
-- No mutable default
+- Force .venv removal on deploy
 
-## [0.11.3] - 2025-03-08
-
-### Cfeat
+### 📚 Documentation
 
-- Add fujin version info
+- Document integration with ci ci platforms
 
-## [0.11.2] - 2025-03-08
+## [0.12.0] - 2025-03-08
 
 ### 🚀 Features
 
+- Add process name to systemd service
+- Add fujin version info
 - Set system as the default secrets adapter
-
-## [0.11.1] - 2025-03-08
+- Add system secret reader
 
 ### 🐛 Bug Fixes
 
 - Env content parse logic
 
-## [0.11.0] - 2025-03-08
-
-### 🚀 Features
-
-- Add system secret reader
-
 ### 🚜 Refactor
 
 - Rename env_content to env
 
 ### 📚 Documentation
 
-- Apply a more consitent writing style
+- Apply a more consistent writing style
 
 ### ⚙️ Miscellaneous Tasks
 

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fujin-cli
-Version: 0.11.5
+Version: 0.12.1
 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.11.5 → fujin_cli-0.12.1}/docs/index.rst

@@ -24,6 +24,7 @@ fujin documentation
    configuration
    commands/index
    secrets
+   integrations
    hooks
    changelog
 

fujin_cli-0.12.1/docs/integrations.rst

@@ -0,0 +1,149 @@
+Integrations
+------------
+
+This guide explains how to integrate Fujin with CI/CD platforms for automated deployments.
+
+CI/CD Integration Setup
+=======================
+
+To integrate Fujin with CI/CD platforms like GitLab CI or GitHub Actions, follow these steps:
+
+1. SSH Key Setup
+****************
+
+You have two options for SSH authentication:
+
+**Option 1: Use your existing SSH key (Recommended)**
+   - If you're already using Fujin with this host on your laptop, you already have a working SSH key
+   - Copy your private key to use in your CI/CD environment
+
+**Option 2: Generate a new deployment key**
+   - Generate a new SSH key pair specifically for CI/CD:
+     
+     .. code-block:: bash
+         
+         ssh-keygen -t ed25519 -C "deployment@example.com" -f deployment_key
+   
+   - Add the public key to your server's authorized keys:
+     
+     .. code-block:: bash
+         
+         ssh-copy-id -i deployment_key.pub user@your-server.com
+
+2. Configure CI/CD Environment Variables
+****************************************
+
+Add your private SSH key as a CI/CD environment variable:
+
+- In GitLab: Go to Settings → CI/CD → Variables
+- In GitHub: Go to Settings → Secrets and variables → Actions
+
+Create a variable named ``SSH_PRIVATE_KEY`` with the contents of your private key.
+
+3. Configure Host Environment Variables
+***************************************
+
+Instead of using an environment file, use the ``env`` property in your host configuration:
+
+.. code-block:: toml
+    :caption: fujin.toml
+
+    [host]
+    domain_name = "example.com"
+    user = "deploy"
+    # Use this instead of envfile for CI/CD environments
+    env = """
+    DEBUG=False
+    SECRET_KEY=$SECRET_KEY
+    DATABASE_URL=$DATABASE_URL
+    """
+
+For sensitive values, use the secrets feature to fetch from environment variables:
+
+.. code-block:: toml
+    :caption: fujin.toml
+
+    [secrets]
+    adapter = "system"  # Use system environment variables
+
+The secret values will be substituted from the CI/CD environment variables. See the `secrets documentation </secrets.html>`_ for other secret manager options like Bitwarden, 1Password, or Doppler.
+
+Gitlab CI / CD
+==============
+
+Here's a complete example for GitLab CI/CD:
+
+.. code-block:: yaml
+    :caption: gitlab-ci.yml
+
+    stages:
+      - deploy
+
+    deploy:
+      stage: deploy
+      image: alpine:latest
+      before_script:
+        - mkdir -p ~/.ssh
+        - echo "$SSH_PRIVATE_KEY" | tr -d '\r' > ~/.ssh/id_rsa
+        - chmod 600 ~/.ssh/id_rsa
+        - ssh-keyscan -H example.com >> ~/.ssh/known_hosts
+      script:
+        - curl -LsSf https://astral.sh/uv/install.sh | sh
+        - $HOME/.local/bin/uv tool install --upgrade fujin-cli
+        - $HOME/.local/bin/fujin --version
+        - $HOME/.local/bin/fujin deploy
+      tags:
+        - production
+      only:
+        - main
+
+Make sure to:
+1. Set ``SSH_PRIVATE_KEY`` in your GitLab CI/CD variables
+2. Set any secret environment variables needed by your application
+3. Replace ``example.com`` with your actual server domain in the ssh-keyscan command
+
+Github Actions
+==============
+
+Here's a complete example for GitHub Actions:
+
+.. code-block:: yaml
+    :caption: .github/workflows/deploy.yml
+
+    name: Deploy Application
+    
+    on:
+      push:
+        branches: [ main ]
+    
+    jobs:
+      deploy:
+        runs-on: ubuntu-latest
+        
+        steps:
+        - uses: actions/checkout@v3
+        
+        - name: Set up SSH
+          run: |
+            mkdir -p ~/.ssh
+            echo "${{ secrets.SSH_PRIVATE_KEY }}" > ~/.ssh/id_rsa
+            chmod 600 ~/.ssh/id_rsa
+            ssh-keyscan -H example.com >> ~/.ssh/known_hosts
+
+        - name: Install uv
+          uses: astral-sh/setup-uv@v5
+        
+        - name: Install Fujin
+          run: uv tool install --upgrade fujin-cli
+        
+        - name: Deploy with Fujin
+          run: fujin deploy
+          env:
+            # Add your application's secret environment variables here
+            SECRET_KEY: ${{ secrets.SECRET_KEY }}
+            DATABASE_PASSWORD: ${{ secrets.DATABASE_PASSWORD }}
+
+Make sure to:
+1. Create the ``SSH_PRIVATE_KEY`` secret in your GitHub repository
+2. Create any application secret variables in your GitHub repository
+3. Replace ``example.com`` with your actual server domain in the ssh-keyscan command

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/pyproject.toml

@@ -7,7 +7,7 @@ requires = [
 
 [project]
 name = "fujin-cli"
-version = "0.11.5"
+version = "0.12.1"
 description = "Get your project up and running in a few minutes on your own vps."
 readme = "README.md"
 keywords = [
@@ -152,7 +152,7 @@ lint.isort.required-imports = [
 lint.pyupgrade.keep-runtime-typing = true
 
 [tool.bumpversion]
-current_version = "0.11.5"
+current_version = "0.12.1"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = [
   "{major}.{minor}.{patch}",
@@ -177,9 +177,9 @@ search = 'version = "{current_version}"'
 replace = 'version = "{new_version}"'
 
 [[tool.bumpversion.files]]
-filename = "src/fujin/__main__.py"
-replace = 'version="{new_version}"'
-search = 'version="{current_version}"'
+filename = "src/fujin/__init__.py"
+replace = '__version__ = "{new_version}"'
+search = '__version__ = "{current_version}"'
 
 [tool.mypy]
 check_untyped_defs = true

fujin_cli-0.12.1/src/fujin/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.12.1"

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/src/fujin/__main__.py

@@ -7,6 +7,7 @@ import sys
 from pathlib import Path
 
 import cappa
+import fujin
 
 from fujin.commands.app import App
 from fujin.commands.config import ConfigCMD
@@ -50,9 +51,9 @@ class Fujin:
 def main():
     alias_cmd = _parse_aliases()
     if alias_cmd:
-        cappa.invoke(Fujin, argv=alias_cmd, version="0.11.5")
+        cappa.invoke(Fujin, argv=alias_cmd, version=fujin.__version__)
     else:
-        cappa.invoke(Fujin, version="0.11.5")
+        cappa.invoke(Fujin, version=fujin.__version__)
 
 
 def _parse_aliases() -> list[str] | None:

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/src/fujin/commands/_base.py

@@ -2,6 +2,7 @@ import importlib
 from contextlib import contextmanager
 from dataclasses import dataclass
 from functools import cached_property
+from typing import Generator
 
 import cappa
 
@@ -47,7 +48,7 @@ class BaseCommand:
             yield conn
 
     @contextmanager
-    def app_environment(self) -> Connection:
+    def app_environment(self) -> Generator[Connection, None, None]:
         with self.connection() as conn:
             with conn.cd(self.app_dir):
                 with conn.prefix("source .appenv"):

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/src/fujin/commands/deploy.py

@@ -100,7 +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("sudo 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.11.5 → fujin_cli-0.12.1}/src/fujin/config.py

@@ -149,7 +149,9 @@ Path to the production environment file that will be copied to the host.
 
 env
 ~~~
-A string containing the production environment variables, ideal for scenarios where most variables are retrieved from secrets and you prefer not to use a separate file.
+A string containing the production environment variables. In combination with the secrets manager, this is most useful when
+you want to automate deployment through a CI/CD platform like GitLab CI or GitHub Actions. For an example of how to do this,
+check out the `integrations guide </integrations.html>`_
 
 .. important::
 

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/src/fujin/connection.py

@@ -2,7 +2,7 @@ from __future__ import annotations
 
 from contextlib import contextmanager
 from functools import partial
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Generator
 
 import cappa
 from fabric import Connection
@@ -32,7 +32,7 @@ def _get_watchers(host: HostConfig) -> list[Responder]:
 
 
 @contextmanager
-def host_connection(host: HostConfig) -> Connection:
+def host_connection(host: HostConfig) -> Generator[Connection, None, None]:
     connect_kwargs = None
     if host.key_filename:
         connect_kwargs = {"key_filename": str(host.key_filename)}

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/src/fujin/hooks.py

@@ -10,6 +10,7 @@ try:
 except ImportError:
     from enum import Enum
 
+
     class StrEnum(str, Enum):
         pass
 
@@ -36,9 +37,9 @@ class HookManager:
         if not hooks_folder.exists():
             return
         self.hooks = {
-            h.value: f"./{hooks_folder / h.value}"  # noqa
+            h: f"./{hooks_folder / h.value}"
             for h in Hook
-            if (hooks_folder / h.value).exists()  # noqa
+            if (hooks_folder / h.value).exists()
         }
 
     def _run_hook(self, type_: Hook) -> None:

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/src/fujin/systemd.py

@@ -102,7 +102,7 @@ class ProcessManager:
             body = (
                 local_config.read_text()
                 if local_config.exists() and not ignore_local
-                else template.format(**context, command=command)
+                else template.format(**context, command=command, process_name=name)
             )
             files.append((name, body))
         # if using unix then we are sure a web process was defined and the proxy is not dummy

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/src/fujin/templates/simple.service

@@ -1,7 +1,6 @@
 # All options are documented here https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html
 [Unit]
 Description={app_name} {process_name}
-After=network.target
 
 [Service]
 User={user}

{fujin_cli-0.11.5/src/fujin/templates/gunicorn → fujin_cli-0.12.1/src/fujin/templates}/web.service

@@ -1,13 +1,13 @@
 # All options are documented here https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html
 # Inspiration was taken from here https://docs.gunicorn.org/en/stable/deploy.html#systemd
 [Unit]
-Description={app_name} daemon
+Description={app_name} {process_name}
 Requires={app_name}.socket
 After=network.target
 
 [Service]
-Type=notify
-NotifyAccess=main
+#Type=notify
+#NotifyAccess=main
 User={user}
 Group={user}
 RuntimeDirectory={app_name}
@@ -22,4 +22,4 @@ PrivateTmp=true
 ProtectSystem=strict
 
 [Install]
-WantedBy=multi-user.target
+WantedBy=multi-user.target

{fujin_cli-0.11.5/src/fujin/templates/gunicorn → fujin_cli-0.12.1/src/fujin/templates}/web.socket

@@ -8,4 +8,4 @@ SocketGroup=www-data
 SocketMode=0660
 
 [Install]
-WantedBy=sockets.target
+WantedBy=sockets.target

{fujin_cli-0.11.5 → fujin_cli-0.12.1}/uv.lock

@@ -478,7 +478,7 @@ wheels = [
 
 [[package]]
 name = "fujin-cli"
-version = "0.11.4"
+version = "0.12.1"
 source = { editable = "." }
 dependencies = [
     { name = "cappa" },

fujin_cli-0.11.5/src/fujin/templates/granian/web.service

@@ -1,22 +0,0 @@
-# All options are documented here https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html
-# Inspiration was taken from here https://docs.gunicorn.org/en/stable/deploy.html#systemd
-[Unit]
-Description={app_name} daemon
-After=network.target
-
-[Service]
-User={user}
-Group={user}
-RuntimeDirectory={app_name}
-WorkingDirectory={app_dir}
-ExecStart={app_dir}/{command}
-EnvironmentFile={app_dir}/.env
-ExecReload=/bin/kill -s HUP $MAINPID
-KillMode=mixed
-TimeoutStopSec=5
-PrivateTmp=true
-# if your app does not need administrative capabilities, let systemd know
-ProtectSystem=strict
-
-[Install]
-WantedBy=multi-user.target

fujin_cli-0.11.5/src/fujin/templates/web.service

@@ -1,22 +0,0 @@
-# All options are documented here https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html
-# Inspiration was taken from here https://docs.gunicorn.org/en/stable/deploy.html#systemd
-[Unit]
-Description={app_name} daemon
-After=network.target
-
-[Service]
-User={user}
-Group={user}
-RuntimeDirectory={app_name}
-WorkingDirectory={app_dir}
-ExecStart={app_dir}/{command}
-EnvironmentFile={app_dir}/.env
-ExecReload=/bin/kill -s HUP $MAINPID
-KillMode=mixed
-TimeoutStopSec=5
-PrivateTmp=true
-# if your app does not need administrative capabilities, let systemd know
-ProtectSystem=strict
-
-[Install]
-WantedBy=multi-user.target

fujin_cli-0.11.5/src/fujin/templates/web.socket

@@ -1,11 +0,0 @@
-[Unit]
-Description={app_name} socket
-
-[Socket]
-ListenStream=/run/{app_name}.sock
-SocketUser=www-data
-SocketGroup=www-data
-SocketMode=0660
-
-[Install]
-WantedBy=sockets.target