dbt-bouncer 2.0.0rc1__py3-none-any.whl → 2.1.0__py3-none-any.whl

dbt_bouncer/main.py

@@ -192,7 +192,7 @@ def run_bouncer(
     return results[0]
 
 
-@click.command()
+@click.group(invoke_without_command=True)
 @click.option(
     "--config-file",
     default=Path("dbt-bouncer.yml"),
@@ -246,15 +246,59 @@ def cli(
     verbosity: int,
 ) -> None:
     """Entrypoint for dbt-bouncer."""
-    config_file_source = ctx.get_parameter_source("config_file").name  # type: ignore[union-attr]
-    exit_code = run_bouncer(
-        config_file=config_file,
-        create_pr_comment_file=create_pr_comment_file,
-        only=only,
-        output_file=output_file,
-        output_only_failures=output_only_failures,
-        show_all_failures=show_all_failures,
-        verbosity=verbosity,
-        config_file_source=config_file_source,
-    )
-    ctx.exit(exit_code)
+    if ctx.invoked_subcommand is None:
+        config_file_source = ctx.get_parameter_source("config_file").name  # type: ignore[union-attr]
+        exit_code = run_bouncer(
+            config_file=config_file,
+            create_pr_comment_file=create_pr_comment_file,
+            only=only,
+            output_file=output_file,
+            output_only_failures=output_only_failures,
+            show_all_failures=show_all_failures,
+            verbosity=verbosity,
+            config_file_source=config_file_source,
+        )
+        ctx.exit(exit_code)
+
+
+@cli.command()
+def init() -> None:
+    """Create a basic dbt-bouncer.yml file.
+
+    Raises:
+        RuntimeError: If the config file already exists.
+
+    """
+    config_content = """# dbt-bouncer configuration file
+# This file is used to configure dbt-bouncer checks.
+
+dbt_artifacts_dir: target # Directory where dbt artifacts (manifest.json, etc.) are located.
+
+manifest_checks:
+  - name: check_model_description_populated
+    description: All models must have a description.
+
+  - name: check_model_names
+    description: Models in the staging layer should always start with "stg_".
+    include: ^models/staging
+    model_name_pattern: ^stg_
+
+  - name: check_model_has_unique_test
+    description: All models must have a unique test defined.
+
+# Example: check that relies on `catalog.json` being present
+# catalog_checks:
+#   - name: check_column_description_populated
+#     description: All columns in the marts layer must have a description.
+#     include: ^models/marts
+"""
+    configure_console_logging(verbosity=0)
+
+    config_path = Path("dbt-bouncer.yml")
+    if config_path.exists():
+        raise RuntimeError(f"{config_path} already exists.")
+
+    with Path(config_path).open("w") as f:
+        f.write(config_content)
+
+    logging.info(f"Created `{config_path}`.")

dbt_bouncer/version.py

@@ -5,4 +5,4 @@ def version() -> str:
         str: The version of `dbt-bouncer`.
 
     """
-    return "2.0.0rc1"
+    return "2.1.0"

{dbt_bouncer-2.0.0rc1.dist-info → dbt_bouncer-2.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbt-bouncer
-Version: 2.0.0rc1
+Version: 2.1.0
 Summary: Configure and enforce conventions for your dbt project.
 Author-email: Padraic Slattery <pgoslatara@gmail.com>
 Maintainer-email: Padraic Slattery <pgoslatara@gmail.com>
@@ -134,17 +134,8 @@ All documentation can be found on `dbt-bouncer` [documentation website](https://
 
 1. Create a `dbt-bouncer.yml` config file:
 
-    ```yml
-    manifest_checks:
-      - name: check_model_directories
-        include: ^models
-        permitted_sub_directories:
-          - intermediate
-          - marts
-          - staging
-      - name: check_model_names
-        include: ^models/staging
-        model_name_pattern: ^stg_
+    ```shell
+    dbt-bouncer init
     ```
 
 1. Run `dbt-bouncer`:

{dbt_bouncer-2.0.0rc1.dist-info → dbt_bouncer-2.1.0.dist-info}/RECORD

@@ -4,10 +4,10 @@ dbt_bouncer/config_file_parser.py,sha256=iun73dJfaC6n171YihA4pEVM22wngHOIcwXGVC7
 dbt_bouncer/config_file_validator.py,sha256=oOs4lgflLIMKdARra3Je0MggzF4gEfBRwFWioSn-BNQ,11330
 dbt_bouncer/global_context.py,sha256=5ct2jjtaTtfgO8vHYCBETaxOoYG4u5lDaBltFn0RJzE,690
 dbt_bouncer/logger.py,sha256=qkwB-SVUE4YUUp-MtmbcDPUX7t3zdniQL5Linuomr94,1804
-dbt_bouncer/main.py,sha256=wQtl3i7QDoo4ymiYrneaRBecDHWSNwSBY7B0GSnT1NU,8694
+dbt_bouncer/main.py,sha256=DYqE9-OQMJ9CQHsTU2kLEHnKaEi7YEpXH5bvYu48EEg,10085
 dbt_bouncer/runner.py,sha256=1JjMecab6d5UYkWBa4bkw5SWlA0RDb40sbp7YB_9BYw,11650
 dbt_bouncer/utils.py,sha256=WaqIVRCvuHRqnN3lMd9xtzLGJ-E06gz3Ols6jIZZC5k,12810
-dbt_bouncer/version.py,sha256=Xd_u4K-00ASNLNIka953jW8CU5JQazjTBPzuFpHkfQ8,151
+dbt_bouncer/version.py,sha256=6hD5XSTWvrGsnQU-KS-eP1sdAF7xPgFVpWNXnDFzLSU,148
 dbt_bouncer/artifact_parsers/parsers_catalog.py,sha256=CbW_8IoNX8Son32Z5Ca2aqoyqPLalD6zKokogZOe-6s,3173
 dbt_bouncer/artifact_parsers/parsers_common.py,sha256=R6CBF8EwpqUZnApLFST3CxSB9eauPaz_oU8bDXU5kCo,7390
 dbt_bouncer/artifact_parsers/parsers_manifest.py,sha256=79zMP2MhOsaqioc8VxO9vMRJcdY1ALQ_CvWEPO8OpWE,10698
@@ -29,9 +29,9 @@ dbt_bouncer/checks/manifest/check_snapshots.py,sha256=Ke7OdGHLHYquNjiBrw0lMImAcp
 dbt_bouncer/checks/manifest/check_sources.py,sha256=ZsV3aL10vKX_UM4ip2pAEkGUQdTWJcIVl6hzdXXnT6E,20921
 dbt_bouncer/checks/manifest/check_unit_tests.py,sha256=I0orkSnueseUHqCQv7pdmzawnxZTwepDzcl8RgS5GXg,10046
 dbt_bouncer/checks/run_results/check_run_results.py,sha256=WL8neXGyPBhV_znbilVTF57__lXE97kCGB2lSc7931w,4614
-dbt_bouncer-2.0.0rc1.dist-info/licenses/LICENSE,sha256=gGXp4VL__ZWlTWhXHRjWJmkxl5X9UJ7L7n1dr2WlfsY,1074
-dbt_bouncer-2.0.0rc1.dist-info/METADATA,sha256=MjpYiM-8lhn01ALw2HUQxvMRYX2DsM-vjwDawXWZrtc,5717
-dbt_bouncer-2.0.0rc1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dbt_bouncer-2.0.0rc1.dist-info/entry_points.txt,sha256=BGHZ6oZsZjq5MUVKYSdbwy80f7cEOCTC-UqqEN1GrBg,53
-dbt_bouncer-2.0.0rc1.dist-info/top_level.txt,sha256=TnVuJYP3nH_F7nkc63iXA34kAnwrOWWDpTUyd-GLpR4,12
-dbt_bouncer-2.0.0rc1.dist-info/RECORD,,
+dbt_bouncer-2.1.0.dist-info/licenses/LICENSE,sha256=gGXp4VL__ZWlTWhXHRjWJmkxl5X9UJ7L7n1dr2WlfsY,1074
+dbt_bouncer-2.1.0.dist-info/METADATA,sha256=74RetFovgA9LvAFDlYL7G_Q6iis22XUcI8xLkHhZb6c,5456
+dbt_bouncer-2.1.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+dbt_bouncer-2.1.0.dist-info/entry_points.txt,sha256=BGHZ6oZsZjq5MUVKYSdbwy80f7cEOCTC-UqqEN1GrBg,53
+dbt_bouncer-2.1.0.dist-info/top_level.txt,sha256=TnVuJYP3nH_F7nkc63iXA34kAnwrOWWDpTUyd-GLpR4,12
+dbt_bouncer-2.1.0.dist-info/RECORD,,

{dbt_bouncer-2.0.0rc1.dist-info → dbt_bouncer-2.1.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.9.0)
+Generator: setuptools (80.10.2)
 Root-Is-Purelib: true
 Tag: py3-none-any