fujin-cli 0.10.0__tar.gz → 0.11.5__tar.gz

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/CHANGELOG.md

@@ -4,6 +4,48 @@ 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).
 
+## [0.11.4] - 2025-03-08
+
+### 🐛 Bug Fixes
+
+- No mutable default
+
+## [0.11.3] - 2025-03-08
+
+### Cfeat
+
+- Add fujin version info
+
+## [0.11.2] - 2025-03-08
+
+### 🚀 Features
+
+- Set system as the default secrets adapter
+
+## [0.11.1] - 2025-03-08
+
+### 🐛 Bug Fixes
+
+- Env content parse logic
+
+## [0.11.0] - 2025-03-08
+
+### 🚀 Features
+
+- Add system secret reader
+
+### 🚜 Refactor
+
+- Rename env_content to env
+
+### 📚 Documentation
+
+- Apply a more consitent writing style
+
+### ⚙️ Miscellaneous Tasks
+
+- Specify source package to avoid failing build backend
+
 ## [0.10.0] - 2024-11-24
 
 ### 🚀 Features

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/PKG-INFO

@@ -1,11 +1,12 @@
-Metadata-Version: 2.3
+Metadata-Version: 2.4
 Name: fujin-cli
-Version: 0.10.0
+Version: 0.11.5
 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

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/docs/secrets.rst

@@ -1,24 +1,43 @@
 Secrets  
 =======  
 
+System
+------
+
+The system adapter uses environment variables directly from your system. This is the simplest adapter and requires no additional setup.
+Update your fujin.toml file with the following configuration:
+
+[secrets]
+adapter = "system"
+
+.. code-block:: text
+    :caption: Example of an environment file with system environment variables
+
+    DEBUG=False
+    AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID
+    AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY
+
+The system adapter will look for environment variables with the same name as the value after the $ sign.
+
 Bitwarden  
 ---------  
 
 First, download and install the `Bitwarden CLI <https://bitwarden.com/help/cli/#download-and-install>`_. Make sure to log in to your account.  
 You should be able to run ``bw get password <name_of_secret>`` and get the value for the secret. This is the command that will be executed when pulling your secrets.  
 
-Add the following to your ``fujin.toml`` file:  
+Add the following to your **fujin.toml** file:
 
-.. code-block:: toml  
+.. code-block:: toml
+    :caption: fujin.toml
 
     [secrets]  
     adapter = "bitwarden"  
     password_env = "BW_PASSWORD"  
 
-To unlock the Bitwarden vault, the password is required. You can set the ``BW_PASSWORD`` environment variable in your shell, which will be used to unlock the vault.  
-When Fujin signs in, it will always sync the vault first.  
+To unlock the Bitwarden vault, the password is required. Set the *BW_PASSWORD* environment variable in your shell.
+When ``fujin`` signs in, it will always sync the vault first.
 
-Alternatively, you can set the ``BW_SESSION`` environment variable. If ``BW_SESSION`` is present, Fujin will use it directly without signing in or syncing the vault. In this case, the ``password_env`` configuration is not required.  
+Alternatively, you can set the *BW_SESSION* environment variable. If *BW_SESSION* is present, ``fujin`` will use it directly without signing in or syncing the vault. In this case, the *password_env* configuration is not required.
 
 .. code-block:: text  
     :caption: Example of an environment file with Bitwarden secrets  
@@ -27,7 +46,7 @@ Alternatively, you can set the ``BW_SESSION`` environment variable. If ``BW_SESS
     AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID  
     AWS_SECRET_ACCESS_KEY=$AWS_SECRET_ACCESS_KEY  
 
-Note the ``$`` sign, which indicates to ``fujin`` that it is a secret.  
+Note the *$* sign, which indicates to ``fujin`` that it is a secret.
 
 1Password  
 ---------  
@@ -35,9 +54,10 @@ Note the ``$`` sign, which indicates to ``fujin`` that it is a secret.
 Download and install the `1Password CLI <https://developer.1password.com/docs/cli>`_, and sign in to your account.  
 You need to be actively signed in for Fujin to work with 1Password.  
 
-Update your ``fujin.toml`` file with the following configuration:  
+Update your **fujin.toml** file with the following configuration:
 
-.. code-block:: toml  
+.. code-block:: toml
+    :caption: fujin.toml
 
     [secrets]  
     adapter = "1password"  
@@ -55,9 +75,10 @@ Doppler
 Download and install the `Doppler CLI <https://docs.doppler.com/docs/cli>`_, and sign in to your account.
 Move to your project root directory and run ``doppler setup`` to configure your project.
 
-Update your ``fujin.toml`` file with the following configuration:
+Update your **fujin.toml** file with the following configuration:
 
 .. code-block:: toml
+    :caption: fujin.toml
 
     [secrets]
     adapter = "doppler"

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/docs/tutorial.rst

@@ -1,8 +1,9 @@
 Tutorial
 ========
 
+In this tutorial, you will deploy a Django project or a PocketBase binary (in binary mode) to a Linux server running Ubuntu using the ``fujin`` CLI.
+
 First, make sure you follow the `installation </installation.html>`_ instructions and have the ``fujin`` command available globally in your shell.
-``fujin`` allows you to interact with your remote server and your deployed apps from your local shell.
 
 Prerequisites
 -------------
@@ -48,9 +49,10 @@ Let's start by installing and initializing a simple Django project.
 The ``uv init --package`` command makes your project mostly ready to be used with ``fujin``. It initializes a `packaged application <https://docs.astral.sh/uv/concepts/projects/#packaged-applications>`_ using uv,
 meaning the app can be packaged and distributed (e.g: via PyPI) and defines an entry point, which are the two requirements of ``fujin``.
 
-This is the content you'll get in the ``pyproject.toml`` file, with the relevant parts highlighted.
+This is the content you'll get in the **pyproject.toml** file, with the relevant parts highlighted.
 
 .. code-block:: toml
+    :caption: fujin.toml
     :linenos:
     :emphasize-lines: 15-16,18-20
 
@@ -75,38 +77,39 @@ This is the content you'll get in the ``pyproject.toml`` file, with the relevant
     requires = ["hatchling"]
     build-backend = "hatchling.build"
 
-The ``build-system`` section is what allows us to build our project into a wheel file (Python package format), and the ``project.scripts`` defines a CLI entry point for our app.
+The *build-system* section is what allows us to build our project into a wheel file (Python package format), and the *project.scripts* defines a CLI entry point for our app.
 This means that if our app is installed (either with ``pip install`` or ``uv tool install``, for example), there will be a ``bookstore`` command available globally on our system to run the project.
 
 .. note::
 
-    If you are installing it in a virtual environment, then there will be a file ``.venv/bin/bookstore`` that will run this CLI entry point. This is what ``fujin`` expects internally.
-    When it deploys your Python project, it sets up and installs a virtual environment in the app directory in a ``.venv`` folder and expects this entry point to be able to run
+    If you are installing it in a virtual environment, then there will be a file **.venv/bin/bookstore** that will run this CLI entry point. This is what ``fujin`` expects internally.
+    When it deploys your Python project, it sets up and installs a virtual environment in the app directory in a **.venv** folder and expects this entry point to be able to run
     commands with the ``fujin app exec <command>`` command.
 
-Currently, our entry point will run the main function in the ``src/bookstore/__init__.py`` file. Let's change that.
+Currently, our entry point will run the main function in the **src/bookstore/__init__.py** file. Let's change that.
 
 .. code-block:: shell
 
     rm -r src
     mv manage.py bookstore/__main__.py
 
-We first remove the ``src`` folder, as we won't use that since our Django project will reside in the top-level ``bookstore`` folder. I also recommend keeping all
+We first remove the **src** folder, as we won't use that since our Django project will reside in the top-level **bookstore** folder. I also recommend keeping all
 your Django code in that folder, including new apps, as this makes things easier for packaging purposes.
-Then we move the ``manage.py`` file to the ``bookstore`` folder and rename it to ``__main__.py``. This enables us to do this:
+Then we move the **manage.py** file to the **bookstore** folder and rename it to **__main__.py**. This enables us to do this:
 
 .. code-block:: shell
 
     uv run bookstore migrate # equivalent to python manage.py migrate if we kept the manage.py file
 
-Now to finish, update the ``scripts`` section in your ``pyproject.toml`` file.
+Now to finish, update the *scripts* section in your **pyproject.toml** file.
 
 .. code-block:: toml
+    :caption: fujin.toml
 
     [project.scripts]
     bookstore = "bookstore.__main__:main"
 
-Now the CLI that will be installed with your project will do the job of the ``manage.py`` file. To test this out, run the following commands:
+Now the CLI that will be installed with your project will do the job of the **manage.py** file. To test this out, run the following commands:
 
 .. code-block:: shell
 
@@ -134,6 +137,7 @@ Now that our project is ready, run ``fujin init`` at the root of it.
 Here's what you'll get:
 
 .. code-block:: toml
+    :caption: fujin.toml
 
     app = "bookstore"
     build_command = "uv build && uv pip compile pyproject.toml -o requirements.txt"
@@ -160,6 +164,7 @@ Here's what you'll get:
 Update the host section; it should look something like this, but with your server IP:
 
 .. code-block:: toml
+    :caption: fujin.toml
 
     [host]
     domain_name = "SERVER_IP.sslip.io"
@@ -170,10 +175,11 @@ Update the host section; it should look something like this, but with your serve
     
     Make sure to replace ``SERVER_IP`` with the actual IP address of your server.
 
-Create a ``.env.prod`` file at the root of your project; it can be an empty file for now. The only requirement is that the file should exist.
-Update your ``bookstore/settings.py`` with the changes below:
+Create a **.env.prod** file at the root of your project; it can be an empty file for now. The only requirement is that the file should exist.
+Update your **bookstore/settings.py** with the changes below:
 
 .. code-block:: python
+    :caption: settings.py
 
     # SECURITY WARNING: don't run with debug turned on in production!
     DEBUG = False
@@ -182,9 +188,10 @@ Update your ``bookstore/settings.py`` with the changes below:
 
 With the current setup, we should already be able to deploy our app with the ``fujin up`` command, but static files won't work. Let's make some changes.
 
-Update ``bookstore/settings.py`` with the changes below:
+Update **bookstore/settings.py** with the changes below:
 
 .. code-block:: python
+    :caption: settings.py
     :linenos:
     :lineno-start: 118
     :emphasize-lines: 119
@@ -194,7 +201,7 @@ Update ``bookstore/settings.py`` with the changes below:
 
 The last line means that when the ``collectstatic`` command is run, the files will be placed in a **staticfiles** directory in the current directory.
 
-Now let's update the ``fujin.toml`` file to run ``collectstatic`` before the app is started and move these files to the folder where our web server
+Now let's update the **fujin.toml** file to run ``collectstatic`` before the app is started and move these files to the folder where our web server
 can read them:
 
 .. code-block:: toml
@@ -232,10 +239,11 @@ For this tutorial, we will use `pocketbase <https://github.com/pocketbase/pocket
     curl -LO https://github.com/pocketbase/pocketbase/releases/download/v0.22.26/pocketbase_0.22.26_linux_amd64.zip
     fujin init --profile binary
 
-With the instructions above, we will download a version of Pocketbase to run on Linux from their GitHub release and initialize a new fujin configuration in ``binary`` mode.
-Now update the ``fujin.toml`` file with the changes below:
+With the instructions above, we will download a version of Pocketbase to run on Linux from their GitHub release and initialize a new fujin configuration in *binary* mode.
+Now update the **fujin.toml** file with the changes below:
 
 .. code-block:: toml
+    :caption: fujin.toml
     :linenos:
     :emphasize-lines: 2-5,9,13,19-21
 
@@ -263,25 +271,26 @@ Now update the ``fujin.toml`` file with the changes below:
 
 .. caution::
     
-    Make sure to replace ``SERVER_IP`` with the actual IP address of your server.
+    Make sure to replace *SERVER_IP* with the actual IP address of your server.
 
 Create User
 -----------
 
-Currently, we have the user set to **root** in our ``fujin.toml`` file and ``fujin`` might work with the root user, but I've noticed some issues with it, so I highly recommend creating a custom user.
+Currently, we have the user set to **root** in our **fujin.toml** file and ``fujin`` might work with the root user, but I've noticed some issues with it, so I highly recommend creating a custom user.
 For that, you'll need the root user with SSH access set up on the server.
-Then you'll run the command ``fujin server create-user`` with the username you want to use. You can, for example, use **fujin** as the username.
-For example:
+Then you'll run the command ``fujin server create-user`` with the username you want to use. You can, for example, use *fujin* as the username.
 
 .. code-block:: shell
+    :caption: create-user example
 
     fujin server create-user fujin
 
 This will create a new **fujin** user on your server, add it to the ``sudo`` group with the option to run all commands without having to type a password, and will
 copy the authorized key from the **root** to your new user so that the SSH setup you made for the root user still works with this new one.
-Now update the ``fujin.toml`` file with the new user:
+Now update the **fujin.toml** file with the new user:
 
 .. code-block:: toml
+    :caption: fujin.toml
 
     [host]
     domain_name = "SERVER_IP.sslip.io"
@@ -298,31 +307,33 @@ Now that your project is ready, run the commands below to deploy for the first t
     fujin up
 
 The first time, the process can take a few minutes. At the end of it, you should have a link to your deployed app.
-A few notable commands:
 
-.. code-block:: shell
-    :caption: Deploy an app on a host where fujin has already been set up
+.. admonition:: A few notable commands
+    :class: note dropdown
 
-    fujin deploy
+    .. code-block:: shell
+        :caption: Deploy an app on a host where ``fujin`` has already been set up
 
-You also use the ``deploy`` command when you have changed the fujin config or exported configs:
+        fujin deploy
 
-.. code-block:: shell
-    :caption: Export the systemd config being used so that you can edit them
+    You also use the ``deploy`` command when you have changed the ``fujin`` config or exported configs:
 
-    fujin app export-config
+    .. code-block:: shell
+        :caption: Export the systemd config being used so that you can edit them
 
-.. code-block:: shell
-    :caption: Export the webserver config, in this case, caddy
+        fujin app export-config
 
-    fujin proxy export-config
+    .. code-block:: shell
+        :caption: Export the webserver config, in this case, caddy
 
-and the command you'll probably be running the most:
+        fujin proxy export-config
 
-.. code-block:: shell
-    :caption: When you've only made code and envfile related changes
+    and the command you'll probably be running the most:
+
+    .. code-block:: shell
+        :caption: When you've only made code and envfile related changes
 
-    fujin redeploy
+        fujin redeploy
 
 FAQ
 ---
@@ -333,5 +344,5 @@ What about my database?
 I'm currently using SQLite for my side projects, so this isn't an issue for me at the moment. That's why ``fujin`` does not currently assist with databases. 
 However, you can still SSH into your server and manually install PostgreSQL or any other database or services you need.
 
-I plan to add support for managing additional tools like Redis or databases by declaring containers via the ``fujin.toml`` file. These containers will be managed with ``podman``, 
+I plan to add support for managing additional tools like Redis or databases by declaring containers via the **fujin.toml** file. These containers will be managed with ``podman``,
 To follow the development of this feature, subscribe to this `issue <https://github.com/falcopackages/fujin/issues/17>`_.

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/pyproject.toml

@@ -7,7 +7,7 @@ requires = [
 
 [project]
 name = "fujin-cli"
-version = "0.10.0"
+version = "0.11.5"
 description = "Get your project up and running in a few minutes on your own vps."
 readme = "README.md"
 keywords = [
@@ -72,9 +72,7 @@ docs = [
 ]
 
 [tool.hatch.build.targets.wheel]
-packages = [
-  "src/fujin",
-]
+packages = [ "src/fujin" ]
 
 [tool.ruff]
 # Assume Python {{ python_version }}
@@ -154,7 +152,7 @@ lint.isort.required-imports = [
 lint.pyupgrade.keep-runtime-typing = true
 
 [tool.bumpversion]
-current_version = "0.10.0"
+current_version = "0.11.5"
 parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
 serialize = [
   "{major}.{minor}.{patch}",
@@ -178,6 +176,11 @@ filename = "pyproject.toml"
 search = 'version = "{current_version}"'
 replace = 'version = "{new_version}"'
 
+[[tool.bumpversion.files]]
+filename = "src/fujin/__main__.py"
+replace = 'version="{new_version}"'
+search = 'version="{current_version}"'
+
 [tool.mypy]
 check_untyped_defs = true
 exclude = [

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/src/fujin/__main__.py

@@ -50,9 +50,9 @@ class Fujin:
 def main():
     alias_cmd = _parse_aliases()
     if alias_cmd:
-        cappa.invoke(Fujin, argv=alias_cmd)
+        cappa.invoke(Fujin, argv=alias_cmd, version="0.11.5")
     else:
-        cappa.invoke(Fujin)
+        cappa.invoke(Fujin, version="0.11.5")
 
 
 def _parse_aliases() -> list[str] | None:

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/src/fujin/commands/init.py

@@ -57,7 +57,7 @@ def simple_config(app_name) -> dict:
         "host": {
             "user": "root",
             "domain_name": f"{app_name}.com",
-            "env_content": f"DEBUG=False\nALLOWED_HOSTS={app_name}.com\n",
+            "envfile": ".env.prod",
         },
     }
     if not Path(".python-version").exists():

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/src/fujin/config.py

@@ -1,5 +1,5 @@
 """
-Fujin uses a ``fujin.toml`` file at the root of your project for configuration. Below are all available configuration options.
+Fujin uses a **fujin.toml** file at the root of your project for configuration. Below are all available configuration options.
 
 app
 ---
@@ -7,16 +7,16 @@ The name of your project or application. Must be a valid Python package name.
 
 version
 --------
-The version of your project to build and deploy. If not specified, automatically parsed from ``pyproject.toml`` under ``project.version``.
+The version of your project to build and deploy. If not specified, automatically parsed from **pyproject.toml** under *project.version*.
 
 python_version
 --------------
-The Python version for your virtualenv. If not specified, automatically parsed from ``.python-version`` file. This is only
-required if the installation mode is set to ``python-package``
+The Python version for your virtualenv. If not specified, automatically parsed from **.python-version** file. This is only
+required if the installation mode is set to **python-package**
 
 requirements
 ------------
-Optional path to your requirements file. This will only be used when the installation mode is set to ``python-package``
+Optional path to your requirements file. This will only be used when the installation mode is set to *python-package*
 
 versions_to_keep
 ----------------
@@ -30,32 +30,28 @@ The command to use to build your project's distribution file.
 distfile
 --------
 Path to your project's distribution file. This should be the main artifact containing everything needed to run your project on the server.
-Supports version placeholder, e.g., ``dist/app_name-{version}-py3-none-any.whl``
+Supports version placeholder, e.g., **dist/app_name-{version}-py3-none-any.whl**
 
 installation_mode
 -----------------
 
-Indicates whether the ``distfile`` is a Python package or a self-contained executable. The possible values are ``python-package`` and ``binary``.
-The ``binary`` option disables specific Python-related features, such as virtual environment creation and requirements installation. ``fujin`` will assume the provided
-``distfile`` already contains all the necessary dependencies to run your program.
+Indicates whether the *distfile* is a Python package or a self-contained executable. The possible values are *python-package* and *binary*.
+The *binary* option disables specific Python-related features, such as virtual environment creation and requirements installation. ``fujin`` will assume the provided
+*distfile* already contains all the necessary dependencies to run your program.
 
 release_command
 ---------------
-Optional command to run at the end of deployment (e.g., database migrations).
+Optional command to run at the end of deployment (e.g., database migrations) before your application is started.
 
 secrets
 -------
 
-Optional secrets configuration. If set, Fujin will load secrets from the specified secret management service.
+Optional secrets configuration. If set, ``fujin`` will load secrets from the specified secret management service.
 Check out the `secrets </secrets.html>`_ page for more information.
 
 adapter
 ~~~~~~~
-The secret management service to use. Available options:
-
-- ``bitwarden``
-- ``1password``
-- ``doppler``
+The secret management service to use. The currently available options are *bitwarden*, *1password*, *doppler*
 
 password_env
 ~~~~~~~~~~~~
@@ -64,35 +60,39 @@ Environment variable containing the password for the service account. This is on
 Webserver
 ---------
 
+Web server configurations.
+
 type
 ~~~~
 The reverse proxy implementation to use. Available options:
 
-- ``fujin.proxies.caddy`` (default)
-- ``fujin.proxies.nginx``
-- ``fujin.proxies.dummy`` (disables proxy functionality)
+- *fujin.proxies.caddy* (default)
+- *fujin.proxies.nginx*
+- *fujin.proxies.dummy* (disables proxy)
 
 upstream
 ~~~~~~~~
 The address where your web application listens for requests. Supports any value compatible with your chosen web proxy:
 
-- HTTP address (e.g., ``localhost:8000``)
-- Unix socket (e.g., ``unix//run/project.sock``)
+- HTTP address (e.g., *localhost:8000* )
+- Unix socket caddy (e.g., *unix//run/project.sock* )
+- Unix socket nginx (e.g., *http://unix:/run/project.sock* )
 
 certbot_email
 ~~~~~~~~~~~~~
-Required when Nginx is used as a proxy, to obtain SSL certificates.
+Required when Nginx is used as a proxy to obtain SSL certificates.
 
 statics
 ~~~~~~~
 
 Defines the mapping of URL paths to local directories for serving static files. The syntax and support for static
 file serving depend on the selected reverse proxy. The directories you map should be accessible by the web server, meaning
-with read permissions for the ``www-data`` group; a reliable choice is ``/var/www``.
+with read permissions for the *www-data* group; a reliable choice is **/var/www**.
 
 Example:
 
 .. code-block:: toml
+    :caption: fujin.toml
 
     [webserver]
     upstream = "unix//run/project.sock"
@@ -103,12 +103,12 @@ processes
 ---------
 
 A mapping of process names to commands that will be managed by the process manager. Define as many processes as needed, but
-when using any proxy other than ``fujin.proxies.dummy``, a ``web`` process must be declared.  Refer to the ``apps_dir``
-setting on the host to understand how ``app_dir`` is determined.
+when using any proxy other than *fujin.proxies.dummy*, a *web* process must be declared.
 
 Example:
 
 .. code-block:: toml
+    :caption: fujin.toml
 
     [processes]
     web = ".venv/bin/gunicorn myproject.wsgi:application"
@@ -116,7 +116,8 @@ Example:
 
 .. note::
 
-    Commands are relative to your ``app_dir``. When generating systemd service files, the full path is automatically constructed.
+    Commands are relative to your *app_dir*. When generating systemd service files, the full path is automatically constructed.
+    Refer to the *apps_dir* setting on the host to understand how *app_dir* is determined.
     Here are the templates for the service files:
 
     - `web.service <https://github.com/falcopackages/fujin/blob/main/src/fujin/templates/web.service>`_
@@ -128,7 +129,7 @@ Host Configuration
 
 ip
 ~~
-The IP address or anything that resolves to the remote host IP's. This is use to communicate via ssh with the server, if omitted it's value will default to the one of the ``domain_name``.
+The IP address or anything that resolves to the remote host IP's. This is use to communicate via ssh with the server, if omitted it's value will default to the one of the *domain_name*.
 
 domain_name
 ~~~~~~~~~~~
@@ -142,23 +143,23 @@ The login user for running remote tasks. Should have passwordless sudo access fo
 
     You can create a user with these requirements using the ``fujin server create-user`` command.
 
-env_file
-~~~~~~~~
+envfile
+~~~~~~~
 Path to the production environment file that will be copied to the host.
 
-env_content
-~~~~~~~~~~~
+env
+~~~
 A string containing the production environment variables, ideal for scenarios where most variables are retrieved from secrets and you prefer not to use a separate file.
 
 .. important::
 
-    ``env_file`` and ``env_content`` are mutually exclusive—you can define only one.
+    *envfile* and *env* are mutually exclusive—you can define only one.
 
 apps_dir
 ~~~~~~~~
 
 Base directory for project storage on the host. Path is relative to user's home directory.
-Default: ``.local/share/fujin``. This value determines your project's ``app_dir``, which is ``{apps_dir}/{app}``.
+Default: **.local/share/fujin**. This value determines your project's **app_dir**, which is **{apps_dir}/{app}**.
 
 password_env
 ~~~~~~~~~~~~
@@ -168,8 +169,7 @@ Environment variable containing the user's password. Only needed if the user can
 ssh_port
 ~~~~~~~~
 
-SSH port for connecting to the host.
-Default: ``22``
+SSH port for connecting to the host. Default to **22**.
 
 key_filename
 ~~~~~~~~~~~~
@@ -184,6 +184,7 @@ A mapping of shortcut names to Fujin commands. Allows you to create convenient s
 Example:
 
 .. code-block:: toml
+    :caption: fujin.toml
 
     [aliases]
     console = "app exec -i shell_plus" # open an interactive django shell
@@ -223,6 +224,7 @@ class SecretAdapter(StrEnum):
     BITWARDEN = "bitwarden"
     ONE_PASSWORD = "1password"
     DOPPLER = "doppler"
+    SYSTEM = "system"
 
 
 class SecretConfig(msgspec.Struct):
@@ -246,7 +248,10 @@ class Config(msgspec.Struct, kw_only=True):
     requirements: str | None = None
     hooks: HooksDict = msgspec.field(default_factory=dict)
     local_config_dir: Path = Path(".fujin")
-    secret_config: SecretConfig | None = msgspec.field(name="secrets", default=None)
+    secret_config: SecretConfig | None = msgspec.field(
+        name="secrets",
+        default_factory=lambda: SecretConfig(adapter=SecretAdapter.SYSTEM),
+    )
 
     def __post_init__(self):
         if self.installation_mode == InstallationMode.PY_PACKAGE:
@@ -285,8 +290,8 @@ class HostConfig(msgspec.Struct, kw_only=True):
     ip: str | None = None
     domain_name: str
     user: str
-    _env_file: str = msgspec.field(name="envfile", default="")
-    env_content: str = ""
+    _env_file: str | None = msgspec.field(name="envfile", default=None)
+    env_content: str | None = msgspec.field(name="env", default=None)
     apps_dir: str = ".local/share/fujin"
     password_env: str | None = None
     ssh_port: int = 22
@@ -295,14 +300,14 @@ class HostConfig(msgspec.Struct, kw_only=True):
     def __post_init__(self):
         if self._env_file and self.env_content:
             raise ImproperlyConfiguredError(
-                "Cannot set both 'env_content' and 'env_file' properties."
+                "Cannot set both 'env' and 'envfile' properties."
             )
-        if not self.env_content:
+        if self._env_file:
             envfile = Path(self._env_file)
             if not envfile.exists():
                 raise ImproperlyConfiguredError(f"{self._env_file} not found")
             self.env_content = envfile.read_text()
-        self.env_content = self.env_content.strip()
+        self.env_content = self.env_content.strip() if self.env_content else ""
         self.apps_dir = f"/home/{self.user}/{self.apps_dir}"
         self.ip = self.ip or self.domain_name
 

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/src/fujin/secrets/__init__.py

@@ -12,11 +12,13 @@ from fujin.config import SecretConfig
 from .bitwarden import bitwarden
 from .dopppler import doppler
 from .onepassword import one_password
+from .system import system
 
 secret_reader = Callable[[str], str]
 secret_adapter_context = Callable[[SecretConfig], ContextManager[secret_reader]]
 
 adapter_to_context: dict[SecretAdapter, secret_adapter_context] = {
+    SecretAdapter.SYSTEM: system,
     SecretAdapter.BITWARDEN: bitwarden,
     SecretAdapter.ONE_PASSWORD: one_password,
     SecretAdapter.DOPPLER: doppler,
@@ -24,6 +26,8 @@ adapter_to_context: dict[SecretAdapter, secret_adapter_context] = {
 
 
 def resolve_secrets(env_content: str, secret_config: SecretConfig) -> str:
+    if not env_content:  # this is really for empty string
+        return ""
     with closing(StringIO(env_content)) as buffer:
         env_dict = dotenv_values(stream=buffer)
     secrets = {key: value for key, value in env_dict.items() if value.startswith("$")}
@@ -33,7 +37,9 @@ def resolve_secrets(env_content: str, secret_config: SecretConfig) -> str:
     parsed_secrets = {}
     with adapter_context(secret_config) as reader:
         for key, secret in secrets.items():
-            parsed_secrets[key] = gevent.spawn(reader, secret[1:])
+            parsed_secrets[key] = gevent.spawn(
+                reader, secret[1:]
+            )  # remove the leading $
         gevent.joinall(parsed_secrets.values())
     env_dict.update({key: thread.value for key, thread in parsed_secrets.items()})
     return "\n".join(f'{key}="{value}"' for key, value in env_dict.items())

fujin_cli-0.11.5/src/fujin/secrets/system.py

@@ -0,0 +1,19 @@
+from __future__ import annotations
+
+import os
+from contextlib import contextmanager
+from typing import Generator
+from typing import TYPE_CHECKING
+
+from fujin.config import SecretConfig
+
+if TYPE_CHECKING:
+    from . import secret_reader
+
+
+@contextmanager
+def system(_: SecretConfig) -> Generator[secret_reader, None, None]:
+    try:
+        yield os.getenv
+    finally:
+        pass

fujin_cli-0.11.5/src/fujin/templates/granian/web.service

@@ -0,0 +1,22 @@
+# 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
+After=network.target
+
+[Service]
+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_cli-0.10.0/src/fujin/templates → fujin_cli-0.11.5/src/fujin/templates/gunicorn}/web.service

@@ -6,8 +6,8 @@ Requires={app_name}.socket
 After=network.target
 
 [Service]
-#Type=notify
-#NotifyAccess=main
+Type=notify
+NotifyAccess=main
 User={user}
 Group={user}
 RuntimeDirectory={app_name}

{fujin_cli-0.10.0 → fujin_cli-0.11.5}/src/fujin/templates/simple.service

@@ -1,6 +1,7 @@
 # All options are documented here https://www.freedesktop.org/software/systemd/man/latest/systemd.exec.html
 [Unit]
-Description={app_name} Worker
+Description={app_name} {process_name}
+After=network.target
 
 [Service]
 User={user}

fujin_cli-0.11.5/src/fujin/templates/web.service

@@ -0,0 +1,22 @@
+# 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
+After=network.target
+
+[Service]
+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_cli-0.11.5/src/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.10.0 → fujin_cli-0.11.5}/uv.lock

@@ -1,4 +1,5 @@
 version = 1
+revision = 1
 requires-python = ">=3.10"
 
 [manifest]
@@ -304,7 +305,7 @@ name = "click"
 version = "8.1.7"
 source = { registry = "https://pypi.org/simple" }
 dependencies = [
-    { name = "colorama", marker = "platform_system == 'Windows'" },
+    { name = "colorama", marker = "sys_platform == 'win32'" },
 ]
 sdist = { url = "https://files.pythonhosted.org/packages/96/d3/f04c7bfcf5c1862a2a5b845c6b2b360488cf47af55dfa79c98f6a6bf98b5/click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de", size = 336121 }
 wheels = [
@@ -477,7 +478,7 @@ wheels = [
 
 [[package]]
 name = "fujin-cli"
-version = "0.10.0"
+version = "0.11.4"
 source = { editable = "." }
 dependencies = [
     { name = "cappa" },
@@ -586,7 +587,7 @@ wheels = [
 [package.optional-dependencies]
 recommended = [
     { name = "cffi", marker = "platform_python_implementation == 'CPython'" },
-    { name = "psutil", marker = "sys_platform != 'win32' or platform_python_implementation == 'CPython'" },
+    { name = "psutil", marker = "platform_python_implementation == 'CPython' or sys_platform != 'win32'" },
 ]
 
 [[package]]