shipit-deploy 0.2.0__py3-none-any.whl

shipit_deploy-0.2.0.dist-info/METADATA

@@ -0,0 +1,174 @@
+Metadata-Version: 2.4
+Name: shipit-deploy
+Version: 0.2.0
+Summary: Self-hosted, language-agnostic auto deploy: git push -> build -> health check -> rollback
+License: MIT
+Project-URL: Homepage, https://github.com/desnarong/shipit
+Project-URL: Issues, https://github.com/desnarong/shipit/issues
+Project-URL: Changelog, https://github.com/desnarong/shipit/blob/main/CHANGELOG.md
+Keywords: deploy,auto-deploy,docker,ci-cd,self-hosted,webhook,devops
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: System :: Software Distribution
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# 🚢 shipit
+
+[![CI](https://github.com/desnarong/shipit/actions/workflows/ci.yml/badge.svg)](https://github.com/desnarong/shipit/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/shipit-deploy)](https://pypi.org/project/shipit-deploy/)
+[![License: MIT](https://img.shields.io/badge/license-MIT-green.svg)](LICENSE)
+
+Self-hosted, open-source auto deploy that works with **any language**.
+`git push` → webhook → clone → build (Docker) → run → health check → **auto rollback** on failure.
+
+- Zero dependencies (Python 3.11+ stdlib only) + Docker + git
+- Auto-detects Node, Python, Go, Rust, Java (Maven/Gradle), PHP, Ruby, .NET, Elixir, static sites
+- Python start command is inferred for Django (gunicorn), FastAPI (uvicorn) and Flask (gunicorn)
+- **Any other language:** put a `Dockerfile` in your repo – it always takes priority
+- GitHub / Gitea / Forgejo (HMAC) and GitLab (token) webhooks
+- Private repos via token from an env var (never written to disk)
+- **Safe deploys:** the new version starts beside the live one and must pass its health check *before* the swap; a bad release never touches production
+- Automatic rollback if it fails right after the swap, or manually with `shipit rollback <app>`
+- Slack / Discord / Mattermost notifications, deploy history, automatic pruning of old images
+- `shipit status <app>` and `shipit logs <app> -f`
+
+## Install on a Linux server (one command)
+
+```bash
+curl -fsSL https://raw.githubusercontent.com/desnarong/shipit/main/install.sh | sudo bash
+```
+
+Installs git, Python and Docker if missing, puts shipit in `/opt/shipit`, creates a `shipit` user and a
+systemd service that listens for webhooks on port 9000. Read the script first if you like - it is short.
+Options: `--dry-run`, `--no-docker`, `--no-service`, `--from-git`.
+
+Then deploy and enable auto deploy:
+
+```bash
+sudo -u shipit SHIPIT_CONFIG=/var/lib/shipit/shipit.toml shipit up https://github.com/you/your-app.git
+shipit hook your-app --url http://YOUR-SERVER-IP:9000      # registers the GitHub webhook for you (needs `gh`)
+```
+
+## Quick start (any machine with Docker)
+
+```bash
+pip install shipit-deploy          # the command is `shipit`
+# or the latest from GitHub: pip install git+https://github.com/desnarong/shipit.git
+shipit up https://github.com/you/your-app.git
+```
+
+That's it. `shipit up` picks the default branch, a free port and the right Dockerfile (or writes one),
+builds, starts the app, health-checks it and prints the URL. No config file to write -
+it creates `shipit.toml` for you. Add `--domain app.example.com` for HTTPS + zero-downtime releases (needs Caddy).
+
+**Turn on auto deploy** (every push redeploys): run `shipit serve`, then register the webhook:
+`shipit hook myapp --url http://YOUR-SERVER:9000` (GitHub, uses the `gh` CLI), or add the URL and secret
+that `shipit up` printed to your repo by hand (Settings -> Webhooks). Apps added with `shipit up`
+are picked up by a running `shipit serve` automatically - no restart.
+
+Other commands:
+
+```bash
+shipit list                  # apps, status, URLs
+shipit hook myapp --url URL  # register the GitHub push webhook
+shipit deploy myapp          # redeploy now
+shipit rollback myapp        # back to the previous release
+shipit logs myapp -f         # follow logs
+shipit status myapp          # current release + history
+shipit doctor                # check docker / git / caddy / secrets
+shipit detect ./my-project   # preview the generated Dockerfile
+```
+
+The webhook secret is generated for you (kept in `.shipit/webhook-secret`); set `SHIPIT_SECRET` to use your own.
+If your Dockerfile has a single `EXPOSE`, shipit uses that port automatically.
+
+Add a webhook in your repo: URL `http://your-server:9000/hook/myapp`, content type
+`application/json`, secret = `SHIPIT_SECRET` (GitLab: put it in "Secret token").
+Only pushes to the configured `branch` deploy.
+
+## Config (`shipit.toml`)
+
+| key | meaning |
+|---|---|
+| `name` | app name (`a-z 0-9 _ . -`), also the container name |
+| `repo`, `branch` | git source |
+| `port` / `host_port` | container port / published port |
+| `health_path` | HTTP path polled after start (`""` = only check it stays running) |
+| `start` | start command for generated Dockerfiles |
+| `dockerfile` | custom Dockerfile path inside the repo |
+| `pre_deploy` | command run once in the new image before release (e.g. `python manage.py migrate`); failure aborts and the live version stays |
+| `env_file` | host env file passed to the container |
+| `token_env` | env var holding a git token (private https repos) |
+| `secret_env` | env var with this app's webhook secret |
+| `notify_env` | env var holding a Slack/Discord/Mattermost webhook URL |
+| `keep_images` | old images to keep (default 5; current + previous always kept) |
+| `build_args` | table of Docker build args |
+
+## Zero-downtime with Caddy
+
+Set `domain` on an app and shipit switches to **blue/green** deploys behind [Caddy](https://caddyserver.com):
+
+```toml
+[server]
+caddy_admin = "http://127.0.0.1:2019"   # default
+
+[[app]]
+name = "myapp"
+domain = "app.example.com"   # DNS must point at this server
+host_port = 9000             # slots use 127.0.0.1:9000 (blue) and :9001 (green)
+```
+
+A release starts the idle slot, waits for its health check, flips the Caddy route, waits
+`drain_seconds`, then removes the old slot - no gap, and HTTPS certificates come from Caddy automatically.
+If the health check or the Caddy update fails, the live version is untouched.
+
+Requirements: Caddy running with its admin API enabled (the default). **shipit owns the Caddy config** -
+it pushes a full config on every release and on `shipit serve` start, so don't hand-edit that Caddy instance.
+Apps without `domain` keep the simple mode (brief swap gap).
+
+## Run it as a service (systemd)
+
+```ini
+[Service]
+Environment=SHIPIT_SECRET=change-me
+WorkingDirectory=/opt/shipit
+ExecStart=/usr/local/bin/shipit serve
+Restart=always
+```
+
+Put nginx/Caddy in front for HTTPS and for routing domains to each app's `host_port`.
+
+## Security notes
+
+- The webhook endpoint rejects anything without a valid signature/token.
+- Deploying runs `docker build` on code from your repo – only point it at repos you trust.
+- Run `shipit serve` behind HTTPS; the host running it controls Docker, so keep it locked down.
+
+## Limitations (v0.1)
+
+Single server, single container per app. Without `domain` there is a brief gap while the port is handed over.
+PRs welcome – ideas: multi-server, PR preview deploys, web UI, Traefik/nginx backends.
+
+## Develop
+
+```bash
+python -m unittest discover -s tests
+```
+
+End-to-end tests deploy real sample apps with Docker (needs Docker + git, takes a few minutes):
+
+```bash
+SHIPIT_E2E=1 python -m unittest tests.test_e2e -v
+```
+
+Contributions welcome - see [CONTRIBUTING.md](CONTRIBUTING.md). Security issues: [SECURITY.md](SECURITY.md). MIT licensed.

shipit_deploy-0.2.0.dist-info/RECORD

@@ -0,0 +1,17 @@
+shipit/__init__.py,sha256=Zn1KFblwuFHiDRdRAiRnDBRkbPttWh44jKa5zG2ov0E,22
+shipit/__main__.py,sha256=E6Gls0DNz8GQK2K-kOUIx8cYhgANW_CH54VKrfCfs14,52
+shipit/cli.py,sha256=9rUSM_m96tRauuY2tF03DzNyXpXRGi2SoEJwSsiqwXs,8211
+shipit/config.py,sha256=gSPHh2syF5VRahPKO4QttoA3DusSa_2KNVp_-rgislE,3617
+shipit/deploy.py,sha256=zaeNiN2yiNIM5FnOcb6yOYVEFtScukqqk41EJjwHnJE,14173
+shipit/detect.py,sha256=IBMc-UYlvD4xMbsPkrNDvz7aANAeTiu4YVkJwLjBaRk,7482
+shipit/doctor.py,sha256=U89z3bQnOjjEDARgWiyFoj3Ib7xvP6yNz5UigegC4Rk,2543
+shipit/easy.py,sha256=foESAEFuuhDUJlrIgX4_3WloxRvObt5Zig9PxK7bgqI,2765
+shipit/hooks.py,sha256=kHugZfSq9SSjX7cxNz5Jan7UwzO4lL1D-U6Sj01ehgE,1951
+shipit/proxy.py,sha256=cm2eDY5JzCprb1kvuGU5Xe0YUQLmtsv5UX-gH1r7ySM,1713
+shipit/webhook.py,sha256=r4vYHqrjooQ0vubnT1MSMUOoj9SVxND82EOup8vV7Qw,3558
+shipit_deploy-0.2.0.dist-info/licenses/LICENSE,sha256=kqYgct8phWcZDR_CfKNUOkD_v-nBtahn_O3X8QBy2JU,1076
+shipit_deploy-0.2.0.dist-info/METADATA,sha256=-Gqo51O9t-UyneHgum26D3GGYKch-PPChBp5aTCVzbs,7900
+shipit_deploy-0.2.0.dist-info/WHEEL,sha256=mOdXR9C3wMVov7cSY8PY-XCzo3SmmWCHvGQr5csJoao,91
+shipit_deploy-0.2.0.dist-info/entry_points.txt,sha256=NFwFn-PpVRChP5H0TO60J3pVq82DO4Pg3kjihPOrfI4,43
+shipit_deploy-0.2.0.dist-info/top_level.txt,sha256=8UZ40ChoKBbwjUOhNx8ParKw-i36Qw2ggasYwpeVafs,7
+shipit_deploy-0.2.0.dist-info/RECORD,,

shipit_deploy-0.2.0.dist-info/WHEEL

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

shipit_deploy-0.2.0.dist-info/entry_points.txt

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

shipit_deploy-0.2.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 shipit contributors
+
+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.

shipit_deploy-0.2.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+shipit