dbt-pumpkin 0.0.0__tar.gz

dbt_pumpkin-0.0.0/.gitignore

@@ -0,0 +1,8 @@
+__pycache__
+/.hatch
+/.vscode
+/.idea
+/dist
+
+#auto-generated
+/dbt_pumpkin/version.py

dbt_pumpkin-0.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

dbt_pumpkin-0.0.0/PKG-INFO

@@ -0,0 +1,209 @@
+Metadata-Version: 2.3
+Name: dbt-pumpkin
+Version: 0.0.0
+Project-URL: Source code, https://github.com/kokorin/dbt-pumpkin
+Author-email: Denis Kokorin <kokorin86@gmail.com>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: click>=8.1.0
+Requires-Dist: ruamel-yaml>=0.17
+Description-Content-Type: text/markdown
+
+# DBT-PUMPKIN
+
+`dbt-pumpkin` is a command-line tool which helps to manage [DBT](https://docs.getdbt.com/docs/introduction) projects.
+
+Inspired by [dbt-osmosis](https://z3z1ma.github.io/dbt-osmosis/)
+
+## Usage
+
+### Botstrap DBT Resources
+
+`dbt-pumpkin` allows to create DBT YAML schema files for Seeds, Models and Snapshots. For that one has to add
+[dbt-pumpking-path](#dbt-pumpkin-path) configuration property for a Resource. Then `dbt-pumpkin` will be able to
+understand where YAML files should be located.
+
+By default `dbt-pumpkin` will analyze all project's resources and create **absent** YAML schema definition files. You
+can use `--select` and `--exclude` options to select/exclude a subset of resources. These arguments work exactly the
+same way as they do with `dbt` command (`dbt list` is used under the hood).
+
+*Note*: YAML files created by this command will be almost empty. Another command should be used to add
+columns: [synchronize](#synchronize-dbt-resources)
+
+```sh
+dbt-pumpkin bootstrap --help
+Usage: dbt-pumpkin bootstrap [OPTIONS]
+
+  Bootstraps project by adding missing YAML definitions
+
+Options:
+  --project-dir TEXT
+  --profiles-dir TEXT
+  -t, --target TEXT
+  --profile TEXT
+  -s, --select TEXT
+  --exclude TEXT
+  --dry-run
+  --debug
+  --help               Show this message and exit.
+```
+
+### Relocate DBT Resources
+
+`dbt-pumpkin` also allows to move DBT YAML schema files for Sources, Seeds, Models and Snapshots. As
+with [bootstrap](#botstrap-dbt-resources) command [dbt-pumpking-path](#dbt-pumpkin-path) configuration property is
+required for a Resource. Then `dbt-pumpkin` will be able to understand where YAML files should be located.
+
+*Note*: `dbt-pumking` can split YAML schema file (if it contains several Resources) into separate YAML file, or,
+alternatively, it can merge several YAML files into one. This is all configured by `dbt-pumpking-path`.
+
+```sh
+dbt-pumpkin relocate --help
+Usage: dbt-pumpkin relocate [OPTIONS]
+
+  Relocates YAML definitions according to dbt-pumpkin-path configuration
+
+Options:
+  --project-dir TEXT
+  --profiles-dir TEXT
+  -t, --target TEXT
+  --profile TEXT
+  -s, --select TEXT
+  --exclude TEXT
+  --dry-run
+  --debug
+  --help               Show this message and exit.
+```
+
+### Synchronize DBT Resources
+
+Last, but not least, feature is `synchronize`. It analyzes schema of actual tables and views in your database and
+updates YAML schema files to have the same columns (and column types) in the same order as they are in a table/view
+corresponding to a Resource.
+
+Pay attention, that columns declared in YAML but absent in the database will be deleted. But you are using version
+control system (and most probably it's git), right? So you can always revert changes done by `dbt-pumpkin` if, for
+example, you forgot to run/build a Resource and its table/view is outdated.
+
+*Note* `dbt-pumpkin` leaves intact any descriptions, tests and any other properties set in YAML file.
+
+```sh
+dbt-pumpkin synchronize --help
+Usage: dbt-pumpkin synchronize [OPTIONS]
+
+  Synchronizes YAML definitions with actual tables in DB
+
+Options:
+  --project-dir TEXT
+  --profiles-dir TEXT
+  -t, --target TEXT
+  --profile TEXT
+  -s, --select TEXT
+  --exclude TEXT
+  --dry-run
+  --debug
+  --help               Show this message and exit.
+```
+
+## Configuration
+
+### `dbt-pumpkin-path`
+
+`dbt-pumpkin-path` is the only configuration property supported for now.
+
+It sets a path to YAML schema file of a resource. The path can relative to resource (SQL, CSV or PY) or root-relative.
+Root-relative paths set path relative to DBT project root directory and start with `/` symbol.
+
+#### Examples
+
+Configure `dbt-pumpkin` to bootstrap resources at (or relocate resources to) `_schema.yml` file located **next to**
+SQL, CSV or PY file.
+
+```yaml
+models:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema.yml
+seeds:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema.yml
+snapshots:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema.yml
+```
+
+You your Model is called `my_model` and is defined at `models/path/to/my_model.sql`, then `dbt-pumpkin` will consider
+`models/path/to/_schema.yml` as the path were the model should be bootstrapped at or relocated to.
+
+Of course, as with any other DBT configuration property, you can re-define `dbt-pumpkin-path` on resources you want:
+
+```yaml
+models:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema.yml
+    intermediate:
+      int_my_model:
+        +dbt-pumpkin-path: int_my_model.yml
+```
+
+`dbt-pumpkin-path` actually defines **template** path and supports `{name}` and `{parent}` values. `{name}` gets
+replaced with Resource's name and `{parent}` - with folder's name where resource SQL, CSV or PY file is located.
+
+```yaml
+models:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _{name}.yml
+```
+
+With the above configuration, every resource will be relocated to (bootstrapped at) separate YAML file, so `my_model`
+will be defined at `_my_model.yml`.
+
+In case you have too many resourced defined in a directory, you may specify subdirectory to hold YAML files:
+
+```yaml
+models:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema/{name}.yml
+```
+
+Source in DBT have no other files except YAML. It means that it's not possible to use relative path
+in `dbt-pumpkin-path` to configure source YAML file location. The only option is to use root-relative paths:
+
+
+```yaml
+sources:
+  "<YOU_PROJECT_NAME>":
+    # root-relative path must start with /
+    +dbt-pumpkin-path: /models/staging/_source_{name}.yml
+```
+
+## Development
+
+```sh
+# First install Hatch globally
+pip install hatch
+
+# Configure Hatch to create venvs in project
+hatch config set dirs.env.virtual .hatch
+
+# Before testing we need to build DBT project
+hatch run dbt clean
+hatch run dbt seed
+hatch run dbt build
+
+# test in one venv
+hatch test
+# test across different python & dbt versions
+hatch test --all
+```
+
+## Troubleshooting
+
+Clean envs and caches:
+
+```sh
+hatch env prune
+pip cache purge
+# UV is used by default for hatch-test environments
+uv cache clean
+```

dbt_pumpkin-0.0.0/README.md

@@ -0,0 +1,197 @@
+# DBT-PUMPKIN
+
+`dbt-pumpkin` is a command-line tool which helps to manage [DBT](https://docs.getdbt.com/docs/introduction) projects.
+
+Inspired by [dbt-osmosis](https://z3z1ma.github.io/dbt-osmosis/)
+
+## Usage
+
+### Botstrap DBT Resources
+
+`dbt-pumpkin` allows to create DBT YAML schema files for Seeds, Models and Snapshots. For that one has to add
+[dbt-pumpking-path](#dbt-pumpkin-path) configuration property for a Resource. Then `dbt-pumpkin` will be able to
+understand where YAML files should be located.
+
+By default `dbt-pumpkin` will analyze all project's resources and create **absent** YAML schema definition files. You
+can use `--select` and `--exclude` options to select/exclude a subset of resources. These arguments work exactly the
+same way as they do with `dbt` command (`dbt list` is used under the hood).
+
+*Note*: YAML files created by this command will be almost empty. Another command should be used to add
+columns: [synchronize](#synchronize-dbt-resources)
+
+```sh
+dbt-pumpkin bootstrap --help
+Usage: dbt-pumpkin bootstrap [OPTIONS]
+
+  Bootstraps project by adding missing YAML definitions
+
+Options:
+  --project-dir TEXT
+  --profiles-dir TEXT
+  -t, --target TEXT
+  --profile TEXT
+  -s, --select TEXT
+  --exclude TEXT
+  --dry-run
+  --debug
+  --help               Show this message and exit.
+```
+
+### Relocate DBT Resources
+
+`dbt-pumpkin` also allows to move DBT YAML schema files for Sources, Seeds, Models and Snapshots. As
+with [bootstrap](#botstrap-dbt-resources) command [dbt-pumpking-path](#dbt-pumpkin-path) configuration property is
+required for a Resource. Then `dbt-pumpkin` will be able to understand where YAML files should be located.
+
+*Note*: `dbt-pumking` can split YAML schema file (if it contains several Resources) into separate YAML file, or,
+alternatively, it can merge several YAML files into one. This is all configured by `dbt-pumpking-path`.
+
+```sh
+dbt-pumpkin relocate --help
+Usage: dbt-pumpkin relocate [OPTIONS]
+
+  Relocates YAML definitions according to dbt-pumpkin-path configuration
+
+Options:
+  --project-dir TEXT
+  --profiles-dir TEXT
+  -t, --target TEXT
+  --profile TEXT
+  -s, --select TEXT
+  --exclude TEXT
+  --dry-run
+  --debug
+  --help               Show this message and exit.
+```
+
+### Synchronize DBT Resources
+
+Last, but not least, feature is `synchronize`. It analyzes schema of actual tables and views in your database and
+updates YAML schema files to have the same columns (and column types) in the same order as they are in a table/view
+corresponding to a Resource.
+
+Pay attention, that columns declared in YAML but absent in the database will be deleted. But you are using version
+control system (and most probably it's git), right? So you can always revert changes done by `dbt-pumpkin` if, for
+example, you forgot to run/build a Resource and its table/view is outdated.
+
+*Note* `dbt-pumpkin` leaves intact any descriptions, tests and any other properties set in YAML file.
+
+```sh
+dbt-pumpkin synchronize --help
+Usage: dbt-pumpkin synchronize [OPTIONS]
+
+  Synchronizes YAML definitions with actual tables in DB
+
+Options:
+  --project-dir TEXT
+  --profiles-dir TEXT
+  -t, --target TEXT
+  --profile TEXT
+  -s, --select TEXT
+  --exclude TEXT
+  --dry-run
+  --debug
+  --help               Show this message and exit.
+```
+
+## Configuration
+
+### `dbt-pumpkin-path`
+
+`dbt-pumpkin-path` is the only configuration property supported for now.
+
+It sets a path to YAML schema file of a resource. The path can relative to resource (SQL, CSV or PY) or root-relative.
+Root-relative paths set path relative to DBT project root directory and start with `/` symbol.
+
+#### Examples
+
+Configure `dbt-pumpkin` to bootstrap resources at (or relocate resources to) `_schema.yml` file located **next to**
+SQL, CSV or PY file.
+
+```yaml
+models:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema.yml
+seeds:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema.yml
+snapshots:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema.yml
+```
+
+You your Model is called `my_model` and is defined at `models/path/to/my_model.sql`, then `dbt-pumpkin` will consider
+`models/path/to/_schema.yml` as the path were the model should be bootstrapped at or relocated to.
+
+Of course, as with any other DBT configuration property, you can re-define `dbt-pumpkin-path` on resources you want:
+
+```yaml
+models:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema.yml
+    intermediate:
+      int_my_model:
+        +dbt-pumpkin-path: int_my_model.yml
+```
+
+`dbt-pumpkin-path` actually defines **template** path and supports `{name}` and `{parent}` values. `{name}` gets
+replaced with Resource's name and `{parent}` - with folder's name where resource SQL, CSV or PY file is located.
+
+```yaml
+models:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _{name}.yml
+```
+
+With the above configuration, every resource will be relocated to (bootstrapped at) separate YAML file, so `my_model`
+will be defined at `_my_model.yml`.
+
+In case you have too many resourced defined in a directory, you may specify subdirectory to hold YAML files:
+
+```yaml
+models:
+  "<YOU_PROJECT_NAME>":
+    +dbt-pumpkin-path: _schema/{name}.yml
+```
+
+Source in DBT have no other files except YAML. It means that it's not possible to use relative path
+in `dbt-pumpkin-path` to configure source YAML file location. The only option is to use root-relative paths:
+
+
+```yaml
+sources:
+  "<YOU_PROJECT_NAME>":
+    # root-relative path must start with /
+    +dbt-pumpkin-path: /models/staging/_source_{name}.yml
+```
+
+## Development
+
+```sh
+# First install Hatch globally
+pip install hatch
+
+# Configure Hatch to create venvs in project
+hatch config set dirs.env.virtual .hatch
+
+# Before testing we need to build DBT project
+hatch run dbt clean
+hatch run dbt seed
+hatch run dbt build
+
+# test in one venv
+hatch test
+# test across different python & dbt versions
+hatch test --all
+```
+
+## Troubleshooting
+
+Clean envs and caches:
+
+```sh
+hatch env prune
+pip cache purge
+# UV is used by default for hatch-test environments
+uv cache clean
+```