Improve some command names

Author: medihack

.devcontainer/post-create.sh

@@ -2,5 +2,5 @@
 
 npm install
 uv sync
-uv run activate-global-python-argcomplete
-uv run ./cli.py init_workspace
+uv run activate-global-python-argcomplete -y
+uv run ./cli.py init-workspace

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Install dependencies
         run: uv sync
       - name: Configure environment
-        run: uv run ./cli.py init_workspace
+        run: uv run ./cli.py init-workspace
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
       - name: Build and cache Docker images
@@ -37,7 +37,7 @@ jobs:
           cache-from: type=gha
           cache-to: type=gha,mode=max
       - name: Start Docker containers
-        run: uv run ./cli.py compose_up --no-build
+        run: uv run ./cli.py compose-up --no-build
       - name: Run linting
         # https://github.com/actions/runner/issues/241#issuecomment-745902718
         shell: 'script -q -e -c "bash {0}"'
@@ -47,4 +47,4 @@ jobs:
         run: uv run ./cli.py test --cov
       - name: Stop Docker containers
         if: ${{ always() }}
-        run: uv run ./cli.py compose_down
+        run: uv run ./cli.py compose-down

CONTRIBUTING.md

@@ -24,10 +24,10 @@ It also contains a Django example project to play around with the features.
 git clone https://github.com/openradx/adit-radis-shared.git
 cd adit-radis-shared
 uv sync
-uv run ./cli.py compose_up
+uv run ./cli.py compose-up
 ```
 
 The development server of the example project will be started on <http://localhost:8000>
 
 If a library dependency is changed, the containers need to be rebuilt (e.g. by running
-`uv run ./cli.py compose_down && uv run ./cli.py compose_up`).
+`uv run ./cli.py compose-down && uv run ./cli.py compose-up`).

adit_radis_shared/cli/commands.py

@@ -10,37 +10,6 @@
 from .helper import CommandHelper
 
 
-def register_backup_db(subparsers: argparse._SubParsersAction):
-    def call(**kwargs):
-        helper = CommandHelper()
-
-        settings = (
-            f"{helper.project_id}.settings.production"
-            if helper.is_production()
-            else f"{helper.project_id}.settings.development"
-        )
-
-        web_container_id = helper.find_running_container_id("web")
-        if web_container_id is None:
-            sys.exit("Web container is not running.")
-
-        helper.execute_cmd(
-            (
-                f"docker exec --env DJANGO_SETTINGS_MODULE={settings} "
-                f"{web_container_id} ./manage.py dbbackup --clean -v 2"
-            )
-        )
-
-    info = "Backup database in running container stack"
-    parser = subparsers.add_parser(
-        "backup_db",
-        help=info,
-        description=info,
-        epilog="For backup location see DBBACKUP_STORAGE_OPTIONS setting",
-    )
-    parser.set_defaults(func=call)
-
-
 def register_compose_up(subparsers: argparse._SubParsersAction):
     def call(build: bool, profile: list[str], extra_args: list[str], **kwargs):
         helper = CommandHelper()
@@ -64,7 +33,7 @@ def call(build: bool, profile: list[str], extra_args: list[str], **kwargs):
         helper.execute_cmd(cmd)
 
     info = "Start stack with docker compose"
-    parser = subparsers.add_parser("compose_up", help=info, description=info)
+    parser = subparsers.add_parser("compose-up", help=info, description=info)
     parser.add_argument("--build", action="store_true", help="Build images before starting")
     parser.add_argument("--profile", action="append", help="Docker compose profile(s) to use")
     parser.set_defaults(func=call)
@@ -81,12 +50,68 @@ def call(cleanup: bool, profile: list[str], **kwargs):
         helper.execute_cmd(cmd)
 
     info = "Stop stack with docker compose"
-    parser = subparsers.add_parser("compose_down", help=info, description=info)
+    parser = subparsers.add_parser("compose-down", help=info, description=info)
     parser.add_argument("--cleanup", action="store_true", help="Remove orphans and volumes")
     parser.add_argument("--profile", action="append", help="Docker compose profile(s) to use")
     parser.set_defaults(func=call)
 
 
+def register_db_backup(subparsers: argparse._SubParsersAction):
+    def call(**kwargs):
+        helper = CommandHelper()
+
+        settings = (
+            f"{helper.project_id}.settings.production"
+            if helper.is_production()
+            else f"{helper.project_id}.settings.development"
+        )
+
+        web_container_id = helper.find_running_container_id("web")
+        if web_container_id is None:
+            sys.exit("Web container is not running.")
+
+        helper.execute_cmd(
+            (
+                f"docker exec --env DJANGO_SETTINGS_MODULE={settings} "
+                f"{web_container_id} ./manage.py dbbackup --clean -v 2"
+            )
+        )
+
+    info = "Backup database in running container stack"
+    parser = subparsers.add_parser(
+        "db-backup",
+        help=info,
+        description=info,
+        epilog="For backup location see DBBACKUP_STORAGE_OPTIONS setting",
+    )
+    parser.set_defaults(func=call)
+
+
+def register_db_restore(subparsers: argparse._SubParsersAction):
+    def call(**kwargs):
+        helper = CommandHelper()
+
+        settings = (
+            f"{helper.project_id}.settings.production"
+            if helper.is_production()
+            else f"{helper.project_id}.settings.development"
+        )
+        web_container_id = helper.find_running_container_id("web")
+        if web_container_id is None:
+            sys.exit("Web container is not running. Run 'uv run ./manage.py compose-up' first.")
+
+        helper.execute_cmd(
+            (
+                f"docker exec --env DJANGO_SETTINGS_MODULE={settings} "
+                f"{web_container_id} ./manage.py dbrestore"
+            )
+        )
+
+    info = "Restore database in container from the last backup"
+    parser = subparsers.add_parser("db-restore", help=info, description=info)
+    parser.set_defaults(func=call)
+
+
 def register_format_code(subparsers: argparse._SubParsersAction):
     def call(**kwargs):
         helper = CommandHelper()
@@ -101,7 +126,7 @@ def call(**kwargs):
         helper.execute_cmd("uv run djlint . --reformat")
 
     parser = subparsers.add_parser(
-        "format_code",
+        "format-code",
         help="Format the source code with ruff and djlint",
     )
     parser.set_defaults(func=call)
@@ -113,7 +138,7 @@ def call(length: int, **kwargs):
         print(helper.generate_auth_token(length))
 
     info = "Generate an authentication token"
-    parser = subparsers.add_parser("generate_auth_token", help=info, description=info)
+    parser = subparsers.add_parser("generate-auth-token", help=info, description=info)
     parser.add_argument("--length", type=int, default=20, help="Length of the token (default: 20)")
     parser.set_defaults(func=call)
 
@@ -174,7 +199,7 @@ def call(**kwargs):
             print(f"Generated chain file at {chain_path.absolute()}")
 
     info = "Generate certificate chain file for a signed certificate"
-    parser = subparsers.add_parser("generate_certificate_chain", help=info, description=info)
+    parser = subparsers.add_parser("generate-certificate-chain", help=info, description=info)
     parser.set_defaults(func=call)
 
 
@@ -236,7 +261,7 @@ def call(**kwargs):
             print(f"Generated chain file at {chain_path.absolute()}")
 
     info = "Generate self-signed certificate files for local development"
-    parser = subparsers.add_parser("generate_certificate_files", help=info, description=info)
+    parser = subparsers.add_parser("generate-certificate-files", help=info, description=info)
     parser.set_defaults(func=call)
 
 
@@ -246,7 +271,7 @@ def call(**kwargs):
         print(helper.generate_django_secret_key())
 
     info = "Generate a Django secret key"
-    parser = subparsers.add_parser("generate_django_secret_key", help=info, description=info)
+    parser = subparsers.add_parser("generate-django-secret-key", help=info, description=info)
     parser.set_defaults(func=call)
 
 
@@ -256,7 +281,7 @@ def call(length: int, **kwargs):
         print(helper.generate_secure_password(length))
 
     info = "Generate a secure password"
-    parser = subparsers.add_parser("generate_secure_password", help=info, description=info)
+    parser = subparsers.add_parser("generate-secure-password", help=info, description=info)
     parser.add_argument(
         "--length", type=int, default=12, help="Length of the password (default: 12)"
     )
@@ -308,7 +333,7 @@ def modify_env_file(domain: str | None = None, uses_https: bool = False):
         print("Successfully initialized .env file.")
 
     info = "Initialize workspace for Github Codespaces or local development"
-    parser = subparsers.add_parser("init_workspace", help=info, description=info)
+    parser = subparsers.add_parser("init-workspace", help=info, description=info)
     parser.set_defaults(func=call)
 
 
@@ -344,32 +369,7 @@ def call(**kwags):
         set_key(env_file, "ADMIN_AUTH_TOKEN", helper.generate_auth_token())
 
     info = "Randomize secrets in the .env file"
-    parser = subparsers.add_parser("randomize_env_secrets", help=info, description=info)
-    parser.set_defaults(func=call)
-
-
-def register_restore_db(subparsers: argparse._SubParsersAction):
-    def call(**kwargs):
-        helper = CommandHelper()
-
-        settings = (
-            f"{helper.project_id}.settings.production"
-            if helper.is_production()
-            else f"{helper.project_id}.settings.development"
-        )
-        web_container_id = helper.find_running_container_id("web")
-        if web_container_id is None:
-            sys.exit("Web container is not running. Run 'uv run ./manage.py compose-up' first.")
-
-        helper.execute_cmd(
-            (
-                f"docker exec --env DJANGO_SETTINGS_MODULE={settings} "
-                f"{web_container_id} ./manage.py dbrestore"
-            )
-        )
-
-    info = "Restore database in container from the last backup"
-    parser = subparsers.add_parser("restore_db", help=info, description=info)
+    parser = subparsers.add_parser("randomize-env-secrets", help=info, description=info)
     parser.set_defaults(func=call)
 
 
@@ -400,7 +400,7 @@ def call(**kwargs):
         helper.execute_cmd("npm outdated", hidden=True)
 
     info = "Show outdated dependencies"
-    parser = subparsers.add_parser("show_outdated", help=info, description=info)
+    parser = subparsers.add_parser("show-outdated", help=info, description=info)
     parser.set_defaults(func=call)
 
 
@@ -431,7 +431,7 @@ def call(build: bool, **kwargs):
         helper.execute_cmd(cmd, env=env)
 
     info = "Deploy stack with docker swarm"
-    parser = subparsers.add_parser("stack_deploy", help=info, description=info)
+    parser = subparsers.add_parser("stack-deploy", help=info, description=info)
     parser.add_argument("--build", action="store_true", help="Build images")
     parser.set_defaults(func=call)
 
@@ -442,7 +442,7 @@ def call(**kwargs):
         helper.execute_cmd(f"docker stack rm {helper.get_stack_name()}")
 
     info = "Remove stack from docker swarm"
-    parser = subparsers.add_parser("stack_rm", help=info, description=info)
+    parser = subparsers.add_parser("stack-rm", help=info, description=info)
     parser.set_defaults(func=call)
 
 
@@ -482,7 +482,7 @@ def call(**kwargs):
         helper.execute_cmd(f"{act_path} -P ubuntu-latest=catthehacker/ubuntu:act-latest")
 
     info = "Try Github Actions locally using Act"
-    parser = subparsers.add_parser("try_github_actions", help=info, description=info)
+    parser = subparsers.add_parser("try-github-actions", help=info, description=info)
     parser.set_defaults(func=call)
 
 
@@ -504,7 +504,7 @@ def call(version: str, **kwargs):
             print("Cancelled")
 
     info = "Upgrade PostgreSQL volume data"
-    parser = subparsers.add_parser("upgrade_postgres_volume", help=info, description=info)
+    parser = subparsers.add_parser("upgrade-postgres-volume", help=info, description=info)
     parser.add_argument(
         "--version",
         type=str,

cli.py

@@ -54,9 +54,10 @@ def copy_file(file: str, filename: str | None = None):
     parser = argparse.ArgumentParser()
     subparsers = parser.add_subparsers(dest="command")
 
-    commands.register_backup_db(subparsers)
     commands.register_compose_up(subparsers)
     commands.register_compose_down(subparsers)
+    commands.register_db_backup(subparsers)
+    commands.register_db_restore(subparsers)
     commands.register_format_code(subparsers)
     commands.register_generate_auth_token(subparsers)
     commands.register_generate_certificate_chain(subparsers)
@@ -66,7 +67,6 @@ def copy_file(file: str, filename: str | None = None):
     commands.register_init_workspace(subparsers)
     commands.register_lint(subparsers)
     commands.register_randomize_env_secrets(subparsers)
-    commands.register_restore_db(subparsers)
     commands.register_shell(subparsers)
     commands.register_show_outdated(subparsers)
     commands.register_stack_deploy(subparsers)

example.env

@@ -68,7 +68,7 @@ SITE_DOMAIN=localhost
 # These variables are used to create a certificate key, self-signed certificate,
 # and the corresponding certificate chain. If you have an existing certificate
 # key and signed certificate from your CA, you can generate the corresponding
-# certificate chain using 'uv run ./cli.py generate_certificate_chain'.
+# certificate chain using 'uv run ./cli.py generate-certificate-chain'.
 SSL_HOSTNAME=localhost
 SSL_IP_ADDRESSES=127.0.0.1
 SSL_SERVER_CERT_FILE="./cert.pem"

package.json

@@ -9,6 +9,6 @@
     "htmx.org": "^1.9.5"
   },
   "scripts": {
-    "copy-statics": "uv run ./cli.py copy_statics"
+    "copy-statics": "uv run ./cli.py copy-statics"
   }
 }