dbtective 0.1.25__py3-none-win_amd64.whl → 0.1.27__py3-none-win_amd64.whl

{dbtective-0.1.25.dist-info → dbtective-0.1.27.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dbtective
-Version: 0.1.25
+Version: 0.1.27
 Classifier: Development Status :: 2 - Pre-Alpha
 Classifier: Environment :: Console
 Classifier: Intended Audience :: Developers
@@ -24,6 +24,10 @@ Project-URL: Homepage, https://feliblo.github.io/dbtective/
 
 dbtective is a Rust-powered 'detective' for `dbt metadata` best practices. As your dbt project grows, keeping metadata consistent and high-quality can become a real challenge.
 
+
+![CLI demo](/docs/static/demo.gif)
+
+
 Explore the [full documentation](https://feliblo.github.io/dbtective/docs) or the [possible checks](https://feliblo.github.io/dbtective/docs/checks).
 
 > [!WARNING]
@@ -39,7 +43,7 @@ Explore the [full documentation](https://feliblo.github.io/dbtective/docs) or th
 
 We detect and enforce these rules in your `cli`, `prek`/`pre-commit` and `CI/CD` pipeline, so fast you will barely notice🕵️.
 
-## Installationcheck
+## Installation
 
 <details>
 <summary>Pip (pypi)</summary>
@@ -76,7 +80,7 @@ brew install feliblo/tap/dbtective
 Run dbtective as part of your CI/CD pipeline. See the [GitHub Actions documentation](https://feliblo.github.io/dbtective/docs/github-actions) for more details.
 
 ```yaml
-- uses: feliblo/dbtective@v0.1.21
+- uses: feliblo/dbtective@v0.1.27
   with:
     config-file: "dbtective.yml"
     entry-point: "."
@@ -98,7 +102,7 @@ Add the following to your `.pre-commit-config.yaml`.
 ```yaml
 repos:
   - repo: https://github.com/feliblo/dbtective
-    rev: v0.1.21
+    rev: v0.1.27
     hooks:
       - id: dbtective-run
         args: [--only-manifest]
@@ -143,56 +147,41 @@ Pre-built binaries for Linux, macOS, and Windows are available on the [releases
 
 ## Quickstart
 
-All possible checks can be found in the [checks documentation](https://feliblo.github.io/dbtective/docs/). Information about configuring `dbtective` is shown at the [config documentation](https://feliblo.github.io/dbtective/docs/config)
+All possible checks can be found in the [checks documentation](https://feliblo.github.io/dbtective/docs/). Information about customizing `dbtective` is shown at the [config documentation](https://feliblo.github.io/dbtective/docs/config)
 
-### Example
+1. Create a `dbtective.yml` config file in the root of your dbt project by running:
 
-1. Create a `dbtective.yml` config file in the root of your dbt project. For example:
+More about the `init` (it also supports `pyproject.toml` or `dbtective.toml`) command is available in the [init documentation](https://feliblo.github.io/dbtective/docs/cli#dbtective-init).
 
-```yaml
-manifest_tests:
-  - name: "models_must_have_description"
-    type: "has_description"
-    severity: "error"
-    applies_to: ["models", "sources"]
-    description: " models and sources must have a description."
-
-  - name: "naming_convention"
-    type: "name_convention"
-    description: "Everything must follow the naming convention."
-    pattern: "snake_case"
-
- - name: "all_marts_must_be_tagged"
-    type: "has_tags"
-    severity: "warning"
-    applies_to: ["models"]
-    tags:
-      - "mart"
-    description: "All marts must be tagged with 'mart'"
+```bash
+dbtective init
 ```
 
-2. Run `dbtective` in the root of your current directory or specify an entry point if your dbt_project is not located in the root/current drectory.
+Inspect the contents of the generated `dbtective.yml` file and modify it to fit your project's needs.
+
+2. (Optional) Generate the dbt manifest and catalog files if you haven't done so already. Most dbt commands automatically generate the `manifest.json`, but if you want to ensure both files are up to date, run:
+
+```bash
+dbt compile
+dbt docs generate
+```
+
+3. Run `dbtective` in the root of your current directory or specify an entry point if your dbt_project is not located in the root/current drectory.
 
 ```bash
 dbtective run
 dbtective run --entry-point "my_dbt_project"
 ```
 
-## Contributing
-
-We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation, your help makes dbtective better for everyone.
+4. Review the output and fix any issues found.
 
-**Quick start:**
-Install [just](https://github.com/casey/just) command line runner & take a look at the commands in the justfile.
+5. (Optional) Integrate `dbtective` into your CI/CD pipeline or pre-commit hooks to automate checks on every commit and/or pull request.
 
-To build and run on the example project (`./dbt_project` using config `./dbt_project/dbtective.yml`) use:
+## Contributing
 
-```bash
-just run
-just run-verbose
-```
+We welcome contributions! Whether you're fixing bugs, adding features, or improving documentation, your help makes dbtective better for everyone.
 
-For detailed contributing guidelines, development setup, and coding standards, please see [CONTRIBUTING.md](./CONTRIBUTING.md).
+For detailed contributing guidelines, development setup, and coding standards, please see the [contributing documentation](https://feliblo.github.io/dbtective/docs/).
 
 
 # Acknowledgements

dbtective-0.1.27.dist-info/RECORD

@@ -0,0 +1,5 @@
+dbtective-0.1.27.data/scripts/dbtective.exe,sha256=8IBu3eDaNK0WKVP4TMwCw1Inmr6xS5yNNL_WnRvBt4I,4863488
+dbtective-0.1.27.dist-info/METADATA,sha256=383SuL3dODrwFBiG3FXItpq1POY-dve2E_as06mmv2E,6155
+dbtective-0.1.27.dist-info/WHEEL,sha256=14-pPWiwFoCAtTgD4hWnxHSfZQqe6Zt0DfwcROvwlzs,94
+dbtective-0.1.27.dist-info/licenses/LICENSE,sha256=l6L0uB6P0NYfB1uZ_2lUNbryleAeanq49Fz1D7MlG7I,1088
+dbtective-0.1.27.dist-info/RECORD,,

dbtective-0.1.25.dist-info/RECORD

@@ -1,5 +0,0 @@
-dbtective-0.1.25.data/scripts/dbtective.exe,sha256=wMuvq__T-4Vu7OWlse6CZBJNk5nmC6lgsmWqhJh-kp4,4751360
-dbtective-0.1.25.dist-info/METADATA,sha256=l0e07KVSoQrGZ3y9dl4kjDcelNZcRRrVbnxUxvtAE8k,6187
-dbtective-0.1.25.dist-info/WHEEL,sha256=14-pPWiwFoCAtTgD4hWnxHSfZQqe6Zt0DfwcROvwlzs,94
-dbtective-0.1.25.dist-info/licenses/LICENSE,sha256=l6L0uB6P0NYfB1uZ_2lUNbryleAeanq49Fz1D7MlG7I,1088
-dbtective-0.1.25.dist-info/RECORD,,