fujin-cli 0.1.0__py3-none-any.whl → 0.3.0__py3-none-any.whl

fujin/templates/web.service

@@ -0,0 +1,25 @@
+# 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
+Requires={app_name}.socket
+After=network.target
+
+[Service]
+#Type=notify
+#NotifyAccess=main
+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/templates/web.socket

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

fujin_cli-0.3.0.dist-info/METADATA

@@ -0,0 +1,66 @@
+Metadata-Version: 2.3
+Name: fujin-cli
+Version: 0.3.0
+Summary: Add your description here
+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
+Classifier: Natural Language :: English
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: cappa>=0.24
+Requires-Dist: fabric>=3.2.2
+Requires-Dist: msgspec[toml]>=0.18.6
+Requires-Dist: rich>=13.9.2
+Description-Content-Type: text/markdown
+
+# fujin
+
+[![PyPI - Version](https://img.shields.io/pypi/v/fujin-cli.svg)](https://pypi.org/project/fujin-cli)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fujin-cli.svg)](https://pypi.org/project/fujin-cli)
+[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/falcopackages/fujin/blob/main/LICENSE.txt)
+[![Status](https://img.shields.io/pypi/status/fujin-cli.svg)](https://pypi.org/project/fujin-cli)
+-----
+
+> [!IMPORTANT]
+> This package currently contains minimal features and is a work-in-progress
+
+`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.
+
+## 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.
+
+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.
+
+The goal is to automate deployment while leaving you in full control of your Linux box. It's not a CLI PaaS - it's simple and expects you to be able to SSH into your server and troubleshoot if necessary. For beginners, it makes the initial deployment easier while you get your hands dirty with Linux.
+If you need a never-break, worry-free, set-it-and-forget-it setup that auto-scales and does all the magic, fujin probably isn't for you.
+
+## Inspiration and alternatives
+
+Fujin draws inspiration from the following tools for their developer experience. These are better alternatives if you need a more robust, set-and-forget solution
+
+- [fly.io](https://fly.io/)
+- [kamal](https://kamal-deploy.org/) (you probably can't just forget this one)
+
+## License
+
+`fujin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

fujin_cli-0.3.0.dist-info/RECORD

@@ -0,0 +1,35 @@
+fujin/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+fujin/__main__.py,sha256=St0VnEWhRRw_ukAddAwDGFliLqQT3xlone-9JIONlDI,1702
+fujin/config.py,sha256=OYcQPhYYcLJ2ImVP-BNodWvaJ6Y5mRIeB9R3cohbV94,8678
+fujin/connection.py,sha256=ZkYaNykRFj9Yr-K-vOrZtVVGUDurDm6W7OQrgct71CA,2428
+fujin/errors.py,sha256=74Rh-Sgql1YspPdR_akQ2G3xZ48zecyafYCptpaFo1A,73
+fujin/hooks.py,sha256=QHIqxLxujG2U70UkN1BpUplE6tTqn7pFJP5oHde1tUQ,1350
+fujin/commands/__init__.py,sha256=uIGGXt8YofL5RZn8KIy153ioWGoCl32ffHtqOhB-6ZM,78
+fujin/commands/_base.py,sha256=o3R4-c3XeFWTIW3stiUdrcCPwdjzfjUVIpZy2L1-gZ4,2525
+fujin/commands/app.py,sha256=LUC4mmvkp1F4a96UP9hgd5y_R9HA8Xc_TtNAsYtXvvs,5153
+fujin/commands/config.py,sha256=HAiea_ebhvBzUG7vddMH3ldjZKRHU1KFaZlDZI1XmMg,2322
+fujin/commands/deploy.py,sha256=mUvlDF6yv05wnQqhsFC-LCPVvaJVfnQnK97CFB_ttVY,4427
+fujin/commands/docs.py,sha256=b5FZ8AgoAfn4q4BueEQvM2w5HCuh8-rwBqv_CRFVU8E,349
+fujin/commands/down.py,sha256=JrwDZjcqyx5Mx7IzcAkzq1zAPBD5MQMIS4gzBEUz3JM,1721
+fujin/commands/init.py,sha256=nkIRCmk5F1jfoBlPI1FSnKZJ_jn4zroBZMtbqmelXtI,2887
+fujin/commands/proxy.py,sha256=w8XOhirD5lLnmW3SC27bahoIt2XtgydQ-8LxOP-DpYM,2552
+fujin/commands/prune.py,sha256=C2aAN6AUS84jgRg1eiCroyiuZyaZDmf5yvGAQY9xkcg,1517
+fujin/commands/redeploy.py,sha256=suSr6S54oLsnKGjJgq3uHxCRFcrCX5C-5BkmH5MzQks,1864
+fujin/commands/rollback.py,sha256=BN9vOTEBcSSpFIfck9nzWvMVO7asVC20lQbcNrxRchg,2009
+fujin/commands/secrets.py,sha256=1xZQVkvbopsAcWUocLstxPKxsvmGoE2jWip5hdTrP50,162
+fujin/commands/server.py,sha256=n0FZbNI4IO5AOMJTIVfJqgb32-QSrWEu0IVwfREsRbY,3637
+fujin/commands/up.py,sha256=DgDN-1mc_mMHJRCIvcB947Cd5a7phunu9NpXloGK0UU,419
+fujin/process_managers/__init__.py,sha256=MhhfTBhm64zWRAKgjvsZRIToOUJus60vGScbAjqpQ6Y,994
+fujin/process_managers/systemd.py,sha256=qG_4Ew8SEWtaTFOAW_XZXsMO2WjFWZ4dp5nBwAPBObk,5603
+fujin/proxies/__init__.py,sha256=UuWYU175tkdaz1WWRCDDpQgGfFVYYNR9PBxA3lTCNr0,695
+fujin/proxies/caddy.py,sha256=9pbpNatiNcTHjmflyz1KijagGYQkpAafc_IV06wxY8w,7130
+fujin/proxies/dummy.py,sha256=qBKSn8XNEA9SVwB7GzRNX2l9Iw6tUjo2CFqZjWi0FjY,465
+fujin/proxies/nginx.py,sha256=8AkbJAjj6B0fxgv671mGDbx3LY_dY5wxFov80XmSfUY,4139
+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.3.0.dist-info/METADATA,sha256=_RdZ9gqiLRxAuxGp-Y4qPelvKI7Opus5VVsKJXoFUK8,4396
+fujin_cli-0.3.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+fujin_cli-0.3.0.dist-info/entry_points.txt,sha256=Y_TBtKt3j11qhwquMexZR5yqnDEqOBDACtresqQFE-s,46
+fujin_cli-0.3.0.dist-info/licenses/LICENSE.txt,sha256=0QF8XfuH0zkIHhSet6teXfiCze6JSdr8inRkmLLTDyo,1099
+fujin_cli-0.3.0.dist-info/RECORD,,

fujin_cli-0.3.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+fujin = fujin.__main__:main

fujin/fabfile.py

@@ -1,202 +0,0 @@
-import os
-import secrets
-
-from fabric import Connection
-from fabric import task
-from falco.fabutils import curl_binary_download_cmd
-from falco.fabutils import with_progress
-
-# Configuration
-PROJECT_NAME = "torch"
-GITHUB_USERNAME = os.getenv("GITHUB_USERNAME", default="tobi")
-GITHUB_TOKEN = os.getenv("GITHUB_TOKEN")
-SERVER_USER = "tobi"
-SERVER_HOST = os.getenv("SERVER_HOST")
-SERVER_PASSWORD = os.getenv("SERVER_PASSWORD")
-SERVER_PROJECT_DIR = f"/home/{SERVER_USER}/djangoprojects/{PROJECT_NAME}"
-SERVER_PROJECT_BINARY = f"{SERVER_PROJECT_DIR}/{PROJECT_NAME}"
-DOMAIN = "torch.com"
-CERTBOT_EMAIL = "tobidegnon@proton.me"
-
-
-def get_connection(use_root=False):
-    """Establish a connection to the server."""
-    user = "root" if use_root else SERVER_USER
-    return Connection(host=SERVER_HOST, user=user, connect_kwargs={"password": SERVER_PASSWORD})
-
-
-# Deployment Tasks
-
-
-@task
-@with_progress("Provisioning server")
-def provision(_, set_password=False, progress=None):
-    """Set up the server with necessary dependencies and create a new user."""
-    conn = get_connection(use_root=True)
-
-    progress("Updating system and installing dependencies")
-    conn.sudo("apt update && apt upgrade -y")
-    conn.sudo("apt install -y nginx libpq-dev python3-dev python3-certbot-nginx sqlite3")
-
-    progress(f"Creating and configuring user: {SERVER_USER}")
-    conn.sudo(f"adduser --disabled-password --gecos '' {SERVER_USER}")
-    if set_password:
-        password = secrets.token_urlsafe(16)
-        conn.sudo(f"echo '{SERVER_USER}:{password}' | chpasswd")
-        print(f"Generated password for {SERVER_USER}: {password}")
-        print("Please store this password securely and change it upon first login.")
-
-    # Set up SSH and sudo access
-    conn.sudo(f"mkdir -p /home/{SERVER_USER}/.ssh")
-    conn.sudo(f"cp ~/.ssh/authorized_keys /home/{SERVER_USER}/.ssh/")
-    conn.sudo(f"chown -R {SERVER_USER}:{SERVER_USER} /home/{SERVER_USER}/.ssh")
-    conn.sudo(f"chmod 700 /home/{SERVER_USER}/.ssh")
-    conn.sudo(f"chmod 600 /home/{SERVER_USER}/.ssh/authorized_keys")
-    conn.sudo(f"echo '{SERVER_USER} ALL=(ALL) NOPASSWD:ALL' | sudo tee -a /etc/sudoers")
-
-    progress("Creating project directory")
-    conn.run(f"mkdir -p {SERVER_PROJECT_DIR}")
-
-
-@task
-@with_progress("Performing initial deployment")
-def up(c, progress=None):
-    """Perform the initial deployment of the project."""
-    conn = get_connection()
-
-    progress("Transferring files to server")
-    transfer_files(c)
-    conn.sudo(f"ln -sf /etc/nginx/sites-available/{PROJECT_NAME} /etc/nginx/sites-enabled/{PROJECT_NAME}")
-
-    progress("Setting up project and services")
-    apprun(c, "setup")
-    reload_services(c)
-    conn.sudo(f"systemctl enable --now {PROJECT_NAME}.socket")
-
-
-@task
-@with_progress("Deploying code changes")
-def deploy(c, progress=None):
-    """Deploy code changes to the server."""
-    progress("Transferring updated files")
-    transfer_files(c, code_only=True)
-
-    progress("Updating project setup")
-    apprun(c, "setup")
-
-    progress("Restarting wsgi service")
-    get_connection().sudo(f"systemctl restart {PROJECT_NAME}")
-
-
-# Maintenance Tasks
-
-
-@task
-@with_progress("Refreshing application")
-def refresh(c, progress=None):
-    """Refresh the application by reloading configurations and restarting services."""
-    progress("Updating all files")
-    transfer_files(c)
-
-    progress("Reloading configurations and restarting services")
-    reload_services(c)
-
-
-@task
-@with_progress("Setting up domain with SSL")
-def setup_domain(_, progress=None):
-    """Set up a domain with SSL using Certbot."""
-    conn = get_connection()
-
-    progress("Obtaining SSL certificate")
-    conn.sudo(f"certbot --nginx -d {DOMAIN} --non-interactive --agree-tos --email {CERTBOT_EMAIL} --redirect")
-
-    progress("Updating local Nginx configuration")
-    conn.get(
-        f"/etc/nginx/sites-available/{PROJECT_NAME}",
-        f"deploy/etc/nginx/sites-available/{PROJECT_NAME}",
-    )
-
-    progress("Enabling certificate auto-renewal")
-    conn.sudo("systemctl enable certbot.timer")
-    conn.sudo("systemctl start certbot.timer")
-
-
-# Utility Tasks
-
-
-@task
-def transfer_files(_, code_only=False):
-    """Transfer project files to the server."""
-    conn = get_connection()
-
-    # Download and set up binary
-    binary_download_cmd = curl_binary_download_cmd(owner=GITHUB_USERNAME, repo=PROJECT_NAME, token=GITHUB_TOKEN)
-    conn.run(f"{binary_download_cmd} -o {SERVER_PROJECT_BINARY}")
-    conn.run(f"chmod +x {SERVER_PROJECT_BINARY}")
-    conn.put(".env.prod", f"{SERVER_PROJECT_DIR}/.env")
-
-    if not code_only:
-        # Transfer configuration files
-        config_files = [
-            (
-                f"deploy/etc/nginx/sites-available/{PROJECT_NAME}",
-                f"/etc/nginx/sites-available/{PROJECT_NAME}",
-            ),
-            (
-                f"deploy/etc/systemd/system/{PROJECT_NAME}.socket",
-                f"/etc/systemd/system/{PROJECT_NAME}.socket",
-            ),
-            (
-                f"deploy/etc/systemd/system/{PROJECT_NAME}.service",
-                f"/etc/systemd/system/{PROJECT_NAME}.service",
-            ),
-        ]
-        for src, dest in config_files:
-            filename = os.path.basename(src)
-            conn.put(src, f"{SERVER_PROJECT_DIR}/{filename}")
-            conn.sudo(f"mv {SERVER_PROJECT_DIR}/{filename} {dest}")
-
-
-@task
-def apprun(_, cmd, pty=False):
-    """Run a command in the application environment."""
-    with get_connection().cd(SERVER_PROJECT_DIR):
-        get_connection().run(f"source .env && ./{PROJECT_NAME} '{cmd}'", pty=pty)
-
-
-@task
-def console(c, shell_type="bash"):
-    """Open an interactive shell on the server."""
-    conn = get_connection()
-    if shell_type == "python":
-        apprun(c, "manage shell_plus", pty=True)
-    elif shell_type == "db":
-        apprun(c, "manage dbshell", pty=True)
-    else:
-        conn.run("bash", pty=True)
-
-
-@task
-def reload_services(_):
-    """Reload Nginx and systemd configurations, and restart the project service."""
-    conn = get_connection()
-    conn.sudo("systemctl daemon-reload")
-    conn.sudo("systemctl reload nginx")
-    conn.sudo(f"systemctl restart {PROJECT_NAME}")
-
-
-@task
-def logs(_, follow=False):
-    """View the last n lines of the project's log file."""
-    get_connection().sudo(f"sudo journalctl -u {PROJECT_NAME} -r {'-f' if follow else ''}")
-
-
-if __name__ == "__main__":
-    from fabric.main import Program, Collection
-
-    ns = Collection(
-        provision, up, deploy, refresh, setup_domain, transfer_files, apprun, console, reload_services, logs
-    )
-    program = Program(namespace=ns)
-    program.run()

fujin/utils.py

@@ -1,60 +0,0 @@
-import json
-import urllib.request
-from functools import wraps
-
-from rich.progress import Progress
-from rich.progress import SpinnerColumn
-from rich.progress import TextColumn
-
-
-def with_progress(description, pass_progress=True):
-    def decorator(func):
-        @wraps(func)
-        def wrapper(*args, **kwargs):
-            with Progress(
-                SpinnerColumn(),
-                TextColumn("[cyan]{task.description}"),
-                transient=True,
-            ) as progress:
-                task = progress.add_task(description, total=None)
-                if pass_progress:
-                    kwargs["progress"] = lambda desc: progress.update(task, description=desc)
-                result = func(*args, **kwargs)
-                progress.update(task, completed=True)
-                progress.console.print(f"[green]{description} completed!")
-                return result
-
-        return wrapper
-
-    return decorator
-
-
-def _get_asset_id(token, owner, repo, project_name):
-    url = f"https://api.github.com/repos/{owner}/{repo}/releases/latest"
-    headers = {
-        "Accept": "application/vnd.github+json",
-        "Authorization": f"Bearer {token}",
-        "X-GitHub-Api-Version": "2022-11-28",
-    }
-    req = urllib.request.Request(url, headers=headers)
-    with urllib.request.urlopen(req) as response:
-        data = json.loads(response.read().decode())
-        assets = data["assets"]
-    for asset in assets:
-        if asset["name"] == f"{project_name}-x86_64-linux":
-            return asset["id"]
-    msg = f"Asset not found with name {project_name}-x86_64-linux"
-    raise Exception(msg)
-
-
-def curl_binary_download_cmd(*, owner, repo, project_name=None, token=None):
-    curl = "curl -L -H 'Accept: application/octet-stream' "
-    project_name = project_name or repo
-    if not token:
-        return f"{curl} https://github.com/{owner}/{repo}/releases/latest/download/{project_name}-x86_64-linux"
-    asset_id = _get_asset_id(token, owner, repo, project_name)
-    return (
-        f"{curl} -H 'Authorization: Bearer {token}' "
-        f"-H 'X-GitHub-Api-Version: 2022-11-28' "
-        f"https://api.github.com/repos/{owner}/{repo}/releases/assets/{asset_id}"
-    )

fujin_cli-0.1.0.dist-info/METADATA

@@ -1,41 +0,0 @@
-Metadata-Version: 2.3
-Name: fujin-cli
-Version: 0.1.0
-Summary: Add your description here
-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
-Requires-Python: >=3.10
-Requires-Dist: fabric
-Requires-Dist: rich
-Requires-Dist: tomlkit
-Description-Content-Type: text/markdown
-
-# fujin
-
-[![PyPI - Version](https://img.shields.io/pypi/v/fujin.svg)](https://pypi.org/project/fujin)
-[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/fujin.svg)](https://pypi.org/project/fujin)
-
------
-
-> [!IMPORTANT]
-> This package currently contains no features and is a work-in-progress
-
-
-**Table of Contents**
-
-- [fujin](#fujin)
-  - [Installation](#installation)
-  - [License](#license)
-
-## Installation
-
-```console
-pip install fujin
-```
-
-## License
-
-`fujin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

fujin_cli-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-fujin/__init__.py,sha256=ShHd5zQuVmEI29BKLgfu3WOGbCJBzeirwGy0pRl5Xag,51
-fujin/fabfile.py,sha256=pIz4uQ9n1zWmiMmD6_1OJKk1PrKi6tlNgE4w4_wvEng,6633
-fujin/utils.py,sha256=lVAIsnjDtpLBSOTQKt5wJlvdccBznSrch0FsNBp4vO8,2197
-fujin_cli-0.1.0.dist-info/METADATA,sha256=Z-42ZEQq6LyNR1pxLe3qbYfhGFjJozhfDsJZAberYYk,1062
-fujin_cli-0.1.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-fujin_cli-0.1.0.dist-info/entry_points.txt,sha256=KHtzGtsbA7ZhWWVcglfITQvvi9awumQ5hgXO-5iBH3Y,37
-fujin_cli-0.1.0.dist-info/licenses/LICENSE.txt,sha256=0QF8XfuH0zkIHhSet6teXfiCze6JSdr8inRkmLLTDyo,1099
-fujin_cli-0.1.0.dist-info/RECORD,,

fujin_cli-0.1.0.dist-info/entry_points.txt

@@ -1,2 +0,0 @@
-[console_scripts]
-fujin = fujin:main