view-selection-python 0.1.0

View Selection Tool for dbt (python part)

ViewSelectionAdvisor

Welcome to ViewSelectionAdvisor, a tool designed to inform dbt users about the problem of model materialization. This tool consists of two separate packages working together, each with their own GitHub repository:

• A dbt package
• A python package

Installation Instructions

We assume you have a working dbt project for which you want advice. If so, follow the following steps:

1. Clone or Download the Python Package:
   In a convenient location, either clone this repo by running:
   git clone https://github.com/bramreinders97/view_selection_tool_python.git,
   or download the src folder from this repository. Ensure you know the absolute filepath of the chosen location, you'll need it in the first step of the usage instructions.

2. Ensure the following packages are installed in the venv that is used:

   ruamel-yaml = "^0.18.6"
   psycopg2 = "^2.9.9"
   

Usage Instructions

1. In not done already, follow the installation and usage instructions of the dbt part of ViewSelectionAdvisor. The dbt part has to be run before the python part.

2. Choose max number models to materialize:
   Right now, ViewSelectionAdvisor by default only looks at a maximum of 2 models to materialize. This can be changed manually in the MAX_MODELS_TO_MATERIALIZE.py file by changing the corresponding variable there.

3. Obtain the advice on which models to materialize: From inside the root directory of your dbt project (from the same location as where you would call dbt run), call main.py:
   python path/to/src/main.py