fujin-cli 0.1.0__tar.gz → 0.3.0__tar.gz

fujin_cli-0.3.0/.github/workflows/publish.yml

@@ -0,0 +1,36 @@
+name: Publish package
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  publish:
+    name: Publish to pypi
+    runs-on: ubuntu-latest
+    steps:
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+      - name: Build Wheel
+        run: uv build
+      - name: Publish
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  release:
+    name: Create a GitHub release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Generate Changelog
+        run: |
+          awk '/^## /{if (p) exit; p=1; next} p' ${{ github.workspace }}/CHANGELOG.md | tee ${{ github.workspace }}-CHANGELOG.txt
+      - name: Release
+        uses: softprops/action-gh-release@v2
+        with:
+          body_path: ${{ github.workspace }}-CHANGELOG.txt
+          files: dist/*
+          fail_on_unmatched_files: true

fujin_cli-0.3.0/.gitignore

@@ -0,0 +1,152 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+*.sqlite3
+*.sqlite3-journal
+*.sqlite3-shm
+*.sqlite3-wal
+*.db
+*.db-journal
+*.db-shm
+*.db-wal
+*staticfiles/
+*media
+
+# db dumps
+*.dump
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+examples/django/bookstore/.env.prod
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# Pycharm
+.idea/
+
+# MacOs
+.DS_Store
+
+id_rsa
+id_rsa.pub
+aws.pem
+.vagrant

fujin_cli-0.3.0/.pre-commit-config.yaml

@@ -0,0 +1,30 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: local
+    hooks:
+      - id: fmt
+        name: ruff format
+        entry: uvx ruff format
+        language: system
+        files: '\.py$'
+
+  - repo: https://github.com/myint/autoflake
+    rev: v2.3.1
+    hooks:
+      - id: autoflake
+        exclude: .*/__init__.py
+        args:
+          - --in-place
+          - --remove-all-unused-imports
+          - --expand-star-imports
+          - --remove-duplicate-keys
+          - --remove-unused-variables
+
+
+  - repo: https://github.com/tox-dev/pyproject-fmt
+    rev: "v2.5.0"
+    hooks:
+      - id: pyproject-fmt
+        args: [ "pyproject.toml" ]
+        exclude: ^(examples/)

fujin_cli-0.3.0/.readthedocs.yaml

@@ -0,0 +1,24 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version, and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.12"
+
+# Build documentation in the "docs/" directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# Optionally, but recommended,
+# declare the Python requirements required to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+

fujin_cli-0.3.0/PKG-INFO

@@ -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/README.md

@@ -0,0 +1,38 @@
+# 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/Vagrantfile

@@ -0,0 +1,79 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure("2") do |config|
+  # The most common configuration options are documented and commented below.
+  # For a complete reference, please see the online documentation at
+  # https://docs.vagrantup.com.
+
+  # Every Vagrant development environment requires a box. You can search for
+  # boxes at https://vagrantcloud.com/search.
+  config.vm.box = "hashicorp/bionic64"
+  # config.vm.box = "alvistack/ubuntu-24.04"
+  # config.vm.box_version = "20241002.1.1"
+
+  # Disable automatic box update checking. If you disable this, then
+  # boxes will only be checked for updates when the user runs
+  # `vagrant box outdated`. This is not recommended.
+  # config.vm.box_check_update = false
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine. In the example below,
+  # accessing "localhost:8080" will access port 80 on the guest machine.
+  # NOTE: This will enable public access to the opened port
+  # config.vm.network "forwarded_port", guest: 80, host: 8080
+
+  # Create a forwarded port mapping which allows access to a specific port
+  # within the machine from a port on the host machine and only allow access
+  # via 127.0.0.1 to disable public access
+  # config.vm.network "forwarded_port", guest: 80, host: 8080, host_ip: "127.0.0.1"
+
+  # Create a private network, which allows host-only access to the machine
+  # using a specific IP.
+  # config.vm.network "private_network", ip: "192.168.33.10"
+
+  # Create a public network, which generally matched to bridged network.
+  # Bridged networks make the machine appear as another physical device on
+  # your network.
+  # config.vm.network "public_network"
+
+  # Share an additional folder to the guest VM. The first argument is
+  # the path on the host to the actual folder. The second argument is
+  # the path on the guest to mount the folder. And the optional third
+  # argument is a set of non-required options.
+  # config.vm.synced_folder "../data", "/vagrant_data"
+
+  # Disable the default share of the current code directory. Doing this
+  # provides improved isolation between the vagrant box and your host
+  # by making sure your Vagrantfile isn't accessible to the vagrant box.
+  # If you use this you may want to enable additional shared subfolders as
+  # shown above.
+  # config.vm.synced_folder ".", "/vagrant", disabled: true
+
+  # Provider-specific configuration so you can fine-tune various
+  # backing providers for Vagrant. These expose provider-specific options.
+  # Example for VirtualBox:
+  #
+  config.vm.provider "virtualbox" do |vb|
+  #   # Display the VirtualBox GUI when booting the machine
+  #   vb.gui = true
+  #
+  #   # Customize the amount of memory on the VM:
+     vb.memory = "2024"
+  end
+  #
+  # View the documentation for the provider you are using for more
+  # information on available options.
+
+  # Enable provisioning with a shell script. Additional provisioners such as
+  # Ansible, Chef, Docker, Puppet and Salt are also available. Please see the
+  # documentation for more information about their specific syntax and use.
+  # config.vm.provision "shell", inline: <<-SHELL
+  #   apt-get update
+  #   apt-get install -y apache2
+  # SHELL
+end

fujin_cli-0.3.0/docs/changelog.rst

@@ -0,0 +1,2 @@
+Changelog
+=========

fujin_cli-0.3.0/docs/commands/app.rst

@@ -0,0 +1,6 @@
+App
+===
+
+.. cappa:: fujin.commands.app.App
+   :style: terminal
+   :terminal-width: 0

fujin_cli-0.3.0/docs/commands/config.rst

@@ -0,0 +1,6 @@
+Config
+======
+
+.. cappa:: fujin.commands.config.ConfigCMD
+   :style: terminal
+   :terminal-width: 0

fujin_cli-0.3.0/docs/commands/deploy.rst

@@ -0,0 +1,7 @@
+Deploy
+======
+
+
+.. cappa:: fujin.commands.deploy.Deploy
+   :style: terminal
+   :terminal-width: 0

fujin_cli-0.3.0/docs/commands/docs.rst

@@ -0,0 +1,6 @@
+Docs
+====
+
+.. cappa:: fujin.commands.docs.Docs
+   :style: terminal
+   :terminal-width: 0

fujin_cli-0.3.0/docs/commands/down.rst

@@ -0,0 +1,6 @@
+Down
+====
+
+.. cappa:: fujin.commands.down.Down
+   :style: terminal
+   :terminal-width: 0

fujin_cli-0.3.0/docs/commands/index.rst

@@ -0,0 +1,24 @@
+Commands
+========
+
+.. cappa:: fujin.__main__.Fujin
+   :style: terminal
+   :terminal-width: 0
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+
+   app
+   config
+   deploy
+   docs
+   down
+   init
+   prune
+   proxy
+   redeploy
+   rollback
+   secrets
+   server
+   up

fujin_cli-0.3.0/docs/commands/init.rst

@@ -0,0 +1,6 @@
+Init
+====
+
+.. cappa:: fujin.commands.init.Init
+   :style: terminal
+   :terminal-width: 0

fujin_cli-0.3.0/docs/commands/proxy.rst

@@ -0,0 +1,7 @@
+Proxy
+======
+
+.. cappa:: fujin.commands.proxy.Proxy
+   :style: terminal
+   :terminal-width: 0
+

fujin_cli-0.3.0/docs/commands/prune.rst

@@ -0,0 +1,7 @@
+Prune
+======
+
+.. cappa:: fujin.commands.prune.Prune
+   :style: terminal
+   :terminal-width: 0
+

fujin_cli-0.3.0/docs/commands/redeploy.rst

@@ -0,0 +1,6 @@
+Redeploy
+========
+
+.. cappa:: fujin.commands.redeploy.Redeploy
+   :style: terminal
+   :terminal-width: 0

fujin_cli-0.3.0/docs/commands/rollback.rst

@@ -0,0 +1,7 @@
+Rollback
+========
+
+.. cappa:: fujin.commands.rollback.Rollback
+   :style: terminal
+   :terminal-width: 0
+

fujin_cli-0.3.0/docs/commands/secrets.rst

@@ -0,0 +1,7 @@
+Secrets
+======
+
+.. cappa:: fujin.commands.secrets.Secrets
+   :style: terminal
+   :terminal-width: 0
+

fujin_cli-0.3.0/docs/commands/server.rst

@@ -0,0 +1,16 @@
+Server
+======
+
+.. cappa:: fujin.commands.up.Server
+   :style: terminal
+   :terminal-width: 0
+
+
+bootstrap
+---------
+
+exec
+----
+
+create-user
+-----------

fujin_cli-0.3.0/docs/commands/up.rst

@@ -0,0 +1,6 @@
+Up
+==
+
+.. cappa:: fujin.commands.up.Up
+   :style: terminal
+   :terminal-width: 0

fujin_cli-0.3.0/docs/conf.py

@@ -0,0 +1,42 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "fujin"
+copyright = "2024, Tobi DEGNON"
+author = "Tobi DEGNON"
+release = "2024"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "cappa.ext.docutils",
+    "myst_parser",
+    "sphinx.ext.todo",
+    "sphinx.ext.autodoc",
+    "sphinx_design",
+    "sphinx_copybutton",
+    "jupyter_sphinx",
+]
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "shibuya"
+html_static_path = ["_static"]
+
+html_theme_options = {
+    "mastodon_url": "https://fosstodon.org/@tobide",
+    "github_url": "https://github.com/falcopackages/fujin",
+    "twitter_url": "https://twitter.com/tobidegnon",
+    "discussion_url": "https://github.com/falcopackages/fujin/discussions",
+    "accent_color": "teal",
+    "globaltoc_expand_depth": 1,
+}

fujin_cli-0.3.0/docs/configuration.rst

@@ -0,0 +1,18 @@
+Configuration
+=============
+
+.. automodule:: fujin.config
+
+
+Example
+-------
+
+This is a minimal working example.
+
+.. jupyter-execute::
+    :hide-code:
+
+    from fujin.commands.init import simple_config
+    from tomli_w import dumps
+
+    print(dumps(simple_config("bookstore")))

fujin_cli-0.3.0/docs/hooks.rst

@@ -0,0 +1,2 @@
+Hooks
+=====

fujin_cli-0.3.0/docs/index.rst

@@ -0,0 +1,29 @@
+.. fujin documentation master file, created by
+   sphinx-quickstart on Tue Oct 29 14:01:13 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+fujin documentation
+===================
+
+
+.. important::
+
+   This a work in progress, not ready for production use yet.
+
+
+.. .. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :hidden:
+
+   installation
+   tutorial
+   configuration
+   commands/index
+   hooks
+   changelog
+