# dbt Schema Generator
A command-line tool to generate schema.yml files for specified dbt models.
## Installation
Install the package using pip:
```
pip install dbt_schema_generator
```
# Usage
You can use the dbt_schema_generator command-line tool with the following options:
-m, --models: A comma-separated list of model names to include in the schema.yml file.
-p, --path: A path to include models in the schema.yml file.
Examples:
```
dbt_schema_generator -m model1,model2,model3
dbt_schema_generator --models model1,model2,model3
```
```
# Using this format, dbt_schema_generator would generate a schema.yml file for all models within your_folder
dbt_schema_generator -path models/your_folder
dbt_schema_generator --path models/your_folder
```
NOTE: When using path the format should always be models/ the folder unless you have changed the model-paths in your dbt_project.yml
**NOTE: When using the `--path` option, the format should always be `models/your_folder` unless you have changed the `model-paths` in your `dbt_project.yml`.**
## **!!!!IMPORTANT!!!!: Be very careful when using the --path method as this would overwrite any schema.yml currently within the folder**
Raw data
{
"_id": null,
"home_page": "https://github.com/Muizzkolapo/dbt_schema_generator.git",
"name": "dbt-schema-generator",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "",
"keywords": "",
"author": "Your Name",
"author_email": "lateefmuizz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/95/af/1c8262ba694ff65a1223d74b8b604a8e1bb5eeb91b2ff962df29e57803b6/dbt_schema_generator-0.1.1a2.tar.gz",
"platform": null,
"description": "# dbt Schema Generator\n\nA command-line tool to generate schema.yml files for specified dbt models.\n\n## Installation\n\nInstall the package using pip:\n\n```\npip install dbt_schema_generator\n```\n\n# Usage\n\nYou can use the dbt_schema_generator command-line tool with the following options:\n\n-m, --models: A comma-separated list of model names to include in the schema.yml file.\n-p, --path: A path to include models in the schema.yml file.\n\n\nExamples:\n\n```\ndbt_schema_generator -m model1,model2,model3\ndbt_schema_generator --models model1,model2,model3\n```\n\n```\n# Using this format, dbt_schema_generator would generate a schema.yml file for all models within your_folder\ndbt_schema_generator -path models/your_folder\ndbt_schema_generator --path models/your_folder\n```\nNOTE: When using path the format should always be models/ the folder unless you have changed the model-paths in your dbt_project.yml\n\n**NOTE: When using the `--path` option, the format should always be `models/your_folder` unless you have changed the `model-paths` in your `dbt_project.yml`.**\n\n\n\n## **!!!!IMPORTANT!!!!: Be very careful when using the --path method as this would overwrite any schema.yml currently within the folder**\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A command-line tool to generate schema.yml files for specified dbt models",
"version": "0.1.1a2",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d4dc9f32247d2e61f5a87ce104eee35701a0ef08ad64683a72821ab5545d3e6",
"md5": "35c5de5ad3b9ee6975a4a50c07a28897",
"sha256": "8859bd4f7ffc911dcea355998330a4bb52391067d9464f66d835bc596da0686d"
},
"downloads": -1,
"filename": "dbt_schema_generator-0.1.1a2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "35c5de5ad3b9ee6975a4a50c07a28897",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 5168,
"upload_time": "2023-04-12T15:40:03",
"upload_time_iso_8601": "2023-04-12T15:40:03.782180Z",
"url": "https://files.pythonhosted.org/packages/4d/4d/c9f32247d2e61f5a87ce104eee35701a0ef08ad64683a72821ab5545d3e6/dbt_schema_generator-0.1.1a2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "95af1c8262ba694ff65a1223d74b8b604a8e1bb5eeb91b2ff962df29e57803b6",
"md5": "72f6e5220ca8689ac28ae922217c2d38",
"sha256": "17d3285ac57ed36edd5fab9c4562ff63c72451a5bd2cdc3eb210fd298f93c0a8"
},
"downloads": -1,
"filename": "dbt_schema_generator-0.1.1a2.tar.gz",
"has_sig": false,
"md5_digest": "72f6e5220ca8689ac28ae922217c2d38",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 4459,
"upload_time": "2023-04-12T15:40:05",
"upload_time_iso_8601": "2023-04-12T15:40:05.543474Z",
"url": "https://files.pythonhosted.org/packages/95/af/1c8262ba694ff65a1223d74b8b604a8e1bb5eeb91b2ff962df29e57803b6/dbt_schema_generator-0.1.1a2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-04-12 15:40:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "Muizzkolapo",
"github_project": "dbt_schema_generator.git",
"lcname": "dbt-schema-generator"
}
JSON
