# yamdgen(Alpha Version)
A Yaml and Markdown generator, a wrapper built on [dbt Codegen generate_model_yaml](https://hub.getdbt.com/dbt-labs/codegen/latest/). This simple library is for automatically generating the yaml and md files needed for dbt models rather than having to copy from the cli, this package would generate the yaml and markdown in the respective directory of the model provided. See usage below.
# Requirements
- Ensure you have included the codegen package in your packages.yml file as seen [here](https://hub.getdbt.com/dbt-labs/codegen/latest/):
```
packages:
- package: dbt-labs/codegen
version: xx.xx.xx
```
- Run dbt deps to install the package.
- Ensure you are in your dbt project folder, as you would when you want to run any dbt command.
- When using **yamlgen** ensure you have ran the dbt model you want to generate the yaml for at least once.
## YAMLGEN
**Usage for list of models**
```
# run the command below in your cli
yamlgen "['model_a','model_b','model_c']"
```
**Usage for a directory**
```
# run the command below in your cli (No quotes)
yamlgen fullpath/model_folder
```
## MDGEN
**Usage for list of models**
```
# run the command below in your cli
mdgen "['model_a','model_b','model_c']"
```
**Usage for a directory**
```
# run the command below in your cli (No quotes)
mdgen fullpath/model_folder
```
# **Important information !!!!**
1. **As this is work in progress it is advisebale to use this when you dont have a yaml and md file yet as this will overwrite your yaml and md files in your folder.**
Raw data
{
"_id": null,
"home_page": "https://github.com/Muizzkolapo/yamdgenerator",
"name": "yamdgen",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Muizz Lateef",
"author_email": "lateefmuizz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b4/78/35aa299e823aeb4e9f1e9f994b2787b93826fd5654dabee96351990c9406/yamdgen-0.0.1.3.tar.gz",
"platform": null,
"description": "# yamdgen(Alpha Version)\nA Yaml and Markdown generator, a wrapper built on [dbt Codegen generate_model_yaml](https://hub.getdbt.com/dbt-labs/codegen/latest/). This simple library is for automatically generating the yaml and md files needed for dbt models rather than having to copy from the cli, this package would generate the yaml and markdown in the respective directory of the model provided. See usage below.\n\n# Requirements\n\n- Ensure you have included the codegen package in your packages.yml file as seen [here](https://hub.getdbt.com/dbt-labs/codegen/latest/):\n\n```\npackages:\n - package: dbt-labs/codegen\n version: xx.xx.xx\n```\n- Run dbt deps to install the package.\n- Ensure you are in your dbt project folder, as you would when you want to run any dbt command.\n- When using **yamlgen** ensure you have ran the dbt model you want to generate the yaml for at least once.\n\n## YAMLGEN \n\n**Usage for list of models**\n\n```\n# run the command below in your cli \n\nyamlgen \"['model_a','model_b','model_c']\"\n\n```\n\n**Usage for a directory**\n\n```\n# run the command below in your cli (No quotes)\n\nyamlgen fullpath/model_folder\n\n```\n\n\n## MDGEN \n\n**Usage for list of models**\n\n```\n# run the command below in your cli \n\nmdgen \"['model_a','model_b','model_c']\"\n\n```\n\n**Usage for a directory**\n\n```\n# run the command below in your cli (No quotes)\n\nmdgen fullpath/model_folder\n\n```\n\n\n\n\n\n# **Important information !!!!**\n\n1. **As this is work in progress it is advisebale to use this when you dont have a yaml and md file yet as this will overwrite your yaml and md files in your folder.**\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "For generating dbt yaml and md files",
"version": "0.0.1.3",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b47835aa299e823aeb4e9f1e9f994b2787b93826fd5654dabee96351990c9406",
"md5": "3b71adcd1a4c3c793655778cc1ac0d6c",
"sha256": "c58adbc311f4de6a2caabfa286324a72e362b9adaa1f825849d77c4b664924ee"
},
"downloads": -1,
"filename": "yamdgen-0.0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "3b71adcd1a4c3c793655778cc1ac0d6c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5462,
"upload_time": "2023-02-10T17:10:55",
"upload_time_iso_8601": "2023-02-10T17:10:55.349841Z",
"url": "https://files.pythonhosted.org/packages/b4/78/35aa299e823aeb4e9f1e9f994b2787b93826fd5654dabee96351990c9406/yamdgen-0.0.1.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-02-10 17:10:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Muizzkolapo",
"github_project": "yamdgenerator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "yamdgen"
}
JSON
