fujin-cli 0.5.0__py3-none-any.whl → 0.6.0__py3-none-any.whl

fujin/commands/init.py

@@ -54,7 +54,6 @@ def simple_config(app_name) -> dict:
         },
         "aliases": {"shell": "server exec --appenv -i bash"},
         "host": {
-            "ip": "127.0.0.1",
             "user": "root",
             "domain_name": f"{app_name}.com",
             "envfile": ".env.prod",
@@ -111,7 +110,6 @@ def binary_config(app_name: str) -> dict:
         "processes": {"web": f"{app_name} prodserver"},
         "aliases": {"shell": "server exec --appenv -i bash"},
         "host": {
-            "ip": "127.0.0.1",
             "user": "root",
             "domain_name": f"{app_name}.com",
             "envfile": ".env.prod",

fujin/config.py

@@ -14,6 +14,10 @@ python_version
 The Python version for your virtualenv. If not specified, automatically parsed from ``.python-version`` file. This is only
 required if the installation mode is set to ``python-package``
 
+requirements
+------------
+Optional path to your requirements file. This will only be used when the installation mode is set to ``python-package``
+
 versions_to_keep
 ----------------
 The number of versions to keep on the host. After each deploy, older versions are pruned based on this setting. By default, it keeps the latest 5 versions,
@@ -39,10 +43,6 @@ release_command
 ---------------
 Optional command to run at the end of deployment (e.g., database migrations).
 
-requirements
-------------
-Optional path to your requirements file. This will only be used when the installation mode is set to ``python-package``
-
 Webserver
 ---------
 
@@ -101,7 +101,7 @@ Host Configuration
 
 ip
 ~~
-The IP address or hostname of the remote host.
+The IP address or anything that resolves to the remote host IP's. This is use to communicate via ssh with the server, if omitted it's value will default to the one of the ``domain_name``.
 
 domain_name
 ~~~~~~~~~~~
@@ -234,7 +234,7 @@ class Config(msgspec.Struct, kw_only=True):
 
 
 class HostConfig(msgspec.Struct, kw_only=True):
-    ip: str
+    ip: str | None = None
     domain_name: str
     user: str
     _envfile: str = msgspec.field(name="envfile")
@@ -245,6 +245,7 @@ class HostConfig(msgspec.Struct, kw_only=True):
 
     def __post_init__(self):
         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__}

fujin/proxies/nginx.py

@@ -35,20 +35,20 @@ class WebProxy(msgspec.Struct):
         )
 
     def run_pty(self, *args, **kwargs):
-        return self.conn.run(*args, **kwargs, pty=True)
+        return self.run_pty(*args, **kwargs, pty=True)
 
     def install(self):
-        self.conn.run(
+        self.run_pty(
             "sudo apt install -y nginx libpq-dev python3-dev python3-certbot-nginx"
         )
 
     def uninstall(self):
         self.stop()
-        self.conn.run("sudo apt remove -y nginx")
-        self.conn.run(f"sudo rm /etc/nginx/sites-available/{self.app_name}.conf")
-        self.conn.run(f"sudo rm /etc/nginx/sites-enabled/{self.app_name}.conf")
-        self.conn.run("sudo systemctl disable certbot.timer")
-        self.conn.run("sudo apt remove -y python3-certbot-nginx")
+        self.run_pty("sudo apt remove -y nginx")
+        self.run_pty(f"sudo rm /etc/nginx/sites-available/{self.app_name}.conf")
+        self.run_pty(f"sudo rm /etc/nginx/sites-enabled/{self.app_name}.conf")
+        self.run_pty("sudo systemctl disable certbot.timer")
+        self.run_pty("sudo apt remove -y python3-certbot-nginx")
 
     def setup(self):
         conf = (
@@ -65,11 +65,11 @@ class WebProxy(msgspec.Struct):
         )
         if CERTBOT_EMAIL:
             cert_path = f"/etc/letsencrypt/live/{self.domain_name}/fullchain.pem"
-            cert_exists = self.conn.run(f"sudo test -f {cert_path}", warn=True).ok
+            cert_exists = self.run_pty(f"sudo test -f {cert_path}", warn=True).ok
 
             if not cert_exists:
-                self.conn.run(
-                    f"certbot --nginx -d {self.domain_name} --non-interactive --agree-tos --email {CERTBOT_EMAIL} --redirect"
+                self.run_pty(
+                    f"sudo certbot --nginx -d {self.domain_name} --non-interactive --agree-tos --email {CERTBOT_EMAIL} --redirect"
                 )
                 self.config_file.parent.mkdir(exist_ok=True)
                 self.conn.get(
@@ -83,9 +83,7 @@ class WebProxy(msgspec.Struct):
     def teardown(self):
         self.run_pty(f"sudo rm /etc/nginx/sites-available/{self.app_name}.conf")
         self.run_pty(f"sudo rm /etc/nginx/sites-enabled/{self.app_name}.conf")
-        self.run_pty(
-            "sudo systemctl restart nginx",
-        )
+        self.run_pty("sudo systemctl restart nginx")
 
     def start(self) -> None:
         self.run_pty("sudo systemctl start nginx")
@@ -109,9 +107,9 @@ class WebProxy(msgspec.Struct):
         static_locations = ""
         for path, directory in self.statics.items():
             static_locations += f"""
-        location {path} {{
-            alias {directory};
-        }}
+    location {path} {{
+        alias {directory};
+    }}
         """
 
         return f"""

{fujin_cli-0.5.0.dist-info → fujin_cli-0.6.0.dist-info}/METADATA

@@ -1,12 +1,11 @@
 Metadata-Version: 2.3
 Name: fujin-cli
-Version: 0.5.0
-Summary: Add your description here
+Version: 0.6.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
 Project-URL: Source, https://github.com/falcopackages/fujin
 Author-email: Tobi DEGNON <tobidegnon@proton.me>
-License-File: LICENSE.txt
 Keywords: caddy,deployment,django,fastapi,litestar,python,systemd
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -37,16 +36,18 @@ Description-Content-Type: text/markdown
 > [!IMPORTANT]
 > This package currently contains minimal features and is a work-in-progress
 
+<!-- content:start -->
+
 `fujin` is a simple deployment tool that helps you get your project up and running on a VPS in a few minutes. It manages your app processes using `systemd` and runs your apps behind [caddy](https://caddyserver.com/). For Python projects, 
 it expects your app to be a packaged Python application ideally with a CLI entry point defined. For other languages, you need to provide a self-contained single executable file with all necessary dependencies.
 The main job of `fujin` is to bootstrap your server (installing caddy, etc.), copy the files onto the server with a structure that supports rollback, and automatically generate configs for systemd and caddy that you can manually edit if needed.
 
-Check out the [documentation📚](https://fujin.readthedocs.io/en/latest/) for installation, features, and usage guides.
+Check out the [documentation📚](https://fujin.oluwatobi.dev/en/latest/) for installation, features, and usage guides.
 
 ## Why?
 
 I wanted [kamal](https://kamal-deploy.org/) but without Docker, and I thought the idea was fun. At its core, this project automates versions of this [tutorial](https://www.digitalocean.com/community/tutorials/how-to-set-up-django-with-postgres-nginx-and-gunicorn-on-ubuntu). If you've been a Django beginner 
-trying to get your app in production, you probably went through this. I'm using caddy instead of nginx because the configuration file simpler and it's is a no-brainer for SSL certificates. Systemd is the default on most Linux distributions and does a good enough job.
+trying to get your app in production, you probably went through this. I'm using caddy instead of nginx because it's configurable via an API and it's is a no-brainer for SSL certificates. Systemd is the default on most Linux distributions and does a good enough job.
 
 Fujin was initially planned to be a Python-only project, but the core concepts can be applied to any language that can produce a single distributable file (e.g., Go, Rust). I wanted to recreate kamal's nice local-to-remote app management API, but I'm skipping Docker to keep things simple. 
 I'm currently rocking SQLite in production for my side projects and ths setup is enough for my use case.
@@ -64,3 +65,5 @@ Fujin draws inspiration from the following tools for their developer experience.
 ## License
 
 `fujin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
+
+<!-- content:end -->

{fujin_cli-0.5.0.dist-info → fujin_cli-0.6.0.dist-info}/RECORD

@@ -1,6 +1,6 @@
 fujin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 fujin/__main__.py,sha256=St0VnEWhRRw_ukAddAwDGFliLqQT3xlone-9JIONlDI,1702
-fujin/config.py,sha256=r2Rdd7ErGGTQPLMJlqZbPEQXd6fSSQB7PNbyaurEQsQ,9394
+fujin/config.py,sha256=GecU6XklYNXjjR7bkRORBcX1-AYlIaTMw1mmYKSCSnA,9595
 fujin/connection.py,sha256=ZkYaNykRFj9Yr-K-vOrZtVVGUDurDm6W7OQrgct71CA,2428
 fujin/errors.py,sha256=74Rh-Sgql1YspPdR_akQ2G3xZ48zecyafYCptpaFo1A,73
 fujin/hooks.py,sha256=QHIqxLxujG2U70UkN1BpUplE6tTqn7pFJP5oHde1tUQ,1350
@@ -11,7 +11,7 @@ fujin/commands/config.py,sha256=xdfd1OZLxw2YZldiAbW5rq5EBXEaXbUC-I7FKLRfzIQ,2387
 fujin/commands/deploy.py,sha256=oAOLUrtHjHkmIA3D0AiaJRWEsfVk51_I29kRC_FhjYo,5463
 fujin/commands/docs.py,sha256=b5FZ8AgoAfn4q4BueEQvM2w5HCuh8-rwBqv_CRFVU8E,349
 fujin/commands/down.py,sha256=v1lAq70ApktjeHRB_1sCzjmKH8t6EXqyL4RTt7OE-f0,1716
-fujin/commands/init.py,sha256=IguExzQEPJ5CbWzG-mI6hIXUw2fd2rAEA04FK6-5l18,4021
+fujin/commands/init.py,sha256=t8uwwOi4SBqHjV8px_SkTHAeZIiIUJnFN-lf7DK6HhE,3959
 fujin/commands/proxy.py,sha256=ajXwboS0gDDiMWW7b9rtWU6WPF1h7JYYeycDyU-hQfg,3053
 fujin/commands/prune.py,sha256=C2aAN6AUS84jgRg1eiCroyiuZyaZDmf5yvGAQY9xkcg,1517
 fujin/commands/redeploy.py,sha256=JvCJBZBcCKkUw1efZwRPJMLUAV8oqBAZeSbUBLHyn3k,2185
@@ -24,12 +24,12 @@ fujin/process_managers/systemd.py,sha256=qG_4Ew8SEWtaTFOAW_XZXsMO2WjFWZ4dp5nBwAP
 fujin/proxies/__init__.py,sha256=UuWYU175tkdaz1WWRCDDpQgGfFVYYNR9PBxA3lTCNr0,695
 fujin/proxies/caddy.py,sha256=dzLD8s664_kIK-1hCE3y50JIwBd8kK9yS1LynUDRVSE,7908
 fujin/proxies/dummy.py,sha256=qBKSn8XNEA9SVwB7GzRNX2l9Iw6tUjo2CFqZjWi0FjY,465
-fujin/proxies/nginx.py,sha256=8AkbJAjj6B0fxgv671mGDbx3LY_dY5wxFov80XmSfUY,4139
+fujin/proxies/nginx.py,sha256=S2-tBaytGtehqMyeZZMPSPoXjV1GVv7S63eMtfhkGNM,4100
 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.5.0.dist-info/METADATA,sha256=_-oV3GG6q1UZHhoXF5oOVTL8t1qOk_mRhmrUNz9CB-E,4396
-fujin_cli-0.5.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-fujin_cli-0.5.0.dist-info/entry_points.txt,sha256=Y_TBtKt3j11qhwquMexZR5yqnDEqOBDACtresqQFE-s,46
-fujin_cli-0.5.0.dist-info/licenses/LICENSE.txt,sha256=0QF8XfuH0zkIHhSet6teXfiCze6JSdr8inRkmLLTDyo,1099
-fujin_cli-0.5.0.dist-info/RECORD,,
+fujin_cli-0.6.0.dist-info/METADATA,sha256=_rYue3Q7z_StHy_Z9DVdaU0RWijde8eWFlm_gwxN4GY,4452
+fujin_cli-0.6.0.dist-info/WHEEL,sha256=C2FUgwZgiLbznR-k0b_5k3Ai_1aASOXDss3lzCUsUug,87
+fujin_cli-0.6.0.dist-info/entry_points.txt,sha256=Y_TBtKt3j11qhwquMexZR5yqnDEqOBDACtresqQFE-s,46
+fujin_cli-0.6.0.dist-info/licenses/LICENSE.txt,sha256=0QF8XfuH0zkIHhSet6teXfiCze6JSdr8inRkmLLTDyo,1099
+fujin_cli-0.6.0.dist-info/RECORD,,

{fujin_cli-0.5.0.dist-info → fujin_cli-0.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.25.0
+Generator: hatchling 1.26.3
 Root-Is-Purelib: true
 Tag: py3-none-any