Metadata-Version: 2.1
Name: vaynerqualityassessments
Version: 0.1.18
Summary: Quality assessment functions for Tracer Data
Home-page: 
Author: Will Butler
Author-email: will.butler@vaynermedia.com
License: MIT
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: regex
Requires-Dist: datetime
Requires-Dist: veetility

# Getting Started
A Library built to work on generic pandas Dataframes and provide quality assessments such
as the number of nulls in certain columns, the recency of data row items or the number
of duplicates

[Full Online Documentation](https://vaynermedia-london.github.io/vaynerqualityassessments/)

## Library Installation
```
pip install vaynerqualityassessments
```
To upgrade the library after an update
```
pip install vaynerqualityassessments --upgrade
```
## Initialisation of the QualityAssessments class
An instance of the "QualityAssessments" class can be initiated with the ability to read/write with 
google sheets by being passed a UtilityFunctions object from the 
[veetility](https://github.com/VaynerMedia-London/veetility) library.
Please consult the documentation for that library in order to be able to create an instance of
the UtilityFunctions class

## Setup in code
Once the instance of the UtilityFunctions class has been created i.e. "util". This can then be passed
to the QualityAssessments initialisation.

```
import config as cf
from veetility import utility_functions
from vee_qa import quality_assessments as qa

util = utility_functions.UtilityFunctions(cf.google_sheet_auth_dict,cf.db_user, 
                                          cf.db_password,cf.db_host,
                                          cf.db_port, cf.db_name)

qual_assess = qa.QualityAssessments(util)
```
