sum-cli 3.0.0__py3-none-any.whl

sum_cli-3.0.0.dist-info/METADATA

@@ -0,0 +1,127 @@
+Metadata-Version: 2.4
+Name: sum-cli
+Version: 3.0.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)
+
+[![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.
+
+## 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]
+```
+
+## Quick Usage
+
+```bash
+# Create a new production site (requires sudo)
+sudo sum-platform init acme --theme theme_a
+
+# Create site with custom content profile
+sudo sum-platform init acme --content-path /path/to/profiles/acme
+
+# Update a deployed site
+sum-platform update acme
+
+# Backup a site
+sum-platform backup acme --include-media
+
+# Promote staging to production
+sum-platform promote acme --domain acme.example.com
+
+# List available themes
+sum-platform themes
+
+# Validate a project setup
+sum-platform check acme
+```
+
+## Commands
+
+| Command | Description | Requires Sudo |
+|---------|-------------|---------------|
+| `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 |
+| `run` | Start development server | No |
+
+## Git Provider Support
+
+The CLI supports both GitHub and Gitea for repository hosting. Configure your provider in `/etc/sum/config.yml`:
+
+**GitHub (default):**
+```yaml
+agency:
+  name: "Your Agency"
+  git_provider: "github"
+  github_org: "your-org"
+```
+
+**Gitea:**
+```yaml
+agency:
+  name: "Your Agency"
+  git_provider: "gitea"
+  gitea_url: "https://gitea.example.com"
+  gitea_org: "your-org"
+  gitea_token_env: "GITEA_TOKEN"
+```
+
+For Gitea, set the `GITEA_TOKEN` environment variable with your API token.
+
+## Development Install (monorepo)
+
+```bash
+pip install -e ./cli
+```
+
+## Configuration
+
+System-wide configuration is read from `/etc/sum/config.yml`. See `config.yml.example` for the full schema.
+
+## Documentation
+
+The full User Guide is bundled with the package at `sum/docs/USER_GUIDE.md`.
+
+For monorepo development:
+- [User Guide](../docs/dev/cli/USER_GUIDE.md) - Full command reference
+- [Developer Guide](../docs/dev/cli/DEVELOPER_GUIDE.md) - CLI architecture and contribution guide

sum_cli-3.0.0.dist-info/RECORD

@@ -0,0 +1,72 @@
+sum/__init__.py,sha256=4Hqvsw_wQrS-HCr8d7k9lsTk-whfS-XuLIja6cwe_K8,27
+sum/cli.py,sha256=NxUiTZMlsfMonKBTXDvZJUISiZ1kZLzBuR_tAoLTc6c,952
+sum/config.py,sha256=LucWpecznyXfYGKFfMzlYc_YGgQz6YYgEYss1ohqtU0,1500
+sum/exceptions.py,sha256=bcTxqy_MXysc3-_CtLITuA0mea3PJv2gSmm6Opdx038,1172
+sum/system_config.py,sha256=9e7qRqqG5qnj-fM7lgiHl4hJ7Rx5ZCCQ5XKFg22l_gM,10358
+sum/themes_registry.py,sha256=86SJjNHne2t24G5x3FQglL2toqo06-WBGujV598d4w4,5565
+sum/boilerplate/.env.example,sha256=Y3GajiSPEQA3_uCFxzUwWwJEataGgZRySktb6UgaQD8,5038
+sum/boilerplate/.gitignore,sha256=ko-akHlkIhaS9vqz78zAlwMfp0W5z1TE52dBmoFdSu8,397
+sum/boilerplate/README.md,sha256=bV33H8y7NeGW8u5BUZx5echN2smt-vYEx5Wr08tzoHQ,7731
+sum/boilerplate/manage.py,sha256=jmp-DtusWuROFtXeC9GlU5OJ8itLm-8CW0Fl2ACMs7I,893
+sum/boilerplate/pytest.ini,sha256=-aNCtGoDziBDjv6zNuIug17PXU3M8kg-xK2FE3oVKEo,137
+sum/boilerplate/requirements.txt,sha256=qozrD_4T7wB-XohEMhFkGzk71hoCE4kFMh8TBzRhJoI,710
+sum/boilerplate/.gitea/workflows/ci.yml,sha256=S_2_Wa3dXqSSlzcfqYRQyFn52vllFICWbZb8ce8d7_E,646
+sum/boilerplate/.gitea/workflows/deploy-production.yml,sha256=lzYgVUzrIXpjVrihuZYRZchGiFzcAnSUzDG5xt99HTw,3205
+sum/boilerplate/.gitea/workflows/deploy-staging.yml,sha256=lgGeDJ4PRI9Qfm1-tkpia5dwSLSYwtQi-UCLcmoawnk,3568
+sum/boilerplate/.github/workflows/ci.yml,sha256=VcjZXSCtoIX7s3xhOI4mfYcAbt57sLz8bHBztBTVab8,677
+sum/boilerplate/.github/workflows/deploy-production.yml,sha256=j7Ru54sLLTKMT5QWK97RyeoBzgd3zIBnLbVRvgDRJ2A,3319
+sum/boilerplate/.github/workflows/deploy-staging.yml,sha256=F2nLzA1kTAgxpJynEKJJ7g1XzKeOMemGwrryUXHvT6Y,3590
+sum/boilerplate/project_name/__init__.py,sha256=Hd058US4IapMQiTrHSE6QNJUQxiFeyuksKbxkGZu2n8,115
+sum/boilerplate/project_name/urls.py,sha256=jl2Q4Yj7K5edinKz5h0FuNcMw0PLcW_Tmat-ETAqP_Y,1139
+sum/boilerplate/project_name/wsgi.py,sha256=WrzSdpwkn20Z8OjrsbZknlf2B1G82kCS07Y3gLxY7N8,400
+sum/boilerplate/project_name/home/__init__.py,sha256=poMAs3mwFD784mzLrbCwQjoVDgaRDehd7TzhAJ733uY,102
+sum/boilerplate/project_name/home/apps.py,sha256=y_NGE1mFBJXKRS2BmgosBJ1OD9yOdJ84afYrXQecK_g,506
+sum/boilerplate/project_name/home/models.py,sha256=GJME69Qa7hADpwDWL53PzuVzDYw1Mx4MkFTj_aIUETA,421
+sum/boilerplate/project_name/home/management/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sum/boilerplate/project_name/home/management/commands/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+sum/boilerplate/project_name/home/management/commands/populate_demo_content.py,sha256=qXt_a8D8fspGxEHUoRnL6OudYVgRru7OpqzSWdfzpgI,22255
+sum/boilerplate/project_name/home/management/commands/seed.py,sha256=3WUsGlZ7avK1iSo43jAehf3tM5lIQQahNGcBp_ugY-8,4896
+sum/boilerplate/project_name/home/management/commands/seed_showroom.py,sha256=PCIQj9ZAs_1nDVeXETLRn52vdkqzcAsb99trcdREY7Y,63499
+sum/boilerplate/project_name/home/migrations/__init__.py,sha256=_mbZaHdFwLE7E8GApBDIGSMiOz9G7RLyReN1lkrvYG0,45
+sum/boilerplate/project_name/settings/__init__.py,sha256=yndELLmd-OQ-wjxYUC1CitmhbzazgOw6NyaRX_E805k,149
+sum/boilerplate/project_name/settings/base.py,sha256=WU62OzS8DlsctNDpFOSOGHpJRnZzkFlT0XewHtcn3FE,12422
+sum/boilerplate/project_name/settings/local.py,sha256=b3Vd21a5adLjKEEmZWLZQFUe_UcKwMmq9YGeJSb-1Zs,2667
+sum/boilerplate/project_name/settings/production.py,sha256=e0iY5vTrIVDcjmz-c9zQwL3Zk_Ap6JkH78xzzTM1MVs,3638
+sum/boilerplate/static/client/.gitkeep,sha256=oljA0ouMsVDR4goUYUlxPrm_uxOCM7fAYof9g0wNWQQ,170
+sum/boilerplate/templates/overrides/.gitkeep,sha256=OsCO3X-nPRZHK3_hxkn8B1KZRVmwaXwUfJbHD8ywk90,174
+sum/boilerplate/tests/__init__.py,sha256=h4W89xW2hAKb5WX3DGURe7gmvJbsv2n2aG5hyYvv07A,46
+sum/boilerplate/tests/test_health.py,sha256=cSptlBMzz8ppTEW0xHSiTGKdZVCHkGI-0HUTj6U0IhA,1794
+sum/commands/__init__.py,sha256=2GDI4K46anO4InrXQwZ5iqmRM3vdhi0SUnSk9b2MQbQ,262
+sum/commands/backup.py,sha256=2_qhP5yHUSXxif0M1MgVn78dHF7T6GDlBmuw07ZtrX0,9071
+sum/commands/check.py,sha256=OQhHMtnF54ojySYeveToIAB-YvpRnAFuHQuCLZRNT-s,4332
+sum/commands/init.py,sha256=LmpfNkN9vWro2-TulLNw_UiX5tcZ1DUfaqRTXbNbMI0,7477
+sum/commands/promote.py,sha256=SCoJgSYe40qJ8CQSymUktNoXHfJXrHeH8EONE9FcNyk,25436
+sum/commands/run.py,sha256=9EwL51_GaIW7Ksy9AxKxjK7fKpJtjjBUop0gpxXHg-U,2953
+sum/commands/themes.py,sha256=DrPD0R9kig9DeyTXFPvsDL12qGhRFs_06N5g0BAPM3k,1307
+sum/commands/update.py,sha256=AXYa0BugWuYWJpj0vx5N5Ni0D0ZS_NsZeUhk3v3HwLc,9157
+sum/docs/USER_GUIDE.md,sha256=nRO1vH6SxhPnpjaUcNxRJvIDIaWWMdyEmiK91WLWVss,14698
+sum/setup/__init__.py,sha256=dm8Qq819REBxcZxOYQ6sjYOGAYdnMyZHMR8PFgMrNu0,457
+sum/setup/auth.py,sha256=kBBLZKZjt8EUgK4_UV2QFmlQ0Z2RbekCQzkSBYxMJVA,5899
+sum/setup/database.py,sha256=gsMa8aqxyfOBcJ1u13hbUPYSVMpFbP-S2gesVOK1UpE,1630
+sum/setup/deps.py,sha256=snciWZg7TtFlullkxZGs2Acjx1jzrbiG8wFy2rb4Vw8,3018
+sum/setup/git_ops.py,sha256=Kqg8DrePhRWfLFWVmvrP_8AP8LulP3ho9CRmrBvt4EM,14482
+sum/setup/infrastructure.py,sha256=lI2kI_odt4JyF6wa0uAmysozGSyDmD6X70rROcNOdJ8,18065
+sum/setup/orchestrator.py,sha256=MThyN6DvXyi-cI6icgeFJ3Plt0AXqOVQ6ECEfpP3ACM,12338
+sum/setup/remote_themes.py,sha256=xc5sY-QwaIiLsP_LqSRE57Kk1hWre1SKxflzhu7cx0c,11685
+sum/setup/scaffold.py,sha256=hp3BzypaBHIGk8zN2STHDZ37BpD283eW0MZc4XnWBsc,17360
+sum/setup/seed.py,sha256=db_5lEVfYbH51h2GuJjWS9lTjUzg88jQF-AodUS-uFQ,3086
+sum/setup/site_orchestrator.py,sha256=iRTkBYdBWJ03DjTXzO0Y6HqHACEry27LP9VR-rpsn8M,16553
+sum/setup/venv.py,sha256=YttFbI-EZY0w5TFCeAwwO-OFQ1ZviWwa5PnWXXP3Q9s,3150
+sum/utils/__init__.py,sha256=acO546Z2ktZ5TuGcPzR7xMwCFUJ7VIOjzuwh5qKqcIA,630
+sum/utils/django.py,sha256=rqQj6Bwcw_8ihm_tPx6U1AcEtp3kXOVtzfLxC2IN_Yg,3280
+sum/utils/environment.py,sha256=ek7dRYJyg0z1dHgbZCiEWh6cKxIKUeIXdoDYxn-shao,2508
+sum/utils/output.py,sha256=jeFHKX1chjJowhNH3NadlNZp8rUvRuuizdwrdDoW49c,2379
+sum/utils/project.py,sha256=27CveU5U0QhgQK_tuI6cGCN9KUskpdwv1_q8t5R_QFY,3375
+sum/utils/prompts.py,sha256=iHDMWpMOj1_xbDE0XB3qF2yw4-EDPG8YbG-uGMXRmnI,1153
+sum/utils/validation.py,sha256=15PNw1lhrRSnyH7BaN_N44qI4rXWx4i-44ps-0fylYU,11533
+sum_cli-3.0.0.dist-info/licenses/LICENSE,sha256=RSHp5Au98mOtEsT8N4WMxqxsa-AtcVQCfr3SqoffQoU,1519
+sum_cli-3.0.0.dist-info/METADATA,sha256=7gtkSOHAUzk7wjxjmcA7d0uIiN0qpOjAlswiuF31wsY,3503
+sum_cli-3.0.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+sum_cli-3.0.0.dist-info/entry_points.txt,sha256=cp92-F73mckmgEqj6RKxJ2SII7JfK26A9Kx_LLZElGc,45
+sum_cli-3.0.0.dist-info/top_level.txt,sha256=xfyDwB6SQERSuYZSfSORQMz5pIuI4MJo-_OMLhQp6ck,4
+sum_cli-3.0.0.dist-info/RECORD,,

sum_cli-3.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.2)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sum_cli-3.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+sum-platform = sum.cli:cli

sum_cli-3.0.0.dist-info/licenses/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2025, Mark Ashton
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

sum_cli-3.0.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+sum