Metadata-Version: 2.3
Name: goshawk
Version: 0.1.1
Summary: SQL Models for humans
Requires-Python: >=3.11
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: duckdb (>=1.1.3)
Requires-Dist: loguru (>=0.7.3)
Requires-Dist: pydantic-settings (>=2.7.1)
Requires-Dist: pyyaml (>=6.0.2)
Requires-Dist: snowflake-connector-python (>=3.13.2)
Requires-Dist: sqlglot (>=26.3.9)
Requires-Dist: tabulate (>=0.9.0)
Requires-Dist: typer (>=0.15.1)
Requires-Dist: typing-extensions (==4.10.0)
Description-Content-Type: text/markdown

# goshawk

[![Release](https://img.shields.io/github/v/release/ebrassell/goshawk)](https://img.shields.io/github/v/release/ebrassell/goshawk)
[![Build status](https://img.shields.io/github/actions/workflow/status/ebrassell/goshawk/main.yml?branch=main)](https://github.com/ebrassell/goshawk/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/ebrassell/goshawk/branch/main/graph/badge.svg)](https://codecov.io/gh/ebrassell/goshawk)
[![Commit activity](https://img.shields.io/github/commit-activity/m/ebrassell/goshawk)](https://img.shields.io/github/commit-activity/m/ebrassell/goshawk)
[![License](https://img.shields.io/github/license/ebrassell/goshawk)](https://img.shields.io/github/license/ebrassell/goshawk)

SQL Model Management for Humans

- **Github repository**: <https://github.com/ebrassell/goshawk/>
- **Documentation** <https://ebrassell.github.io/goshawk/>

## Getting started with Goshawk

### Installation

We recommend installing with [pipx](https://pipx.pypa.io/stable/)

```bash
pipx install gohawk
```

Or install with pip (you should always use a virtual environment)

```bash
pip install gohawk
```

Verify your installation

```bash
goshawk view-model-tree --schemas-only
```

This will display the DAG of the included sample schema

Set MODELS_PATH env var to the folder containing your models.

```bash
`-- models <-set MODELS_PATH to the path to this folder
     -- mydatabase
         -- schema_1
             -- model_1a.sql
             -- model_1b.sql
         -- schema_2
             -- model_2a.sql
             -- model_2b.sql

export MODELS_PATH=models
```

### Create a dev environemnt

```bash
goshawk init-env [envname]
```

### Test your changes (using your dev environment)

```bash
goshawk deploy-models --test --db-env [envname]
```

### Deploy your changes to your dev environment

```bash
goshawk deploy-models --test --db-env [envname]
```

### Destroy your dev environemnt

```bash
goshawk destroy-env [envname]
```

