guardian oss 🛡️

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Make will help you
3. Available Integrations
   • PostgreSQL
   • Microsoft SQL Server
   • MySQL >> WIP
   • Oracle >> WIP
4. Acknowledgments

About The Project

Guardian OSS project is REST API wrapper for greatexpectations.io library.

greatexpectations.io is a tool for data quality validation, documentation, and profiling.

Can we be better prepared for expected unexpected philosophy ? The expect the unexpected philosophy leads to the freedom of choice and the freedom of others people judgment, creating a future full of possibilities, accepting that whatever will be, will be; the future's not ours to see, que será, será.

Built With

Getting Started

Make will help you

To build , run and more... use magic of make help to play with this project.

make help

and you receive below list:

build                Build project with compose
clean                Clean Reset project containers with compose
coverage             Run project tests with coverage
down                 Reset project containers with compose
help                 Show this help
restore_db_backup    Restore database backup on running sqlserver container
test                 Run project tests
up_code              Run project with compose
verify_db_backup     Verify database backup file names before restore on running sqlserver container

Local development with poetry

Install poetry with pipx

pipx install --suffix "@1.6" poetry==1.6.1

Spawn new shell with poetry

poetry@1.6 shell

Install project dependencies

poetry@1.6 install

How to setup project and feed database

1. Use make to build and run project. It will add local volumes with SQL Server database files. Check ./sqlserver folder for more details.

make build && make up_code

2. Download AdventureWorksLT2022 database backup from here

3. Copy database to ./sqlserver/restore folder and restore it with make command

cp AdventureWorksLT2022.bak ./sqlserver/restore && make restore_db_backup

Hope you enjoy it.