Metadata-Version: 2.1
Name: ploosh
Version: 0.1.7.1
Summary: A framework to automatize your tests for data projects
Home-page: https://github.com/CSharplie/ploosh/
Download-URL: https://pypi.org/project/ploosh/
License: Apache License 2.0
Project-URL: Bug Tracker, https://github.com/CSharplie/ploosh/issues
Project-URL: CI, https://github.com/CSharplie/ploosh/actions
Project-URL: Documentation, https://github.com/CSharplie/ploosh
Project-URL: Source Code, https://github.com/CSharplie/ploosh
Platform: Any
Requires-Python: >=3.6
Description-Content-Type: text/markdown

# Ploosh

Ploosh is yaml based framework used to automatized the testing process in data projects. 

# Get started
Go to the [ploosh wiki](https://github.com/CSharplie/ploosh/wiki) to find the get started tutorial.

## Steps
1. Install PyJeb package
2. Run tests
3. Analyse results

## Install Ploosh

Install from [PyPi](https://pypi.org/project/ploosh/) package manager:
``` shell
pip install ploosh
```

## Run tests
``` shell
ploosh --connections "connections.yml" --cases "test_cases" --export "JSON" --p_my_sql_server_password "mypassword"
```

![Execution result](https://raw.githubusercontent.com/wiki/CSharplie/ploosh/images/execution.png)

## Test results
``` json
[
  {
    "name": "Test aggregated data",
    "state": "passed",
    "source": {
      "start": "2024-02-05T17:08:36Z",
      "end": "2024-02-05T17:08:36Z",
      "duration": 0.0032982
    },
    "expected": {
      "start": "2024-02-05T17:08:36Z",
      "end": "2024-02-05T17:08:36Z",
      "duration": 6.0933333333333335e-05
    },
    "compare": {
      "start": "2024-02-05T17:08:36Z",
      "end": "2024-02-05T17:08:36Z",
      "duration": 0.00046468333333333334
    }
  },
  {
    "name": "Test unvalid data",
    "state": "failed",
    "source": {
      "start": "2024-02-05T17:08:36Z",
      "end": "2024-02-05T17:08:36Z",
      "duration": 0.00178865
    },
    "expected": {
      "start": "2024-02-05T17:08:36Z",
      "end": "2024-02-05T17:08:36Z",
      "duration": 1.49e-05
    },
    "compare": {
      "start": "2024-02-05T17:08:36Z",
      "end": "2024-02-05T17:08:36Z",
      "duration": 1.8333333333333333e-07
    },
    "error": {
      "type": "count",
      "message": "The count in source dataset (55) is differant than the count the in expected dataset (0)"
    }
  }
]
```
