Xurpas Data Quality Report
How to Use
- Load the data to be analyzed (so far only csv files supported)
- Import the DataReport class
- Save the report to html File
DataReport
Creates and saves to file the data report.
Args
file: The path of the file you want to analyze. If empty, df parameter must exist.
Only supports .csv, .xlsx, .parquet, and .orc file formats.
df: Pandas DataFrame object of data to be analyzed, If using df, file must be empty.
report_name: Name of the report. Defaults to 'Data Report'.
file_path: Path/ directory of where the report is to be saved.
data_types: A dict containing the column names and column type to specify column data type. Data Types currently allowed "Categorical, Numerical, Date, Text".
minimal: Default is True. A boolean to check if you want minimal mode as your data report.
sample_mode: The mode of sampling. Choose between 'auto', 'manual', or 'none'. Default is 'auto'. If 'manual', you must provide a sample_size parameter. If 'none', no sampling is done to the data.
sample_size: The fraction of the data to be sampled. Only used when sample_mode is 'manual'.
auto_sample_dataset_length: The length of the dataset to be sampled. Only used when sample_mode is 'auto'. If empty, defaults to 100000.
config_file: Optional. The path of the configuration file. If empty, default values will be used.
Returns
HTML File of data quality Report
Sample Usage using pandas DataFrame
import pandas as pd
from xurpas_data_quality import DataReport
df = pd.read_csv("manhour_utilization_summary.csv")
report = DataReport(df=df,
report_name="Manhour Utilization Summary",
file_path="test_reports/test.html")
report.to_file()
Sample Usage using filepath
from xurpas_data_quality import DataReport
report = DataReport(file="manhour_utilization_summary.csv",
report_name="Manhour Utilization Summary",
file_path="test_reports/test.html")
report.to_file()
Sample Usage with a config file
from xurpas_data_quality import DataReport
report = DataReport(file="manhour_utilization_summary.csv",
report_name="Manhour Utilization Summary",
file_path="test_reports/test.html",
config_file ="./path_to_config_file/config.yaml")
report.to_file()
1 maintainer
Metadata
1 maintainer
Release files for xurpas-data-quality 1.8.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| xurpas_data_quality-1.8.0.tar.gz | 32.2 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| xurpas_data_quality-1.8.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 84.6 kB
Release files / xurpas_data_quality-1.8.0.tar.gz
| Download URL | xurpas_data_quality-1.8.0.tar.gz |
|---|---|
| Size | 32.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a807fbcc596b6e866f16f4f2d3f5cab9cbe068a88bb645e8c8ae4fabce6c70a7
|
|
BLAKE2b-256 checksum How to use checksums |
9857717828dc97d83dc3c23d01df0ef745bd0a23e0075cccf417965165d95e48
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Release files / xurpas_data_quality-1.8.0-py3-none-any.whl
| Download URL | xurpas_data_quality-1.8.0-py3-none-any.whl |
|---|---|
| Size | 52.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
922abb9e632e31619729ee8fb8e05ea1ddf022debfaeb31380d7b8d3383e31fa
|
|
BLAKE2b-256 checksum How to use checksums |
a8afd3efe8803575cf6af35ce60fb9e07dad939e84fdafa45d1bb210e9864382
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
