semvec/pypi-packages huggingface dataset:
yamdgenerator 0.0.8
For generating dbt yaml and md files

# Yamd
PCAG Yaml and Markdown file generator for dbt.



# Requirements

The libraries used for this package can be found in the accompanying requirements.txt

# **Important information !!!!**

These are information the user of this program needs to be aware of to get optimum usage of this code. 

1. Before running this package ensure you have ran your dbt model successfully.
2. Ensure you are using the right dbt profile which is expected to be the one used for local.
3. Its adviceable to use the virtual environment as seen in the Makefile.
4. **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.**


# dbt_yamd_generator

simple library written for automatically generating the yaml and md files needed for dbt models as stated in the style guide.





## Usage without Make FIle (mostly windows users)
ensure your integrated terminal is in the  yamd_generator folder, run as in the sequence below.

```
# run the below code line by line to setup a virtual environment

python -m venv yaml_venv

.\yaml_venv\Scripts\activate

python -m pip install -r requirements.txt



# run the below to initiate the yamd generator and follow prompt
python  dbt_yamd_generator.py

- The first prompt is for your dataset e.g pah_yourname_dbt_analytics_platform.
- The next prompt is for the path to the folder or file to generate yaml.
- The final prompt asks to generate templated md files.

# run the below to remove virtual environment and cache
--- Use this command to deactivate virtual env

deactivate  

--- Use this command to delete virtual env

rm -rf __pycache__

rm -rf yaml_venv

```

## Usage with Make File
ensure your integrated terminal is in the  yamd_generator folder, run as in the sequence below.

```
# make setup - This creates a temporary virtual environment so your local installation would not be impacted

# make run - This would run the yamd generator and will return a prompt, you add your dataset name and the path to the current business domain or folder you are modelling for.

- The first prompt is for your dataset e.g pah_yourname_dbt_analytics_platform.
- The next prompt is for the path to the folder or file to generate yaml.
- The final prompt asks to generate templated md files.

# make clean - This should be run once the yaml generator is done generating your yaml and md files, it helps remove the virtual environement and pycache.

```
robotframework-Datum 1.1.1
robot framework library that contains a set of functions for working with JSON, PDf and Text..
Requires Python: >=3.0

Datum library
=============

Datum is a robot framework library that contains a set of functions for working with JSON files, PDF documents, and text data. These functions may be useful for a wide range of tasks, such as verifying the integrity of data, performing basic data analysis, extracting data from PDFs, and converting PDFs into other formats.

Installation
------------

`pip install robotframework-datum`
|Running this command installs also the latest version of dependencies.

Keywords
--------

`Compare JSON Files` function likely compares the contents of two JSON files and returns a Boolean value indicating whether or not they are the same. This could be useful for verifying that two JSON files have the same structure and data.

`Compare PDF And Return Differences` function probably compares the contents of two PDF documents and returns a list of any differences that it finds. This could be useful for verifying that two PDF documents are the same, or for identifying any changes that have been made between versions.

`Count Occurrences` function likely counts the number of times a particular string or pattern appears in a given piece of text. This could be useful for performing basic data analysis or for identifying patterns in text data.

`Count PDF Pages` function probably counts the number of pages in a PDF document. This could be useful for determining the length of a document or for verifying that a PDF has been fully generated.

`Decompose PDF` function likely breaks a PDF document down into its individual components, such as text, images, and other media. This could be useful for extracting data from a PDF or for repurposing the content of a PDF in another format.

`PDF To TXT` function probably converts a PDF document into a plain text file. This could be useful for extracting the text content of a PDF for further processing or analysis.

Library website
--------
https://robotframeworkdatum.github.io/