sum-cli 3.0.0__tar.gz → 3.1.0__tar.gz

sum_cli-3.1.0/PKG-INFO

@@ -0,0 +1,230 @@
+Metadata-Version: 2.4
+Name: sum-cli
+Version: 3.1.0
+Summary: SUM Platform CLI: single control plane for site lifecycle management
+Author: Mark Ashton
+License-Expression: BSD-3-Clause
+Project-URL: Homepage, https://github.com/markashton480/sum-platform
+Project-URL: Repository, https://github.com/markashton480/sum-platform
+Project-URL: Issues, https://github.com/markashton480/sum-platform/issues
+Project-URL: Documentation, https://github.com/markashton480/sum-platform/tree/main/docs/dev/cli.md
+Keywords: sum,cli,django,wagtail
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: click>=8.1.7
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: gitea
+Requires-Dist: httpx>=0.27.0; extra == "gitea"
+Dynamic: license-file
+
+# SUM CLI (v3.1)
+
+[![PyPI](https://img.shields.io/pypi/v/sum-cli.svg)](https://pypi.org/project/sum-cli/)
+
+The SUM CLI is the single control plane for deploying and managing SUM Platform client sites on staging and production servers.
+
+## Install
+
+```bash
+pip install sum-cli
+sum-platform --version
+```
+
+### With Gitea Support
+
+If using Gitea instead of GitHub for repository hosting:
+
+```bash
+pip install sum-cli[gitea]
+```
+
+## Initial Setup
+
+Before using the CLI, configure your infrastructure settings:
+
+```bash
+sudo sum-platform setup
+```
+
+This interactive command creates `/etc/sum/config.yml` with your staging/production server settings.
+
+## Commands
+
+| Command | Description | Requires Sudo |
+|---------|-------------|---------------|
+| `setup` | Configure infrastructure settings | Yes |
+| `init` | Create new site at `/srv/sum/<name>/` | Yes |
+| `update` | Pull updates, migrate, restart | No (staging) |
+| `backup` | Database and media backup | No |
+| `promote` | Deploy staging site to production | No |
+| `check` | Validate project setup | No |
+| `themes` | List available themes | No |
+
+## Creating Sites
+
+### With GitHub
+
+```bash
+sudo sum-platform init acme --git-provider github --git-org acme-corp
+```
+
+### With Gitea
+
+```bash
+sudo sum-platform init acme --git-provider gitea --git-org clients \
+  --gitea-url https://gitea.agency.com
+```
+
+### With Gitea (Custom SSH Port)
+
+```bash
+sudo sum-platform init acme --git-provider gitea --git-org clients \
+  --gitea-url https://gitea.agency.com --gitea-ssh-port 2222
+```
+
+### Without Git
+
+```bash
+sudo sum-platform init acme --no-git
+```
+
+### Additional Init Options
+
+```bash
+sudo sum-platform init acme --git-provider github --git-org acme-corp \
+  --theme theme_a \
+  --profile sage-stone \
+  --content-path /path/to/custom/content
+```
+
+## Managing Sites
+
+```bash
+# Update a deployed site (pull, migrate, restart)
+sum-platform update acme
+
+# Backup database and media
+sum-platform backup acme --include-media
+
+# Promote staging to production
+sum-platform promote acme --domain acme.example.com
+
+# Validate project setup
+sum-platform check acme
+
+# List available themes
+sum-platform themes
+```
+
+## Configuration
+
+### Global Config (`/etc/sum/config.yml`)
+
+Infrastructure settings only. Created via `sum-platform setup`.
+
+```yaml
+agency:
+  name: Your Agency Name
+
+staging:
+  server: staging.example.com
+  domain_pattern: "{slug}.staging.example.com"
+  base_dir: /srv/sum
+
+production:
+  server: prod.example.com
+  ssh_host: 10.0.0.1
+  base_dir: /srv/sum
+
+templates:
+  dir: /opt/your-ops/infra
+  systemd: systemd/sum-site-gunicorn.service.template
+  caddy: caddy/Caddyfile.template
+
+defaults:
+  theme: theme_a
+  seed_profile: starter
+  deploy_user: deploy
+  postgres_port: 5432
+```
+
+### Site Config (`/srv/sum/<site>/.sum/config.yml`)
+
+Per-site configuration. Auto-created when you run `init`.
+
+**GitHub site:**
+```yaml
+site:
+  slug: acme
+  theme: theme_a
+  created: 2026-02-03T14:30:00Z
+
+git:
+  provider: github
+  org: acme-corp
+```
+
+**Gitea site:**
+```yaml
+site:
+  slug: acme
+  theme: theme_a
+  created: 2026-02-03T14:30:00Z
+
+git:
+  provider: gitea
+  org: clients
+  url: https://gitea.agency.com
+  ssh_port: 2222
+  token_env: GITEA_TOKEN
+```
+
+**No-git site:**
+```yaml
+site:
+  slug: acme
+  theme: theme_a
+  created: 2026-02-03T14:30:00Z
+
+git: null
+```
+
+## Git Provider Setup
+
+### GitHub
+
+Requires the GitHub CLI (`gh`) to be installed and authenticated:
+
+```bash
+gh auth login
+```
+
+### Gitea
+
+Set the API token environment variable:
+
+```bash
+export GITEA_TOKEN=your-token-here
+```
+
+Or use a custom environment variable name:
+
+```bash
+sudo sum-platform init acme --git-provider gitea --git-org clients \
+  --gitea-url https://gitea.agency.com --gitea-token-env MY_GITEA_TOKEN
+```
+
+## Development Install (monorepo)
+
+```bash
+pip install -e ./cli
+```

sum_cli-3.1.0/README.md

@@ -0,0 +1,202 @@
+# SUM CLI (v3.1)
+
+[![PyPI](https://img.shields.io/pypi/v/sum-cli.svg)](https://pypi.org/project/sum-cli/)
+
+The SUM CLI is the single control plane for deploying and managing SUM Platform client sites on staging and production servers.
+
+## Install
+
+```bash
+pip install sum-cli
+sum-platform --version
+```
+
+### With Gitea Support
+
+If using Gitea instead of GitHub for repository hosting:
+
+```bash
+pip install sum-cli[gitea]
+```
+
+## Initial Setup
+
+Before using the CLI, configure your infrastructure settings:
+
+```bash
+sudo sum-platform setup
+```
+
+This interactive command creates `/etc/sum/config.yml` with your staging/production server settings.
+
+## Commands
+
+| Command | Description | Requires Sudo |
+|---------|-------------|---------------|
+| `setup` | Configure infrastructure settings | Yes |
+| `init` | Create new site at `/srv/sum/<name>/` | Yes |
+| `update` | Pull updates, migrate, restart | No (staging) |
+| `backup` | Database and media backup | No |
+| `promote` | Deploy staging site to production | No |
+| `check` | Validate project setup | No |
+| `themes` | List available themes | No |
+
+## Creating Sites
+
+### With GitHub
+
+```bash
+sudo sum-platform init acme --git-provider github --git-org acme-corp
+```
+
+### With Gitea
+
+```bash
+sudo sum-platform init acme --git-provider gitea --git-org clients \
+  --gitea-url https://gitea.agency.com
+```
+
+### With Gitea (Custom SSH Port)
+
+```bash
+sudo sum-platform init acme --git-provider gitea --git-org clients \
+  --gitea-url https://gitea.agency.com --gitea-ssh-port 2222
+```
+
+### Without Git
+
+```bash
+sudo sum-platform init acme --no-git
+```
+
+### Additional Init Options
+
+```bash
+sudo sum-platform init acme --git-provider github --git-org acme-corp \
+  --theme theme_a \
+  --profile sage-stone \
+  --content-path /path/to/custom/content
+```
+
+## Managing Sites
+
+```bash
+# Update a deployed site (pull, migrate, restart)
+sum-platform update acme
+
+# Backup database and media
+sum-platform backup acme --include-media
+
+# Promote staging to production
+sum-platform promote acme --domain acme.example.com
+
+# Validate project setup
+sum-platform check acme
+
+# List available themes
+sum-platform themes
+```
+
+## Configuration
+
+### Global Config (`/etc/sum/config.yml`)
+
+Infrastructure settings only. Created via `sum-platform setup`.
+
+```yaml
+agency:
+  name: Your Agency Name
+
+staging:
+  server: staging.example.com
+  domain_pattern: "{slug}.staging.example.com"
+  base_dir: /srv/sum
+
+production:
+  server: prod.example.com
+  ssh_host: 10.0.0.1
+  base_dir: /srv/sum
+
+templates:
+  dir: /opt/your-ops/infra
+  systemd: systemd/sum-site-gunicorn.service.template
+  caddy: caddy/Caddyfile.template
+
+defaults:
+  theme: theme_a
+  seed_profile: starter
+  deploy_user: deploy
+  postgres_port: 5432
+```
+
+### Site Config (`/srv/sum/<site>/.sum/config.yml`)
+
+Per-site configuration. Auto-created when you run `init`.
+
+**GitHub site:**
+```yaml
+site:
+  slug: acme
+  theme: theme_a
+  created: 2026-02-03T14:30:00Z
+
+git:
+  provider: github
+  org: acme-corp
+```
+
+**Gitea site:**
+```yaml
+site:
+  slug: acme
+  theme: theme_a
+  created: 2026-02-03T14:30:00Z
+
+git:
+  provider: gitea
+  org: clients
+  url: https://gitea.agency.com
+  ssh_port: 2222
+  token_env: GITEA_TOKEN
+```
+
+**No-git site:**
+```yaml
+site:
+  slug: acme
+  theme: theme_a
+  created: 2026-02-03T14:30:00Z
+
+git: null
+```
+
+## Git Provider Setup
+
+### GitHub
+
+Requires the GitHub CLI (`gh`) to be installed and authenticated:
+
+```bash
+gh auth login
+```
+
+### Gitea
+
+Set the API token environment variable:
+
+```bash
+export GITEA_TOKEN=your-token-here
+```
+
+Or use a custom environment variable name:
+
+```bash
+sudo sum-platform init acme --git-provider gitea --git-org clients \
+  --gitea-url https://gitea.agency.com --gitea-token-env MY_GITEA_TOKEN
+```
+
+## Development Install (monorepo)
+
+```bash
+pip install -e ./cli
+```

{sum_cli-3.0.0 → sum_cli-3.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sum-cli"
-version = "3.0.0"
+version = "3.1.0"
 description = "SUM Platform CLI: single control plane for site lifecycle management"
 readme = "README.md"
 requires-python = ">=3.12"

{sum_cli-3.0.0 → sum_cli-3.1.0}/sum/cli.py

@@ -9,7 +9,7 @@ from sum.commands.backup import backup
 from sum.commands.check import check
 from sum.commands.init import init
 from sum.commands.promote import promote
-from sum.commands.run import run
+from sum.commands.setup import setup
 from sum.commands.themes import themes
 from sum.commands.update import update
 
@@ -26,14 +26,14 @@ def _get_version() -> str:
     version=_get_version(), prog_name="sum-platform", message="%(prog)s %(version)s"
 )
 def cli() -> None:
-    """SUM Platform CLI (v2)."""
+    """SUM Platform CLI - Deploy and manage client sites."""
 
 
 cli.add_command(backup)
 cli.add_command(check)
 cli.add_command(init)
 cli.add_command(promote)
-cli.add_command(run)
+cli.add_command(setup)
 cli.add_command(themes)
 cli.add_command(update)
 

{sum_cli-3.0.0 → sum_cli-3.1.0}/sum/commands/__init__.py

@@ -4,7 +4,7 @@ from __future__ import annotations
 
 from sum.commands.check import check
 from sum.commands.init import init
-from sum.commands.run import run
+from sum.commands.setup import setup
 from sum.commands.themes import themes
 
-__all__ = ["check", "init", "run", "themes"]
+__all__ = ["check", "init", "setup", "themes"]

{sum_cli-3.0.0 → sum_cli-3.1.0}/sum/commands/init.py

@@ -7,7 +7,7 @@ Creates a working site on staging at /srv/sum/<name>/ with:
 - External venv
 - Systemd service
 - Caddy configuration
-- Git repository (optional)
+- Git repository (optional, specify provider with --git-provider)
 """
 
 from __future__ import annotations
@@ -17,6 +17,7 @@ from types import ModuleType
 from sum.exceptions import SetupError
 from sum.setup.infrastructure import check_infrastructure
 from sum.setup.site_orchestrator import SiteOrchestrator, SiteSetupConfig
+from sum.site_config import GitConfig
 from sum.system_config import ConfigurationError, get_system_config
 from sum.utils.output import OutputFormatter
 from sum.utils.project import validate_project_name
@@ -37,6 +38,11 @@ def run_init(
     profile: str = "starter",
     content_path: str | None = None,
     no_git: bool = False,
+    git_provider: str | None = None,
+    git_org: str | None = None,
+    gitea_url: str | None = None,
+    gitea_ssh_port: int = 22,
+    gitea_token_env: str = "GITEA_TOKEN",
     skip_systemd: bool = False,
     skip_caddy: bool = False,
     superuser_username: str = "admin",
@@ -51,7 +57,12 @@ def run_init(
         theme: Theme slug to use.
         profile: Content profile name to seed.
         content_path: Optional path to custom content directory.
-        no_git: Skip GitHub repository creation.
+        no_git: Skip git repository creation.
+        git_provider: Git provider ("github" or "gitea").
+        git_org: Git organization/namespace.
+        gitea_url: Gitea instance URL (required if git_provider=gitea).
+        gitea_ssh_port: SSH port for Gitea.
+        gitea_token_env: Env var name for Gitea API token.
         skip_systemd: Skip systemd service installation.
         skip_caddy: Skip Caddy configuration.
         superuser_username: Username for Django superuser.
@@ -96,11 +107,32 @@ def run_init(
         OutputFormatter.error(f"Site already exists at {site_dir}")
         return 1
 
-    # Warn about GitHub if gh CLI not available and --no-git not set
-    if not no_git and not infra.has_gh_cli:
-        OutputFormatter.warning(
-            "GitHub CLI (gh) not available. Repository creation will be skipped.\n"
-            "To enable: install gh CLI and run 'gh auth login'"
+    # Build git config from flags
+    git_config: GitConfig | None = None
+    if not no_git:
+        # Validate required git flags
+        if not git_provider:
+            OutputFormatter.error(
+                "Git provider required. Use --git-provider github or --git-provider gitea.\n"
+                "Or use --no-git to skip git setup."
+            )
+            return 1
+        if not git_org:
+            OutputFormatter.error(
+                "Git organization required. Use --git-org <org>.\n"
+                "Or use --no-git to skip git setup."
+            )
+            return 1
+        if git_provider == "gitea" and not gitea_url:
+            OutputFormatter.error("Gitea URL required. Use --gitea-url <url>.")
+            return 1
+
+        git_config = GitConfig(
+            provider=git_provider,
+            org=git_org,
+            url=gitea_url,
+            ssh_port=gitea_ssh_port,
+            token_env=gitea_token_env,
         )
 
     # Build setup config
@@ -110,9 +142,9 @@ def run_init(
         seed_profile=profile,
         content_path=content_path,
         superuser_username=superuser_username,
-        skip_git=no_git,
         skip_systemd=skip_systemd,
         skip_caddy=skip_caddy,
+        git_config=git_config,
     )
 
     # Run setup
@@ -153,6 +185,11 @@ def _init_command(
     profile: str,
     content_path: str | None,
     no_git: bool,
+    git_provider: str | None,
+    git_org: str | None,
+    gitea_url: str | None,
+    gitea_ssh_port: int,
+    gitea_token_env: str,
     skip_systemd: bool,
     skip_caddy: bool,
     superuser_username: str,
@@ -164,6 +201,11 @@ def _init_command(
         profile=profile,
         content_path=content_path,
         no_git=no_git,
+        git_provider=git_provider,
+        git_org=git_org,
+        gitea_url=gitea_url,
+        gitea_ssh_port=gitea_ssh_port,
+        gitea_token_env=gitea_token_env,
         skip_systemd=skip_systemd,
         skip_caddy=skip_caddy,
         superuser_username=superuser_username,
@@ -202,7 +244,36 @@ else:
     @click.option(
         "--no-git",
         is_flag=True,
-        help="Skip GitHub repository creation (git init only).",
+        help="Skip git repository creation (local git init only).",
+    )
+    @click.option(
+        "--git-provider",
+        type=click.Choice(["github", "gitea"]),
+        default=None,
+        help="Git provider: github or gitea. Required unless --no-git.",
+    )
+    @click.option(
+        "--git-org",
+        default=None,
+        help="Git organization/namespace. Required unless --no-git.",
+    )
+    @click.option(
+        "--gitea-url",
+        default=None,
+        help="Gitea instance URL. Required if --git-provider=gitea.",
+    )
+    @click.option(
+        "--gitea-ssh-port",
+        type=int,
+        default=22,
+        show_default=True,
+        help="SSH port for Gitea.",
+    )
+    @click.option(
+        "--gitea-token-env",
+        default="GITEA_TOKEN",
+        show_default=True,
+        help="Environment variable for Gitea API token.",
     )
     @click.option(
         "--skip-systemd",
@@ -227,6 +298,11 @@ else:
         profile: str,
         content_path: str | None,
         no_git: bool,
+        git_provider: str | None,
+        git_org: str | None,
+        gitea_url: str | None,
+        gitea_ssh_port: int,
+        gitea_token_env: str,
         skip_systemd: bool,
         skip_caddy: bool,
         superuser_username: str,
@@ -241,15 +317,16 @@ else:
         - External virtualenv
         - Systemd service
         - Caddy reverse proxy
-        - GitHub repository (optional)
-
-        The site will be accessible at https://<SITE_NAME>.lintel.site
+        - Git repository (optional, specify provider with --git-provider)
 
         \b
         Examples:
-          sudo sum-platform init acme
-          sudo sum-platform init acme --theme theme_b
-          sudo sum-platform init acme --content-path /path/to/profiles/acme
+          sudo sum-platform init acme --no-git
+          sudo sum-platform init acme --git-provider github --git-org acme-corp
+          sudo sum-platform init acme --git-provider gitea --git-org clients \\
+              --gitea-url https://git.agency.com
+          sudo sum-platform init acme --git-provider gitea --git-org clients \\
+              --gitea-url https://git.agency.com --gitea-ssh-port 2222
         """
         _init_command(
             site_name,
@@ -257,6 +334,11 @@ else:
             profile=profile,
             content_path=content_path,
             no_git=no_git,
+            git_provider=git_provider,
+            git_org=git_org,
+            gitea_url=gitea_url,
+            gitea_ssh_port=gitea_ssh_port,
+            gitea_token_env=gitea_token_env,
             skip_systemd=skip_systemd,
             skip_caddy=skip_caddy,
             superuser_username=superuser_username,