goshawk 0.0.1.4b0

A tool for managing SQL Models

goshawk

SQL Model Management for Humans

• Github repository: https://github.com/ebrassell/goshawk/
• Documentation https://ebrassell.github.io/goshawk/

Getting started with your Goshawk

Install goshawk into a virtual environment using pip (we recommend using pipx) :

pip install gohawk

Set MODELS_PATH env var to the folder containing your models.

Project Name
`-- 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

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPi or Artifactory, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

• Create an API Token on Pypi.
• Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
• Create a new release on Github.
• Create a new tag in the form *.*.*.

For more details, see here.

---

Repository initiated with fpgmaas/cookiecutter-poetry.