plinth-cli 0.2.0__py3-none-any.whl

plinth_cli-0.2.0.dist-info/METADATA

@@ -0,0 +1,174 @@
+Metadata-Version: 2.5
+Name: plinth-cli
+Version: 0.2.0
+Summary: Generates local, ready-to-push application and GitOps repositories from one config.
+Project-URL: Homepage, https://github.com/dfoshidero/plinth
+Project-URL: Issues, https://github.com/dfoshidero/plinth/issues
+Author: dfoshidero
+License-Expression: MIT
+License-File: LICENSE
+Keywords: argo-cd,dagger,generator,gitops,monorepo,scaffolding,score
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.12
+Requires-Dist: jinja2<4,>=3.1
+Requires-Dist: pydantic<3,>=2.11
+Requires-Dist: pyyaml<7,>=6.0
+Requires-Dist: questionary<3,>=2.1
+Description-Content-Type: text/markdown
+
+# plinth
+
+Generate ready-to-push application and GitOps repositories from one config file.
+
+plinth turns a short `plinth.yaml` into git repositories with working application code, a
+[Dagger](https://dagger.io) CI pipeline, [Score](https://score.dev) workload specs, and an
+[Argo CD](https://argo-cd.readthedocs.io) GitOps repository that deploys them. Start as a
+modular monolith, a set of microservices or a hybrid of both, in one repo or one repo per app,
+and grow later with `plinth add`.
+
+## Install
+
+```sh
+uv tool install plinth-cli      # or: pipx install plinth-cli
+plinth --version
+```
+
+The PyPI package is `plinth-cli`; the command is `plinth`. Requires Python 3.12+.
+
+## Quick start
+
+Answer a few questions:
+
+```sh
+plinth project
+```
+
+or write a config and generate from it:
+
+```yaml
+# plinth.yaml
+project:
+  name: atlas
+  architecture: hybrid          # modular-monolith | microservices | hybrid
+  layout: monorepo              # monorepo | split-repo
+  gitProvider: github           # github | gitlab | generic
+  gitBaseUrl: https://github.com/acme
+  registry: ghcr.io/acme
+applications:
+  - {name: api, kind: modular-monolith}
+  - {name: worker, kind: worker}
+  - {name: notifier, kind: service, port: 8081}
+environments: [dev, production]
+```
+
+```sh
+plinth validate --config plinth.yaml
+plinth generate --config plinth.yaml --output .
+```
+
+This writes `./atlas/` containing one folder per repository, each initialised with git, an
+initial commit and an `origin` remote under `gitBaseUrl`. Create the empty repositories on your
+git host and push.
+
+More configs live in [`examples/`](examples/): every architecture with both layouts.
+
+## What you get
+
+**Application repositories** (one for a monorepo, one per app for split-repo):
+
+- a small, dependency-free Python app per workload with a `/health` endpoint (services and the
+  monolith) or a run loop (workers), plus tests; replace it with your own code
+- a `Dockerfile` and a `score.yaml` describing how the workload runs
+- a Dagger module (`.dagger/`) with `test`, `build` and `ship` functions that run identically on
+  your laptop and in CI
+- a CI file for your provider (`.github/workflows/ci.yaml` or `.gitlab-ci.yml`) that tests pull
+  requests and ships `main`
+
+**A GitOps repository:**
+
+- an Argo CD app-of-apps (`bootstrap/root.yaml`) and one ApplicationSet per environment
+- a Helm chart that deploys any workload straight from its `score.yaml`
+- per-environment values, and `release.yaml` files written by CI on every ship
+- `scripts/bootstrap-local.sh` to run everything on a local [k3d](https://k3d.io) cluster
+
+The flow: push to `main` → CI tests, builds and pushes images tagged with the commit → CI writes
+`environments/dev/<workload>/release.yaml` → Argo CD deploys it. Promote by copying a
+`release.yaml` to another environment.
+
+## Grow a project
+
+Add a service or worker to a generated project:
+
+```sh
+cd atlas
+plinth add service billing --port 8090
+plinth add worker mailer
+```
+
+plinth creates the new workload's files (and a new repository for split-repo layouts) and
+updates `plinth.yaml`. Adding to a modular monolith turns it into a hybrid. Existing files are
+never overwritten; any that plinth would now generate differently are listed for you to review.
+
+## Commands
+
+| Command | What it does |
+|---|---|
+| `plinth project [--output DIR]` | interactive questions, then generate |
+| `plinth validate --config FILE` | check a config and show the repositories it produces |
+| `plinth generate --config FILE --output DIR [--dry-run]` | write the repositories |
+| `plinth add {service,worker} NAME [--port N]` | add a workload to an existing project |
+
+`--no-git` skips `git init` and the initial commit.
+
+## Configuration
+
+| Key | Notes |
+|---|---|
+| `project.name` | kebab-case, 2-30 chars; prefixes every repository name |
+| `project.architecture` | `modular-monolith` (one monolith), `microservices` (services/workers only), `hybrid` (one monolith plus services/workers) |
+| `project.layout` | `monorepo` (`<name>-app` holds every workload) or `split-repo` (`<name>-<app>` each) |
+| `project.gitProvider` | picks the CI file; `generic` generates none |
+| `project.gitBaseUrl` | `https://host/org` the repositories live under |
+| `project.registry` | `host/path` images are pushed to |
+| `applications[]` | `name`, `kind` (`modular-monolith`, `service`, `worker`), optional `port` for HTTP kinds |
+| `environments` | must include `dev`, which CI releases to |
+
+Defaults and pinned tool versions are in [`plinth/config.py`](plinth/config.py).
+
+## When not to use plinth
+
+- You only need a single repository from a template: [Copier](https://copier.readthedocs.io)
+  or [Cookiecutter](https://cookiecutter.readthedocs.io) are simpler, and Copier can update
+  projects later.
+- You already run [Backstage](https://backstage.io): its software templates fit better there.
+- You don't deploy to Kubernetes: the GitOps half won't help you.
+
+plinth generates once. It does not keep generated repositories in sync with newer templates;
+after generation the code is yours.
+
+## Development
+
+```sh
+uv sync
+uv run pytest
+uv run ruff check . && uv run ruff format --check .
+```
+
+Templates live in [`plinth/blueprints/`](plinth/blueprints/). Files ending in `.j2` are rendered
+with Jinja; path segments starting with `dot-` are written with a leading `.`.
+
+## Contributing
+
+Contributions are welcome. Read [CONTRIBUTING.md](CONTRIBUTING.md) first; in short, open an
+issue before large changes, and every contribution must be written by a human (no AI-generated
+code or text).
+
+## License
+
+[MIT](LICENSE)

plinth_cli-0.2.0.dist-info/RECORD

@@ -0,0 +1,49 @@
+plinth/__init__.py,sha256=iiHE7PbslX3kD7ibzZV-v1aezICaREHHEAAjHGJ3hbU,90
+plinth/__main__.py,sha256=D7dIGZPVzn2TH_VoNBsy3b56IRUatGw-7PtfjeIPUp4,58
+plinth/add.py,sha256=duBHMBM_VhTeRZrY5PQwFGXP0szNzxknqoPjr66S-iU,3545
+plinth/cli.py,sha256=zi5Ql8RcQm_Hj4waMv4extXIzuj-v2pwmp9RcufOsR8,6925
+plinth/config.py,sha256=-t04CW6EQ5JtgzONnOOwZ6bh0Sv8GNO5HYMKs61iG1I,1491
+plinth/loader.py,sha256=UyKn7AMHO1GaRx9fqCutQrNVze9464tT1vVCjkWGnco,1559
+plinth/plan.py,sha256=lIE0kICx0N49ZhU0G8XG2nUW0AIt200pTvcssqSsPVI,2027
+plinth/render.py,sha256=iopOLw2VyBMOw1UNkdg8P_hoIDN7utqBFCKHaO0rNvQ,4204
+plinth/schema.py,sha256=EtMpvMn4nX2lU_jLdgYa25aHnRrOYe-oVso9P0FSwXU,5224
+plinth/wizard.py,sha256=Jpf4hRNxRqNBOEDinF0aGOjiJ7Go5Lgtr85L181CviY,4448
+plinth/write.py,sha256=_7r91v2SYKEBEACbOozARHe5LuQyoDEud7DkdfDO8N0,2491
+plinth/blueprints/ci/github/dot-github/workflows/ci.yaml.j2,sha256=DQBQ2IAHaiKEm_FUXFyCYlBUQgg1aobrhBYphQdLwQQ,1018
+plinth/blueprints/ci/gitlab/dot-gitlab-ci.yml.j2,sha256=Yws8cLG53g7zzklJQwqrrGivUChcXg0TUm43aQqpylI,884
+plinth/blueprints/gitops/applicationset.yaml.j2,sha256=9PN6iVhmmvoKEJnlXcKaUKsKzPQRYjhvGpl2x4BT4bc,1499
+plinth/blueprints/gitops/values.yaml.j2,sha256=aDjDjBxvmVqYHCqJ24aPGWIY8mVs654cvpl_nOzkSEo,161
+plinth/blueprints/repo/app/README.md.j2,sha256=wzGqIFHkooKpOssl05jHTkjUJ27oGGa752cqJRE0RZs,2486
+plinth/blueprints/repo/app/dagger.json.j2,sha256=YCZ3d0TFAXUjVaWM_H3JZP1hr0n-7dGs01vnn6KYbC0,134
+plinth/blueprints/repo/app/dot-gitignore,sha256=H6qnYh1ykCi1BwwMd-IDyj-JmOO1JfSIaOJc5XppJUo,31
+plinth/blueprints/repo/app/dot-dagger/dot-gitignore,sha256=wXhhUha0HQGaPV3m1nXQm4wzYGDEKn6YOQp9232M82o,25
+plinth/blueprints/repo/app/dot-dagger/pyproject.toml,sha256=bEGusglaeV6zaCtzOYZTw7avWQMgys5CDJNV4D8KZns,252
+plinth/blueprints/repo/app/dot-dagger/src/ci/__init__.py,sha256=MjyrYvJYRimlNAA8yi_M80i52upZhKoIou48lfyDa9s,112
+plinth/blueprints/repo/app/dot-dagger/src/ci/main.py.j2,sha256=uiREhlY452UC_Ks0ICr3WH7A3KHsvIqTATLx-ow2wDc,4963
+plinth/blueprints/repo/gitops/README.md.j2,sha256=TJfjKeMX2FbzFGNkp8lLXV5ffYkboQl8IoIQMgnqwrc,2172
+plinth/blueprints/repo/gitops/apps/project.yaml.j2,sha256=eskRk938bPTm6PobzLCtR79kidu3_8nbuAIaAfHlCcs,399
+plinth/blueprints/repo/gitops/bootstrap/root.yaml.j2,sha256=orYQYnfO14hT6evrSKsxvY3f2nmDknjYiJ-gup_DFHE,473
+plinth/blueprints/repo/gitops/charts/workload/Chart.yaml,sha256=23nVJBheVJrV03WWJochhtXFSmRoOsULlktsMZtU3Tw,141
+plinth/blueprints/repo/gitops/charts/workload/values.yaml,sha256=D8vBb12jVIFnO37QE57GSpBc2bLrmylGPVSWtxdFfho,453
+plinth/blueprints/repo/gitops/charts/workload/templates/_helpers.tpl,sha256=MsLlo5FE4xZMfl4NQ8VP84zdjtOrvWj27Qo2jQsxsJ0,456
+plinth/blueprints/repo/gitops/charts/workload/templates/deployment.yaml,sha256=5nDO-mYW28-sbUc6i5n_O5eLLtbyVHBswTKcXTnUmRw,1917
+plinth/blueprints/repo/gitops/charts/workload/templates/service.yaml,sha256=_zfW1c0gIJs9dkJW4o0MGmDTZA08RIUwQ_-rrRmsf8U,507
+plinth/blueprints/repo/gitops/scripts/bootstrap-local.sh.j2,sha256=VV7YLjk37u4crpAqMlpoFBE459unfKZy1D29-wUXJFE,1060
+plinth/blueprints/workload/common/Dockerfile.j2,sha256=BuPwFdA0-cnZSOoX8tKjllssZph-OKllk3R1WFhe5FE,341
+plinth/blueprints/workload/common/dot-dockerignore,sha256=2UIakcAtmPm6h0UnkT3YQs-b0wmKD_t26JLS4nAgUb4,37
+plinth/blueprints/workload/common/score.yaml.j2,sha256=qzyQj-pBABUlbflz--lmv3tYqo_R9bAB0h4M449FJQE,843
+plinth/blueprints/workload/common/app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plinth/blueprints/workload/common/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+plinth/blueprints/workload/modular-monolith/app/main.py.j2,sha256=fYl6jTL-GSvU6ecIZw_BUbPPrQHVLmKi1sxVfIMdXD4,2010
+plinth/blueprints/workload/modular-monolith/app/modules/__init__.py,sha256=gZ9cK3rfa0IxxKgbW34PPmXt3cQvPdkTN2Vs797DF7g,132
+plinth/blueprints/workload/modular-monolith/app/modules/example.py,sha256=_sEOQsGEJytAzqDm39RhgqcQy0GV23AkXMZVF_hFaxs,384
+plinth/blueprints/workload/modular-monolith/tests/test_main.py.j2,sha256=Oc6sQkmXVPCV6XTYJA4S846zmcz-UZvFduK3z-HyVJ4,1252
+plinth/blueprints/workload/service/app/main.py.j2,sha256=ccnnzku84w2YS-4LmCwNJkitCeZHckIHLFx4yLESdxA,1716
+plinth/blueprints/workload/service/tests/test_main.py.j2,sha256=uBB813XETVMXxwHTuyy8_RKYKGlND10jMRqb0vsySbQ,1254
+plinth/blueprints/workload/worker/app/main.py.j2,sha256=TlpxZj85uQMeKM2dgs59eLPyu2tI4taKij0TOgDzJMw,1220
+plinth/blueprints/workload/worker/tests/test_main.py.j2,sha256=Rya7k0e8_GC37SeR29RDGjJs-2RFp2fXr2Aq7CfUznc,645
+plinth_cli-0.2.0.dist-info/METADATA,sha256=dhAQVhtLnK2jF6LSAS01vFxMQlisMQ0g2GDzcC7cMt4,6517
+plinth_cli-0.2.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+plinth_cli-0.2.0.dist-info/entry_points.txt,sha256=swe0Vm7verOMY4Y6X5npNfUE24IKeIn4IQoGWbYGsNw,43
+plinth_cli-0.2.0.dist-info/licenses/LICENSE,sha256=TcNxerWiq9IH4n-FDxwo4GpbpZQE8eW9k4A-nj0fDnQ,1067
+plinth_cli-0.2.0.dist-info/RECORD,,

plinth_cli-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.32.4
+Root-Is-Purelib: true
+Tag: py3-none-any

plinth_cli-0.2.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+plinth = plinth.cli:main

plinth_cli-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 dfoshidero
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.