Metadata-Version: 2.1
Name: kapitan
Version: 0.34.2
Summary: Generic templated configuration management for Kubernetes, Terraform and other things
Home-page: https://github.com/kapicorp/kapitan
License: Apache-2.0
Keywords: jsonnet,kubernetes,reclass,jinja
Author: Ricardo Amaro
Author-email: ramaro@kapicorp.com
Requires-Python: >=3.10,<3.13
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Software Development :: Build Tools
Provides-Extra: gojsonnet
Provides-Extra: omegaconf
Provides-Extra: reclass-rs
Requires-Dist: addict (>=2.4.0,<3.0.0)
Requires-Dist: azure-identity (>=1.12.0,<2.0.0)
Requires-Dist: azure-keyvault-keys (>=4.7.0,<5.0.0)
Requires-Dist: boto3 (>=1.18.17,<2.0.0)
Requires-Dist: certifi
Requires-Dist: cryptography (>=3.4.7,<44.0.0)
Requires-Dist: gitdb (>=4.0.10,<5.0.0)
Requires-Dist: gitpython (>=3.1.30,<4.0.0)
Requires-Dist: gojsonnet (>=0.20.0,<0.21.0) ; extra == "gojsonnet"
Requires-Dist: google-api-python-client (>=2.15.0,<3.0.0)
Requires-Dist: hvac (==2.3.0)
Requires-Dist: jinja2 (>=3.0.1,<4.0.0)
Requires-Dist: jsonnet (>=0.20.0,<0.21.0)
Requires-Dist: jsonschema (>=4.17.3,<5.0.0)
Requires-Dist: kadet (>=0.3.0,<0.4.0)
Requires-Dist: kapicorp-reclass (>=2.0.0)
Requires-Dist: omegaconf (>=2.4.0.dev3,<3.0.0) ; extra == "omegaconf"
Requires-Dist: packaging (>=23,<25)
Requires-Dist: pydantic (>=2.8.2,<3.0.0)
Requires-Dist: pydantic-settings (>=2.4.0,<3.0.0)
Requires-Dist: python-gnupg (>=0.4.7,<0.6.0)
Requires-Dist: python-magic (>=0.4.27,<0.5.0)
Requires-Dist: pyyaml (>=6.0,<7.0)
Requires-Dist: reclass-rs (>=0.5.0,<0.6.0) ; extra == "reclass-rs"
Requires-Dist: regex (>=2024.5.10,<2025.0.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Requires-Dist: six (>=1.16.0,<2.0.0)
Requires-Dist: strenum (>=0.4.15,<0.5.0) ; python_version >= "3.10" and python_version < "4.0"
Requires-Dist: toml (>=0.10.2,<0.11.0)
Requires-Dist: typing-extensions (>=4.0.0,<5.0.0)
Requires-Dist: yamllint (>=1.29.0,<2.0.0)
Project-URL: Documentation, https://kapitan.dev/
Project-URL: Repository, https://github.com/kapicorp/kapitan
Description-Content-Type: text/markdown

# Kapitan: advanced configuration management tool

[![Test, Build and Publish docker image](https://github.com/kapicorp/kapitan/actions/workflows/test-build-publish.yml/badge.svg?branch=master&event=push)](https://github.com/kapicorp/kapitan/actions/workflows/test-build-publish.yml)
![Python Version](https://img.shields.io/pypi/pyversions/kapitan)
![Downloads](https://img.shields.io/pypi/dm/kapitan)
![Docker Pulls](https://img.shields.io/docker/pulls/kapicorp/kapitan)
[![Releases](https://img.shields.io/github/release/kapicorp/kapitan.svg)](https://github.com/kapicorp/kapitan/releases)
[![Docker Image Size](https://img.shields.io/docker/image-size/kapicorp/kapitan/latest.svg)](https://hub.docker.com/r/kapicorp/kapitan)

<img src="docs/images/kapitan_logo.png" width="25">


**`Kapitan`** aims to be your *one-stop tool* to help you manage the ever growing complexity of your configurations.

Join the community [`#kapitan`](https://kubernetes.slack.com/archives/C981W2HD3)

## [**Official site**](https://kapitan.dev) <https://kapitan.dev>


## [**Quick Start**](https://kapitan.dev/getting_started/#quickstart)

## Install Kapitan

### Docker (recommended)

```shell
docker run -t --rm -v $(pwd):/src:delegated kapicorp/kapitan -h
```

On Linux you can add `-u $(id -u)` to `docker run` to preserve file permissions.

### Pip

Kapitan needs Python 3.7.

#### Install Python 3.7

* Linux: `sudo apt-get update && sudo apt-get install -y python3.7-dev python3-pip python3-yaml git`
* Mac: `brew install python3 libyaml git libmagic`

#### Install Kapitan

User (`$HOME/.local/lib/python3.7/bin` on Linux or `$HOME/Library/Python/3.7/bin` on macOS):

```shell
pip3 install --user --upgrade kapitan
```

System-wide (not recommended):

```shell
sudo pip3 install --upgrade kapitan
```

## Build Kapitan

### Docker

To build a docker image for the architecture of your machine, run `docker build . -t you-kapitan-image`, and to build for a specific platform, add `--platform linux/arm64`.

To build a multi-platform image (as the CI does), follow [the docker multi-platform documentation](https://docs.docker.com/build/building/multi-platform/).

## Related projects

* [Tesoro](https://github.com/kapicorp/tesoro) - Kubernetes Admission Controller for Kapitan Secrets
* [Kapitan Reference](https://github.com/kapicorp/kapitan-reference) - our reference repository to get started with Kapitan

