fujin-cli 0.5.0__tar.gz → 0.6.0__tar.gz

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

@@ -0,0 +1,169 @@
+name: Publish package
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+
+jobs:
+  build-python-wheel-and-sdist:
+    name: Build a pure Python wheel and source distribution
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Build
+        run: uv build
+
+      - uses: actions/upload-artifact@v4
+        with:
+          name: wheels
+          path: dist/*
+          if-no-files-found: error
+          overwrite: true
+
+  build-binaries:
+    name: Build binary application for ${{ matrix.job.target }} (${{ matrix.job.os }})
+    runs-on: ${{ matrix.job.os }}
+    needs: build-python-wheel-and-sdist
+    strategy:
+      fail-fast: false
+      matrix:
+        job:
+          # Linux
+          - target: x86_64-unknown-linux-gnu
+            os: ubuntu-latest
+            cross: true
+            release_suffix: x86_64-linux
+          - target: x86_64-unknown-linux-musl
+            os: ubuntu-latest
+            cross: true
+            release_suffix: x86_64-linux-musl
+          - target: aarch64-unknown-linux-gnu
+            os: ubuntu-latest
+            cross: true
+            release_suffix: aarch64-linux
+          # - target: i686-unknown-linux-gnu
+          #  os: ubuntu-latest
+          #  cross: true
+          #  release_suffix: i686-linux
+          # Windows
+          - target: x86_64-pc-windows-msvc
+            os: windows-2022
+            release_suffix: x86_64-windows
+          - target: i686-pc-windows-msvc
+            os: windows-2022
+            release_suffix: i686-windows
+          # macOS
+          - target: aarch64-apple-darwin
+            os: macos-12
+            release_suffix: aarch64-osx
+          - target: x86_64-apple-darwin
+            os: macos-12
+            release_suffix: x86_64-osx
+
+    env:
+      CARGO_BUILD_TARGET: ${{ matrix.job.target }}
+
+    steps:
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install just
+        uses: extractions/setup-just@v2
+
+      - name: Code Checkout
+        uses: actions/checkout@v4
+
+      - name: Install musl-tools on Linux
+        run: sudo apt-get install --yes musl musl-dev musl-tools
+        if: ${{ matrix.job.os == 'ubuntu-latest' }}
+
+      - name: Install Rust toolchain
+        if: ${{ !matrix.job.cross }}
+        uses: dtolnay/rust-toolchain@stable
+        with:
+          targets: ${{ matrix.job.target }}
+
+      - name: Set up cross compiling tools
+        if: matrix.job.cross
+        uses: taiki-e/setup-cross-toolchain-action@v1
+        with:
+          target: ${{ matrix.job.target}}
+
+      - name: Show toolchain information
+        run: |-
+          rustup toolchain list
+          rustup default
+          rustup -V
+          rustc -V
+          cargo -V
+          uv --version
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: wheels
+          path: ${{ github.workspace }}/dist
+          merge-multiple: true
+
+      - name: Build binary
+        run: just build-bin
+
+      - name: Rename
+        working-directory: ${{ github.workspace }}
+        run: |-
+          mv dist/bin/fujin_cli* dist/bin/fujin_cli-${{ matrix.job.release_suffix }}
+
+      - name: Upload built binary package
+        uses: actions/upload-artifact@v4
+        with:
+          name: binaries-${{ matrix.job.release_suffix }}
+          path: dist/bin/*
+          if-no-files-found: error
+  
+  publish-to-pypi:
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    needs: [build-python-wheel-and-sdist, build-binaries]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          name: wheels
+          path: dist
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  release:
+    name: Create a GitHub release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    needs: [build-python-wheel-and-sdist, build-binaries]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: actions/download-artifact@v4
+        with:
+          path: dist
+          merge-multiple: true
+
+      - 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.5.0 → fujin_cli-0.6.0}/.pre-commit-config.yaml

@@ -9,6 +9,12 @@ repos:
         language: system
         files: '\.py$'
 
+      - id: logchanges
+        name: update changelog
+        entry: just logchanges || true
+        language: system
+        pass_filenames: false
+
   - repo: https://github.com/myint/autoflake
     rev: v2.3.1
     hooks:

fujin_cli-0.6.0/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+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).
+
+<!-- generated by git-cliff -->

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/PKG-INFO

@@ -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 → fujin_cli-0.6.0}/README.md

@@ -9,16 +9,18 @@
 > [!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.
@@ -36,3 +38,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 → fujin_cli-0.6.0}/docs/commands/app.rst

@@ -1,4 +1,4 @@
-App
+app
 ===
 
 .. cappa:: fujin.commands.app.App

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/config.rst

@@ -1,4 +1,4 @@
-Config
+config
 ======
 
 .. cappa:: fujin.commands.config.ConfigCMD

fujin_cli-0.6.0/docs/commands/deploy.rst

@@ -0,0 +1,67 @@
+deploy
+======
+
+
+.. cappa:: fujin.commands.deploy.Deploy
+   :style: terminal
+   :terminal-width: 0
+
+
+How it works
+------------
+
+Here's a high-level overview of what happens when you run the ``deploy`` command:
+
+1. **Build the Application**: Your application is built using the ``build_command`` specified in your configuration.
+
+2. **Transfer Files**: The environment variables file (``.env``) and the distribution file are transferred to the remote server. Optionally transfers ``requirements`` file (if specified).
+
+3. **Install the Project**: Depending on the installation mode (Python package or binary), the project is installed on the remote server. For a Python package, a virtual environment is set up, dependencies are installed, and the distribution file (the wheel file) is then installed. For a binary, the binary file for the latest version is linked to the root of the application directory.
+
+4. **Application Release**: If a ``release_command`` is specified in the configuration, it is executed at this stage. 
+
+5. **Configure and Start Services**: Configuration files for both ``systemd`` and the ``proxy`` (e.g., Caddy, by default) are generated or copied if previously exported. These configuration files are moved to their appropriate directories. A configuration reload is performed, and all relevant services are restarted.  
+
+6. **Update Version History**: The deployed version is recorded in the ``.versions`` file on the remote server.
+
+7. **Prune Old Assets**: Old versions of the application are removed based on the ``versions_to_keep`` configuration.
+
+8. **Completion**: A success message is displayed, and the URL to access the deployed project is provided.
+
+Below is an example file layout and structure of the deployed application:
+
+.. tab-set::
+
+    .. tab-item:: python package
+
+        .. code-block:: shell
+
+            app_directory/
+            ├── .env                              # Environment variables file
+            ├── .appenv                           # Application-specific environment setup
+            ├── .versions                         # Version tracking file
+            ├── .venv/                            # Virtual environment
+            ├── v1.2.3/                           # Versioned asset directory
+            │   ├── app-1.2.3-py3-none-any.whl    # Distribution file
+            │   └── requirements.txt              # Optional requirements file
+            ├── v1.2.2/
+            │   └── ...
+            └── v1.2.1/
+                └── ...
+
+    .. tab-item:: binary
+
+        .. code-block:: shell
+
+            app_directory/
+            ├── .env                              # Environment variables file
+            ├── .appenv                           # Application-specific environment setup
+            ├── .versions                         # Version tracking file
+            ├── app_binary -> v1.2.3/app_binary   # Symbolic link to current version
+            ├── v1.2.3/                           # Versioned asset directory
+            │   └── app_binary                    # Distribution file
+            ├── v1.2.2/
+            │   └── ...
+            └── v1.2.1/
+                └── ...
+         

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/docs.rst

@@ -1,4 +1,4 @@
-Docs
+docs
 ====
 
 .. cappa:: fujin.commands.docs.Docs

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/down.rst

@@ -1,4 +1,4 @@
-Down
+down
 ====
 
 .. cappa:: fujin.commands.down.Down

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/init.rst

@@ -1,4 +1,4 @@
-Init
+init
 ====
 
 .. cappa:: fujin.commands.init.Init

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/proxy.rst

@@ -1,4 +1,4 @@
-Proxy
+proxy
 ======
 
 .. cappa:: fujin.commands.proxy.Proxy

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/prune.rst

@@ -1,4 +1,4 @@
-Prune
+prune
 ======
 
 .. cappa:: fujin.commands.prune.Prune

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/redeploy.rst

@@ -1,4 +1,4 @@
-Redeploy
+redeploy
 ========
 
 .. cappa:: fujin.commands.redeploy.Redeploy

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/rollback.rst

@@ -1,4 +1,4 @@
-Rollback
+rollback
 ========
 
 .. cappa:: fujin.commands.rollback.Rollback

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/secrets.rst

@@ -1,5 +1,5 @@
-Secrets
-======
+secrets
+=======
 
 .. cappa:: fujin.commands.secrets.Secrets
    :style: terminal

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/server.rst

@@ -1,4 +1,4 @@
-Server
+server
 ======
 
 .. cappa:: fujin.commands.up.Server

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/commands/up.rst

@@ -1,4 +1,4 @@
-Up
+up
 ==
 
 .. cappa:: fujin.commands.up.Up

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/conf.py

@@ -21,6 +21,7 @@ extensions = [
     "sphinx_design",
     "sphinx_copybutton",
     "jupyter_sphinx",
+    "sphinx_togglebutton",
 ]
 
 templates_path = ["_templates"]

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/configuration.rst

@@ -11,7 +11,7 @@ This is a minimal working example.
 
 .. tab-set::
 
-    .. tab-item:: simple python package
+    .. tab-item:: python package
 
         .. jupyter-execute::
             :hide-code:

fujin_cli-0.6.0/docs/index.rst

@@ -0,0 +1,52 @@
+.. 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.
+
+.. container:: badges
+   :name: badges
+
+   .. image:: https://img.shields.io/pypi/pyversions/fujin-cli.svg
+      :alt: Python versions
+   
+   .. image:: https://github.com/falcopackages/fujin/actions/workflows/publish.yml/badge.svg
+      :alt: Github Actions Publish Status
+   
+   .. image:: https://img.shields.io/badge/license-MIT-blue.svg
+      :alt: License
+
+   .. image:: https://readthedocs.org/projects/fujin/badge/?version=latest&style=flat
+      :alt: Documentation Status
+
+   .. image:: https://img.shields.io/pypi/v/fujin-cli.svg
+      :alt: PyPI Version
+
+.. raw:: html
+
+   <script src="https://asciinema.org/a/687274.js" id="asciicast-687274" async="true"></script>
+
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+   :start-after: <!-- content:start -->
+   :end-before: <!-- content:end -->
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+   :hidden:
+
+   installation
+   tutorial
+   configuration
+   commands/index
+   hooks
+   changelog
+

{fujin_cli-0.5.0 → fujin_cli-0.6.0}/docs/installation.rst

@@ -13,4 +13,4 @@ Installation
 
     .. code-block:: bash
 
-        https://docs.astral.sh/uv/getting-started/installation/
+        curl -LsSf https://astral.sh/uv/install.sh | sh