Metadata-Version: 2.1
Name: dbt-platform-helper
Version: 10.6.1
Summary: Set of tools to help transfer applications/services from GOV.UK PaaS to DBT PaaS augmenting AWS Copilot.
License: MIT
Author: Department for Business and Trade Platform Team
Author-email: sre-team@digital.trade.gov.uk
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: Jinja2 (>=3.1.3,<4.0.0)
Requires-Dist: PyYAML (==6.0.1)
Requires-Dist: aiohttp (>=3.8.4,<4.0.0)
Requires-Dist: boto3 (>=1.28.24,<2.0.0)
Requires-Dist: boto3-stubs (>=1.26.148,<2.0.0)
Requires-Dist: botocore (>=1.34.85,<2.0.0)
Requires-Dist: certifi (>=2023.7.22,<2025.0.0)
Requires-Dist: cfn-flip (==1.3.0)
Requires-Dist: cfn-lint (>=1.4.2,<2.0.0)
Requires-Dist: checkov (>=3.1.67,<4.0.0)
Requires-Dist: click (>=8.1.3,<9.0.0)
Requires-Dist: cloudfoundry-client (==1.35.2)
Requires-Dist: cryptography (>=41.0.3,<43.0.0)
Requires-Dist: jinja2-simple-tags (>=0.5.0,<0.6.0)
Requires-Dist: jsonschema (>=4.17.0,<4.18.0)
Requires-Dist: mypy-boto3-codebuild (>=1.26.0.post1,<2.0.0)
Requires-Dist: prettytable (>=3.9.0,<4.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: schema (==0.7.5)
Requires-Dist: semver (>=3.0.2,<4.0.0)
Requires-Dist: slack-sdk (>=3.27.1,<4.0.0)
Requires-Dist: tomlkit (>=0.12.2,<0.13.0)
Description-Content-Type: text/markdown

# DBT Platform Helper

This package contains a set of tools in the form of a Command Line Interface (CLI) primarily for automating operations used when working with the Department for Business and Trade (DBT) Platform.

## Getting started

To use the Python package `dbt-platform-helper`, follow the steps below.

### Installation

```shell
pip install dbt-platform-helper
```

### Usage

Check `dbt-platform-helper` has installed successfully by executing `platform-helper` in the terminal emulator. You should see an output similar to the following:

```shell
$ platform-helper
Usage: platform-helper [OPTIONS] COMMAND [ARGS]...

Options:
  --version  Show the version and exit.
  --help     Show this message and exit.

Commands:
  bootstrap
  check-cloudformation  Runs the checks passed in the command arguments.
  codebuild
  copilot
  domain
```

Each command can be executed without any arguments or additional commands to present the `help` message.

Below is the output for the `bootstrap` command as of version `0.1.2`.

```shell
$ platform-helper bootstrap --help
Usage: platform-helper bootstrap [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  instructions     Show migration instructions.
  make-config      Generate copilot boilerplate code.
  migrate-secrets  Migrate secrets from your gov paas application to...
```

See the [Commands Reference](https://github.com/uktrade/platform-tools/blob/main/dbt_platform_helper/COMMANDS.md) for a list of all available subcommands.

