fujin-cli 0.1.0__tar.gz

fujin_cli-0.1.0/.gitignore

@@ -0,0 +1,10 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv

fujin_cli-0.1.0/.python-version

@@ -0,0 +1 @@
+3.12

fujin_cli-0.1.0/LICENSE.txt

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2024-present Tobi DEGNON <tobidegnon@proton.me>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

fujin_cli-0.1.0/PKG-INFO

@@ -0,0 +1,41 @@
+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/README.md

@@ -0,0 +1,26 @@
+# 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/pyproject.toml

@@ -0,0 +1,26 @@
+[project]
+name = "fujin-cli"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+authors = [
+    { name = "Tobi DEGNON", email = "tobidegnon@proton.me" } 
+]
+requires-python = ">=3.10"
+dependencies = ["fabric", "rich", "tomlkit"]
+
+urls.Documentation = "https://github.com/falcopackages/fujin#readme"
+urls.Issues = "https://github.com/falcopackages/fujin/issues"
+urls.Source = "https://github.com/falcopackages/fujin"
+
+[project.scripts]
+fujin = "fujin:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = [
+  "src/fujin",
+]

fujin_cli-0.1.0/src/fujin/__init__.py

@@ -0,0 +1,2 @@
+def main() -> None:
+    print("Hello from fujin!")

fujin_cli-0.1.0/src/fujin/fabfile.py

@@ -0,0 +1,202 @@
+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_cli-0.1.0/src/fujin/utils.py

@@ -0,0 +1,60 @@
+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}"
+    )