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

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

@@ -4,6 +4,16 @@ 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.9.0] - 2024-11-23
+
+### 🚀 Features
+
+- Env content can be define directly in toml
+
+### 🚜 Refactor
+
+- Avoid running secret adapter if no secret placeholder is found
+
 ## [0.8.0] - 2024-11-23
 
 ### 🚀 Features

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: fujin-cli
-Version: 0.8.0
+Version: 0.9.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.8.0 → fujin_cli-0.9.0}/docs/configuration.rst

@@ -20,7 +20,7 @@ This is a minimal working example.
             from fujin.commands.init import simple_config
             from tomli_w import dumps
 
-            print(dumps(simple_config("bookstore")))
+            print(dumps(simple_config("bookstore"),  multiline_strings=True))
             #hide:toggle
 
     .. tab-item:: binary mode
@@ -32,5 +32,5 @@ This is a minimal working example.
             from fujin.commands.init import binary_config
             from tomli_w import dumps
 
-            print(dumps(binary_config("bookstore")))
+            print(dumps(binary_config("bookstore"),  multiline_strings=True))
             #hide:toggle

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

@@ -7,7 +7,7 @@ requires = [
 
 [project]
 name = "fujin-cli"
-version = "0.8.0"
+version = "0.9.0"
 description = "Get your project up and running in a few minutes on your own vps."
 readme = "README.md"
 keywords = [
@@ -154,7 +154,7 @@ lint.isort.required-imports = [
 lint.pyupgrade.keep-runtime-typing = true
 
 [tool.bumpversion]
-current_version = "0.8.0"
+current_version = "0.9.0"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = [
   "{major}.{minor}.{patch}",

{fujin_cli-0.8.0 → fujin_cli-0.9.0}/src/fujin/commands/config.py

@@ -37,9 +37,17 @@ class ConfigCMD(BaseCommand):
             )
         )
 
+        host_config = {
+            f: getattr(self.config.host, f) for f in self.config.host.__struct_fields__
+        }
+        host_config.pop("_key_filename")
+        host_config.pop("_env_file")
+        host_config.pop("env_content")
+        if self.config.host.key_filename:
+            host_config["key_filename"] = self.config.host.key_filename
+        host_config["env_content"] = self.config.host.env_content
         host_config_text = "\n".join(
-            f"[dim]{key}:[/dim] {value}"
-            for key, value in self.config.host.to_dict().items()
+            f"[dim]{key}:[/dim] {value}" for key, value in host_config.items()
         )
         console.print(
             Panel(

{fujin_cli-0.8.0 → fujin_cli-0.9.0}/src/fujin/commands/deploy.py

@@ -52,15 +52,15 @@ class Deploy(BaseCommand):
         return f"{self.app_dir}/v{self.config.version}"
 
     def parse_envfile(self) -> str:
-        if not self.config.host.envfile.exists():
-            raise cappa.Exit(f"{self.config.host.envfile} not found", code=1)
         if self.config.secret_config:
             self.stdout.output("[blue]Reading secrets....[/blue]")
-            return resolve_secrets(self.config.host.envfile, self.config.secret_config)
-        return self.config.host.envfile.read_text()
+            return resolve_secrets(
+                self.config.host.env_content, self.config.secret_config
+            )
+        return self.config.host.env_content
 
     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_cli-0.8.0 → fujin_cli-0.9.0}/src/fujin/commands/init.py

@@ -31,7 +31,7 @@ class Init(BaseCommand):
         }
         app_name = Path().resolve().stem.replace("-", "_").replace(" ", "_").lower()
         config = profile_to_func[self.profile](app_name)
-        fujin_toml.write_text(tomli_w.dumps(config))
+        fujin_toml.write_text(tomli_w.dumps(config, multiline_strings=True))
         self.stdout.output(
             "[green]Sample configuration file generated successfully![/green]"
         )
@@ -57,7 +57,7 @@ def simple_config(app_name) -> dict:
         "host": {
             "user": "root",
             "domain_name": f"{app_name}.com",
-            "envfile": ".env.prod",
+            "env_content": f"DEBUG=False\nALLOWED_HOSTS={app_name}.com\n",
         },
     }
     if not Path(".python-version").exists():

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

@@ -11,8 +11,8 @@ class Printenv(BaseCommand):
     def __call__(self):
         if self.config.secret_config:
             result = resolve_secrets(
-                self.config.host.envfile, self.config.secret_config
+                self.config.host.env_content, self.config.secret_config
             )
         else:
-            result = self.config.host.envfile.read_text()
+            result = self.config.host.env_content
         self.stdout.output(result)

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

@@ -34,8 +34,8 @@ class Redeploy(BaseCommand):
 
     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.8.0 → fujin_cli-0.9.0}/src/fujin/config.py

@@ -136,10 +136,18 @@ The login user for running remote tasks. Should have passwordless sudo access fo
 
     You can create a user with these requirements using the ``fujin server create-user`` command.
 
-envfile
-~~~~~~~
+env_file
+~~~~~~~~
 Path to the production environment file that will be copied to the host.
 
+env_content
+~~~~~~~~~~~
+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.
+
+.. important::
+
+    ``env_file`` and ``env_content`` are mutually exclusive—you can define only one.
+
 apps_dir
 ~~~~~~~~
 
@@ -178,7 +186,7 @@ Example:
 
 hooks
 -----
-Run custom scripts at specific points with hooks. Check out the `secrets </hooks.html>`_ page for more information.
+Run custom scripts at specific points with hooks. Check out the `hooks </hooks.html>`_ page for more information.
 
 """
 
@@ -271,28 +279,27 @@ class HostConfig(msgspec.Struct, kw_only=True):
     ip: str | None = None
     domain_name: str
     user: str
-    _envfile: str = msgspec.field(name="envfile")
+    _env_file: str = msgspec.field(name="envfile", default="")
+    env_content: str = ""
     apps_dir: str = ".local/share/fujin"
     password_env: str | None = None
     ssh_port: int = 22
     _key_filename: str | None = msgspec.field(name="key_filename", default=None)
 
     def __post_init__(self):
+        if self._env_file and self.env_content:
+            raise ImproperlyConfiguredError(
+                "Cannot set both 'env_content' and 'env_file' properties."
+            )
+        if not self.env_content:
+            envfile = Path(self._env_file)
+            if not envfile.exists():
+                raise ImproperlyConfiguredError(f"{self._env_file} not found")
+            self.env_content = envfile.read_text()
+        self.env_content = self.env_content.strip()
         self.apps_dir = f"/home/{self.user}/{self.apps_dir}"
         self.ip = self.ip or self.domain_name
 
-    def to_dict(self):
-        d = {f: getattr(self, f) for f in self.__struct_fields__}
-        d.pop("_key_filename")
-        d.pop("_envfile")
-        d["key_filename"] = self.key_filename
-        d["envfile"] = self.envfile
-        return d
-
-    @property
-    def envfile(self) -> Path:
-        return Path(self._envfile)
-
     @property
     def key_filename(self) -> Path | None:
         if self._key_filename:

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

@@ -1,19 +1,19 @@
 from __future__ import annotations
 
-from pathlib import Path
-from typing import Callable
+from contextlib import closing
+from io import StringIO
+from typing import Callable, ContextManager
 
 import gevent
 from dotenv import dotenv_values
 
-from .bitwarden import bitwarden
-from .onepassword import one_password
 from fujin.config import SecretAdapter
 from fujin.config import SecretConfig
-
+from .bitwarden import bitwarden
+from .onepassword import one_password
 
 secret_reader = Callable[[str], str]
-secret_adapter_context = Callable[[SecretConfig], secret_reader]
+secret_adapter_context = Callable[[SecretConfig], ContextManager[secret_reader]]
 
 adapter_to_context: dict[SecretAdapter, secret_adapter_context] = {
     SecretAdapter.BITWARDEN: bitwarden,
@@ -21,14 +21,17 @@ adapter_to_context: dict[SecretAdapter, secret_adapter_context] = {
 }
 
 
-def resolve_secrets(envfile: Path, secret_config: SecretConfig) -> str:
-    env_dict = dotenv_values(envfile)
+def resolve_secrets(env_content: str, secret_config: SecretConfig) -> str:
+    with closing(StringIO(env_content)) as buffer:
+        env_dict = dotenv_values(stream=buffer)
     secrets = {key: value for key, value in env_dict.items() if value.startswith("$")}
+    if not secrets:
+        return env_content
     adapter_context = adapter_to_context[secret_config.adapter]
     parsed_secrets = {}
-    with adapter_context(secret_config) as secret_reader:
+    with adapter_context(secret_config) as reader:
         for key, secret in secrets.items():
-            parsed_secrets[key] = gevent.spawn(secret_reader, secret[1:])
+            parsed_secrets[key] = gevent.spawn(reader, secret[1:])
         gevent.joinall(parsed_secrets.values())
     env_dict.update({key: thread.value for key, thread in parsed_secrets.items()})
     return "\n".join(f'{key}="{value}"' for key, value in env_dict.items())

{fujin_cli-0.8.0 → fujin_cli-0.9.0}/uv.lock

@@ -477,7 +477,7 @@ wheels = [
 
 [[package]]
 name = "fujin-cli"
-version = "0.8.0"
+version = "0.9.0"
 source = { editable = "." }
 dependencies = [
     { name = "cappa" },