Skip to main content

Add your description here

Project description

fujin

PyPI - Version PyPI - Python Version MIT License Status

[!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. 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📚 for installation, features, and usage guides.

Why?

I wanted kamal but without Docker, and I thought the idea was fun. At its core, this project automates versions of this tutorial. 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
  • kamal (you probably can't just forget this one)

License

fujin is distributed under the terms of the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fujin_cli-0.5.0.tar.gz (129.6 kB view details)

Uploaded Source

Built Distribution

fujin_cli-0.5.0-py3-none-any.whl (31.8 kB view details)

Uploaded Python 3

File details

Details for the file fujin_cli-0.5.0.tar.gz.

File metadata

  • Download URL: fujin_cli-0.5.0.tar.gz
  • Upload date:
  • Size: 129.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for fujin_cli-0.5.0.tar.gz
Algorithm Hash digest
SHA256 a27e9732fca883f2ede4c7f67b951b7064f8fb3e863d23ca8061de4bd7bf4694
MD5 83ca61a06ab0061d4f71c783fa90cdd3
BLAKE2b-256 ae04ef7952798b06d8bfa0d69f7db9da569ae9a50f82e6364a0e9f538c657a60

See more details on using hashes here.

File details

Details for the file fujin_cli-0.5.0-py3-none-any.whl.

File metadata

  • Download URL: fujin_cli-0.5.0-py3-none-any.whl
  • Upload date:
  • Size: 31.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.27.0

File hashes

Hashes for fujin_cli-0.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 060f2508e797a22de6983f9b8ac5775016ba9fd3d674ff26614c1e0456ac4b35
MD5 3e4c9f833775eaf58b245519bb1b6024
BLAKE2b-256 c8fd230385e4844d7b88cd155b1d4a959e203e173e7a731734f7b70f73003e5b

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page