Metadata-Version: 2.4
Name: simtabi-release-kit
Version: 0.3.0
Summary: Multi-registry publishing automation. PyPI, npm, Docker, Homebrew, Maven, RubyGems, Cargo, NuGet, Packagist, plus seven git hosts. Fluent OOP, config-driven, OIDC-first.
Project-URL: Homepage, https://opensource.simtabi.com/products/release-kit
Project-URL: Documentation, https://opensource.simtabi.com/documentation/release-kit
Project-URL: Repository, https://github.com/simtabi/release-kit
Project-URL: Issues, https://github.com/simtabi/release-kit/issues
Project-URL: Changelog, https://github.com/simtabi/release-kit/blob/main/CHANGELOG.md
Author-email: Simtabi LLC <opensource@simtabi.com>
Maintainer-email: Imani Manyara <imani@simtabi.com>
License: MIT License
        
        Copyright (c) 2026 Simtabi LLC
        
        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.
License-File: LICENSE
Keywords: automation,ci-cd,docker,github-actions,homebrew,npm,oidc,publish,pypi,release
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: System :: Software Distribution
Requires-Python: >=3.11
Requires-Dist: httpx>=0.27
Requires-Dist: keyring>=24.3
Requires-Dist: platformdirs>=4.2
Requires-Dist: pydantic>=2.7
Requires-Dist: python-dotenv>=1.0
Requires-Dist: structlog>=24.1
Requires-Dist: tomli; python_version < '3.11'
Requires-Dist: typer>=0.12
Provides-Extra: all
Requires-Dist: azure-containerregistry>=1.2; extra == 'all'
Requires-Dist: azure-identity>=1.16; extra == 'all'
Requires-Dist: boto3>=1.34; extra == 'all'
Requires-Dist: build>=1.2; extra == 'all'
Requires-Dist: google-cloud-artifactregistry>=1.13; extra == 'all'
Requires-Dist: twine>=5.0; extra == 'all'
Provides-Extra: aws
Requires-Dist: boto3>=1.34; extra == 'aws'
Provides-Extra: azure
Requires-Dist: azure-containerregistry>=1.2; extra == 'azure'
Requires-Dist: azure-identity>=1.16; extra == 'azure'
Provides-Extra: dev
Requires-Dist: jsonschema>=4.21; extra == 'dev'
Requires-Dist: mypy>=1.10; extra == 'dev'
Requires-Dist: pre-commit>=3.7; extra == 'dev'
Requires-Dist: pytest-asyncio>=0.23; extra == 'dev'
Requires-Dist: pytest-cov>=5.0; extra == 'dev'
Requires-Dist: pytest>=8.2; extra == 'dev'
Requires-Dist: respx>=0.21; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Requires-Dist: types-pyyaml; extra == 'dev'
Provides-Extra: docker
Provides-Extra: gcp
Requires-Dist: google-cloud-artifactregistry>=1.13; extra == 'gcp'
Provides-Extra: github
Provides-Extra: gitlab
Provides-Extra: twine
Requires-Dist: build>=1.2; extra == 'twine'
Requires-Dist: twine>=5.0; extra == 'twine'
Description-Content-Type: text/markdown

# simtabi-release-kit

[![CI](https://github.com/simtabi/release-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/simtabi/release-kit/actions/workflows/ci.yml)
[![PyPI](https://img.shields.io/pypi/v/simtabi-release-kit.svg)](https://pypi.org/project/simtabi-release-kit/)
[![Python](https://img.shields.io/pypi/pyversions/simtabi-release-kit.svg)](https://pypi.org/project/simtabi-release-kit/)
[![License](https://img.shields.io/github/license/simtabi/release-kit.svg)](LICENSE)

Multi-registry publishing automation. One config file, one command,
every registry your project needs.

```bash
pip install simtabi-release-kit
release-kit init
release-kit doctor            # green / amber / red per target
release-kit publish --apply   # dry-run is the default
```

## What it does

- Publishes to **package registries**: PyPI, npm (+ GitHub Packages,
  GitLab npm), Docker Hub, GHCR, GitLab Container Registry, AWS
  ECR, Google Artifact Registry, Azure Container Registry, Homebrew
  tap, Maven Central, RubyGems, crates.io, NuGet, Packagist.
- Automates **git hosts**: GitHub.com, GitHub Enterprise (Cloud +
  Server), GitLab.com, GitLab Self-Managed, Bitbucket Cloud,
  Bitbucket Data Center, Gitea / Forgejo, Azure DevOps.
- **OIDC-first**: prefers passwordless trusted publishing.
  Refuses to fall back to long-lived tokens without
  `--allow-token-auth`.
- **Dry-run by default**: nothing publishes until `--apply`.
- **Pluggable**: third parties register custom platforms via
  `[project.entry-points."release_kit.platforms"]` without
  forking.

## Quick start

```bash
# 1. Install
pip install simtabi-release-kit

# 2. Scaffold a config + .env template
release-kit init

# 3. Verify your credentials and connectivity
release-kit doctor

# 4. Dry-run a publish to selected targets
release-kit publish --target pypi --target ghcr

# 5. For real
release-kit publish --target pypi --target ghcr --apply
```

## Two artefacts in one repo

This repository ships:

1. **A reference playbook** at [`docs/playbook/`](docs/playbook/) —
   33 markdown files covering every supported registry and git host,
   following an identical 8-section template. Read it standalone
   even if you never install the package.
2. **The Python automation package** under `src/release_kit/` —
   Typer CLI + config-driven runner + per-platform implementations.

## Status

| | |
|---|---|
| Version | 0.1.0 |
| Python | ≥ 3.11 |
| Platforms (playbook) | 26 platforms documented |
| Platforms (code) | 25 platforms registered (16 registries + 8 git hosts + 1 sub-class via inheritance) |
| Tests | 158 passing, 76% coverage (gate 70%) |
| Type-check | `mypy --strict` clean on 47 source files |

## Configuration

Three layers, highest wins:

1. CLI flags (`--target pypi --apply`)
2. Environment variables (loaded from `.env` in dev; from CI secret
   store in prod)
3. JSON config (`release.json`, validated against the bundled
   schema)

Example `release.json`:

```json
{
  "$schema": "./schema/release-kit.schema.json",
  "project": {
    "name": "my-project",
    "version_source": "pyproject.toml"
  },
  "targets": {
    "pypi":           { "enabled": true, "auth": "oidc" },
    "ghcr":           { "enabled": true, "auth": "oidc", "image": "ghcr.io/my-org/my-project" },
    "github_release": { "enabled": true, "draft": false, "generate_notes": true }
  },
  "policies": {
    "require_clean_git": true,
    "require_tag_match": true,
    "continue_on_error": false,
    "default_dry_run": true
  }
}
```

Full schema: [`docs/configuration.md`](docs/configuration.md).
JSON Schema (machine-readable): `src/release_kit/schema/release-kit.schema.json`.

## CLI surface

| Command | Purpose |
|---|---|
| `release-kit init` | Scaffold `release.json` + `.env-example` in the current dir |
| `release-kit doctor` | Per-target readiness check (green / amber / red) |
| `release-kit publish [--target NAME ...] [--apply]` | Run the publish flow |
| `release-kit bootstrap-repo [--apply]` | Apply topics + branch protection per config |
| `release-kit verify [--target NAME ...]` | Run each target's verify step to confirm artifacts are live |
| `release-kit rotate-tokens [--platform SLUG ...] [--list]` | Interactive token rotation helper |
| `release-kit version` | Print version |

Full reference: [`docs/cli.md`](docs/cli.md).

## Documentation

| | |
|---|---|
| [`docs/playbook/`](docs/playbook/) | The standalone reference for every supported platform |
| [`docs/architecture.md`](docs/architecture.md) | How the package is laid out + extension points |
| [`docs/configuration.md`](docs/configuration.md) | Full JSON config schema |
| [`docs/cli.md`](docs/cli.md) | Every command, every flag |
| [`docs/security.md`](docs/security.md) | Token handling, OIDC, rotation cadence |
| [`docs/workflows/`](docs/workflows/) | End-to-end how-tos (first publish, CI release, OIDC bootstrap) |
| [`docs/recipes/`](docs/recipes/) | Copy-pasteable example configs |
| [`docs/troubleshooting.md`](docs/troubleshooting.md) | Symptom → cause → fix |

## Built by

[Simtabi LLC](https://simtabi.com) · MIT license · contributions welcome.
