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

fujin_cli-0.2.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.2.0/.gitignore

@@ -0,0 +1,150 @@
+# 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

fujin_cli-0.2.0/Dockerfile

@@ -0,0 +1,39 @@
+FROM ubuntu:latest
+
+# Update and install necessary packages
+RUN apt update && apt install -y openssh-server sudo
+
+# Create the user 'test' and passwordless sudo
+RUN useradd -rm -d /home/test -s /bin/bash -g root -G sudo -u 2000 test && \
+    echo 'test:test' | chpasswd && \
+    echo 'test ALL=(ALL) NOPASSWD:ALL' >> /etc/sudoers
+
+# Set up SSH server
+RUN mkdir /var/run/sshd
+
+# Copy the public key and set correct permissions for SSH
+COPY id_rsa.pub /tmp/id_rsa.pub
+RUN mkdir -p /home/test/.ssh && \
+     cat /tmp/id_rsa.pub >> /home/test/.ssh/authorized_keys && \
+     chown -R 2000:root /home/test/.ssh && \
+     chmod 700 /home/test/.ssh && \
+     chmod 600 /home/test/.ssh/authorized_keys
+
+# Ensure SSH is configured to accept key-based login
+RUN sed -i 's/#PasswordAuthentication yes/PasswordAuthentication no/' /etc/ssh/sshd_config && \
+     sed -i 's/#PermitRootLogin prohibit-password/PermitRootLogin no/' /etc/ssh/sshd_config && \
+     sed -i 's/#PubkeyAuthentication yes/PubkeyAuthentication yes/' /etc/ssh/sshd_config && \
+     echo AllowUsers test >> /etc/ssh/sshd_config
+
+# Start SSH service
+RUN service ssh start
+
+# Expose the SSH port
+EXPOSE 22
+
+# Run the SSH server
+CMD ["/usr/sbin/sshd", "-D"]
+#VOLUME [ "/sys/fs/cgroup" ]
+#CMD ["/lib/systemd/systemd"]
+#VOLUME [ "/sys/fs/cgroup" ]
+#CMD ["/lib/systemd/systemd"]

fujin_cli-0.2.0/PKG-INFO

@@ -0,0 +1,52 @@
+Metadata-Version: 2.3
+Name: fujin-cli
+Version: 0.2.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
+Classifier: Development Status :: 4 - Beta
+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 :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Requires-Python: >=3.10
+Requires-Dist: cappa>=0.24.0
+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)
+
+-----
+
+> [!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-cli
+```
+
+## License
+
+`fujin` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

{fujin_cli-0.1.0 → fujin_cli-0.2.0}/README.md

@@ -1,7 +1,7 @@
 # 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)
+[![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)
 
 -----
 
@@ -18,7 +18,7 @@
 ## Installation
 
 ```console
-pip install fujin
+pip install fujin-cli
 ```
 
 ## License

fujin_cli-0.2.0/examples/django/bookstore/bookstore/__main__.py

@@ -0,0 +1,22 @@
+#!/usr/bin/env python
+"""Django's command-line utility for administrative tasks."""
+import os
+import sys
+
+
+def main():
+    """Run administrative tasks."""
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "bookstore.settings")
+    try:
+        from django.core.management import execute_from_command_line
+    except ImportError as exc:
+        raise ImportError(
+            "Couldn't import Django. Are you sure it's installed and "
+            "available on your PYTHONPATH environment variable? Did you "
+            "forget to activate a virtual environment?"
+        ) from exc
+    execute_from_command_line(sys.argv)
+
+
+if __name__ == "__main__":
+    main()

fujin_cli-0.2.0/examples/django/bookstore/bookstore/asgi.py

@@ -0,0 +1,16 @@
+"""
+ASGI config for bookstore project.
+
+It exposes the ASGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/asgi/
+"""
+
+import os
+
+from django.core.asgi import get_asgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "bookstore.settings")
+
+application = get_asgi_application()

fujin_cli-0.2.0/examples/django/bookstore/bookstore/settings.py

@@ -0,0 +1,123 @@
+"""
+Django settings for bookstore project.
+
+Generated by 'django-admin startproject' using Django 4.2.7.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/4.2/ref/settings/
+"""
+
+from pathlib import Path
+
+# Build paths inside the project like this: BASE_DIR / 'subdir'.
+BASE_DIR = Path(__file__).resolve().parent.parent
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/4.2/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = "django-insecure-ln^v=)@o0%ix09*f47+d7n)0&3@ut1gc8e9)p@rd@ex#e#qg^j"
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+ALLOWED_HOSTS = []
+
+
+# Application definition
+
+INSTALLED_APPS = [
+    "django.contrib.admin",
+    "django.contrib.auth",
+    "django.contrib.contenttypes",
+    "django.contrib.sessions",
+    "django.contrib.messages",
+    "django.contrib.staticfiles",
+]
+
+MIDDLEWARE = [
+    "django.middleware.security.SecurityMiddleware",
+    "django.contrib.sessions.middleware.SessionMiddleware",
+    "django.middleware.common.CommonMiddleware",
+    "django.middleware.csrf.CsrfViewMiddleware",
+    "django.contrib.auth.middleware.AuthenticationMiddleware",
+    "django.contrib.messages.middleware.MessageMiddleware",
+    "django.middleware.clickjacking.XFrameOptionsMiddleware",
+]
+
+ROOT_URLCONF = "bookstore.urls"
+
+TEMPLATES = [
+    {
+        "BACKEND": "django.template.backends.django.DjangoTemplates",
+        "DIRS": [],
+        "APP_DIRS": True,
+        "OPTIONS": {
+            "context_processors": [
+                "django.template.context_processors.debug",
+                "django.template.context_processors.request",
+                "django.contrib.auth.context_processors.auth",
+                "django.contrib.messages.context_processors.messages",
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = "bookstore.wsgi.application"
+
+
+# Database
+# https://docs.djangoproject.com/en/4.2/ref/settings/#databases
+
+DATABASES = {
+    "default": {
+        "ENGINE": "django.db.backends.sqlite3",
+        "NAME": BASE_DIR / "db.sqlite3",
+    }
+}
+
+
+# Password validation
+# https://docs.djangoproject.com/en/4.2/ref/settings/#auth-password-validators
+
+AUTH_PASSWORD_VALIDATORS = [
+    {
+        "NAME": "django.contrib.auth.password_validation.UserAttributeSimilarityValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.MinimumLengthValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.CommonPasswordValidator",
+    },
+    {
+        "NAME": "django.contrib.auth.password_validation.NumericPasswordValidator",
+    },
+]
+
+
+# Internationalization
+# https://docs.djangoproject.com/en/4.2/topics/i18n/
+
+LANGUAGE_CODE = "en-us"
+
+TIME_ZONE = "UTC"
+
+USE_I18N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/4.2/howto/static-files/
+
+STATIC_URL = "static/"
+
+# Default primary key field type
+# https://docs.djangoproject.com/en/4.2/ref/settings/#default-auto-field
+
+DEFAULT_AUTO_FIELD = "django.db.models.BigAutoField"

fujin_cli-0.2.0/examples/django/bookstore/bookstore/urls.py

@@ -0,0 +1,23 @@
+"""
+URL configuration for bookstore project.
+
+The `urlpatterns` list routes URLs to views. For more information please see:
+    https://docs.djangoproject.com/en/4.2/topics/http/urls/
+Examples:
+Function views
+    1. Add an import:  from my_app import views
+    2. Add a URL to urlpatterns:  path('', views.home, name='home')
+Class-based views
+    1. Add an import:  from other_app.views import Home
+    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')
+Including another URLconf
+    1. Import the include() function: from django.urls import include, path
+    2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
+"""
+
+from django.contrib import admin
+from django.urls import path
+
+urlpatterns = [
+    path("admin/", admin.site.urls),
+]

fujin_cli-0.2.0/examples/django/bookstore/bookstore/wsgi.py

@@ -0,0 +1,16 @@
+"""
+WSGI config for bookstore project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/4.2/howto/deployment/wsgi/
+"""
+
+import os
+
+from django.core.wsgi import get_wsgi_application
+
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "bookstore.settings")
+
+application = get_wsgi_application()

fujin_cli-0.2.0/examples/django/bookstore/fujin.toml

@@ -0,0 +1,29 @@
+app = "bookstore"
+#version = "0.1.0" infer from the pyproject.toml file
+requirements = "requirements.txt"
+build_command = "uv build"
+distfile = "./../../../dist/bookstore-{version}-py3-none-any.whl"
+webserver = { upstream = "localhost:8000" } # or "unix:/run/bookstore.sock"
+
+[hooks]
+pre_deploy = ".venv/bin/bookstore migrate"
+
+[aliases]
+console = "app exec -i shell"
+dbshell = "app exec -i dbshell"
+shell = "server exec -i bash"
+
+[processes]
+web = ".venv/bin/bookstore prodserver"
+worker = ".venv/bin/bookstore qcluster"
+
+[hosts.primary]
+default = true
+ip = "127.0.0.1"
+domain_name = "mybookstore.com"
+envfile = ".env.prod"
+user = "test"
+password_env = "TEST_PASSWORD"
+key_filename = "./../../../id_rsa"
+ssh_port = 2222
+# projects_dir = ".local/share/fujin" # relative to user home

fujin_cli-0.2.0/examples/django/bookstore/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "bookstore"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "django>=5.1.2",
+]
+
+[project.scripts]
+bookstore = "bookstore.__main__:main"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

fujin_cli-0.2.0/examples/django/bookstore/requirements.txt

@@ -0,0 +1,8 @@
+# This file was autogenerated by uv via the following command:
+#    uv --project bookstore pip compile pyproject.toml -o requirements.txt
+asgiref==3.8.1
+    # via django
+django==5.1.2
+    # via bookstore (pyproject.toml)
+sqlparse==0.5.1
+    # via django

fujin_cli-0.2.0/justfile

@@ -0,0 +1,73 @@
+set dotenv-load := true
+
+# List all available commands
+_default:
+    @just --list --unsorted
+
+# Run a command in the environment
+run *ARGS:
+    uv run {{ ARGS }}
+
+# Create test ubuntu container
+create-test-container:
+    rm id_rsa && rm id_rsa.pub > /dev/null 2>&1 || true
+    ssh-keygen -t rsa -N "" -f id_rsa
+    docker stop sshserver && docker rm sshserver > /dev/null 2>&1 || true
+    docker build -t sshserver .
+    docker run -d -p 2222:22 -p 8000:80 --name sshserver sshserver
+#    docker run --privileged \
+#    -v /run/systemd/system:/run/systemd/system \
+#    -v /lib/systemd:/lib/systemd \
+#    -v /var/run/dbus/system_bus_socket:/var/run/dbus/system_bus_socket \
+#    -p 2222:22 \
+#    -p 8000:80 \
+#    --name sshserver \
+#    -it sshserver \
+#    bash -c "ln -s /usr/lib/x86_64-linux-gnu/libtinfo.so.6 /usr/lib/x86_64-linux-gnu/libtinfo.so.5 && bash"
+
+# SSH into test container
+ssh:
+    ssh -i id_rsa test@localhost -p 2222
+
+# Run uv command in the django example project
+djuv *ARGS:
+    #!/usr/bin/env bash
+    cd examples/django/bookstore
+    uv --project bookstore {{ ARGS }}
+
+# Generate django project requirements:
+dj-requirements:
+    just djuv pip compile pyproject.toml -o requirements.txt
+
+# Run fujin command in the django example project
+fujin *ARGS:
+    #!/usr/bin/env bash
+    cd examples/django/bookstore
+    ../../../.venv/bin/python -m fujin {{ ARGS }}
+
+# -------------------------------------------------------------------------
+# RELEASE UTILITIES
+#---------------------------------------------------------------------------
+
+# Generate changelog, useful to update the unreleased section
+logchange:
+    just run git-cliff --output CHANGELOG.md
+
+# Bump project version and update changelog
+bumpver VERSION:
+    #!/usr/bin/env bash
+    set -euo pipefail
+    just run bump-my-version bump {{ VERSION }}
+    just run git-cliff --output CHANGELOG.md
+
+    if [ -z "$(git status --porcelain)" ]; then
+        echo "No changes to commit."
+        git push && git push --tags
+        exit 0
+    fi
+
+    version="$(hatch version)"
+    git add CHANGELOG.md
+    git commit -m "Generate changelog for version ${version}"
+    git tag -f "v${version}"
+    git push && git push --tags