{"id":13703148,"url":"https://github.com/autotraderuk/oliver-twist","last_synced_at":"2025-04-05T21:33:06.472Z","repository":{"id":46281153,"uuid":"321656526","full_name":"autotraderuk/oliver-twist","owner":"autotraderuk","description":"dbt DAG Auditor","archived":false,"fork":false,"pushed_at":"2021-11-02T14:30:08.000Z","size":1947,"stargazers_count":41,"open_issues_count":16,"forks_count":4,"subscribers_count":6,"default_branch":"main","last_synced_at":"2024-09-24T09:16:54.166Z","etag":null,"topics":["dag","dag-auditing","dbt"],"latest_commit_sha":null,"homepage":"https://olivertwi.st","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/autotraderuk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-12-15T12:08:35.000Z","updated_at":"2024-09-05T07:41:22.000Z","dependencies_parsed_at":"2022-09-04T15:02:13.648Z","dependency_job_id":null,"html_url":"https://github.com/autotraderuk/oliver-twist","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autotraderuk%2Foliver-twist","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autotraderuk%2Foliver-twist/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autotraderuk%2Foliver-twist/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/autotraderuk%2Foliver-twist/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/autotraderuk","download_url":"https://codeload.github.com/autotraderuk/oliver-twist/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223221257,"owners_count":17108514,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["dag","dag-auditing","dbt"],"created_at":"2024-08-02T21:00:51.030Z","updated_at":"2024-11-05T18:11:15.835Z","avatar_url":"https://github.com/autotraderuk.png","language":"Python","funding_links":[],"categories":["Utilities"],"sub_categories":[],"readme":"\n\n![Alt text](https://github.com/autotraderuk/oliver-twist/blob/main/docs/images/oliver_twist_logo.png)\n# oliver-twist\n\nDAG Auditor\n\n[![Build status badge](https://github.com/autotraderuk/oliver-twist/workflows/CI/badge.svg)](https://github.com/autotraderuk/oliver-twist/actions?query=workflow%3ACI)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)\n[![PyPI](https://img.shields.io/pypi/v/olivertwist)](https://pypi.org/project/olivertwist/)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/olivertwist)](https://pypi.org/project/olivertwist/)\n[![GitHub - License](https://img.shields.io/github/license/autotraderuk/oliver-twist)](https://github.com/autotraderuk/oliver-twist/blob/main/LICENSE)\n\noliver-twist is a dag auditing tool that audits the [DBT](https://www.getdbt.com/) DAG and generates a summary report. There is a [docs site][1], including descriptions of all [currently implemented rules][2].\n\n![please sir, can I automate my DAG auditing](https://github.com/autotraderuk/oliver-twist/blob/main/docs/images/oliver_dag_meme.jpg)\n\n# Getting Started\n\nTo get started, install the package\n\n```shell\n$ pip install olivertwist\n```\n\nand then run it by passing it your dbt manifest JSON\n\n```shell\nolivertwist check manifest.json\n```\n\nThis will report any failures to the console, and also in HTML format in a directory called `target`. You can optionally auto-open the report in a browser with:\n\n```shell\nolivertwist check manifest.json --browser\n```\n\nYou can also tell Oliver to load and run your own custom rules using the `--add-rules-from` option. See [documentation for full details](https://olivertwi.st/custom_rules/).\n\nFull options are available with:\n\n```shell\nolivertwist check --help\n```\n\n## Configuration\n\n[All rules][2] are enabled by default. To change this you need a configuration file called `olivertwist.yml` in the same directory you are running `olivertwist`. An example configuration is shown below:\n\n```yaml\nversion: '1.0'\nuniversal:\n  - id: no-rejoin-models\n    enabled: false\n  - id: no-disabled-models\n    enabled: true\n```\n\nThere is a command to help you generate the config automatically:\n\n```shell\nolivertwist config\n```\n\nThis will show all the available rules and allow you to toggle the ones that you want to enforce.\n\n## Local Development\n\n### Clone this repo and install the project:\n\n`poetry install`\n\n### Install pre-commit hooks for linting\n\nThis is optional, but highly recommended to avoid annoying linting failure in CI.\n\n`poetry run pre-commit install`\n\nTo run the pre-commit hooks locally:\n\n`poetry run pre-commit run`\n\n### To get the latest versions of the dependencies and to update the poetry.lock file run:\n\n`poetry update`\n\n### To run oliver-twist and generate the summary report run:\n\n`poetry run olivertwist example_manifest.json`\n\n### Working with diagrams\n \nTo update and regenerate the images that illustrate rule failures in the documentation follow the next steps:\n- update the diagrams using the [mermaid syntax](https://mermaid-js.github.io/mermaid/#/)\n- install [yarn](https://classic.yarnpkg.com/en/docs/install/)\n- `cd docs/diagrams`\n- `./generate.sh`\n- inspect the generated images in `./docs/diagrams/output/`\n- if you're happy with the results, run `./copy.sh` so that they are copied over to `./docs/images`\n- you can now reference those images. e.g. in `.docs/rules.md`\n\n### Creating a distribution\n\n```poetry build --format wheel```\n\n\n[1]: http://olivertwi.st/\n[2]: http://olivertwi.st/rules/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautotraderuk%2Foliver-twist","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fautotraderuk%2Foliver-twist","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fautotraderuk%2Foliver-twist/lists"}