Metadata-Version: 2.1
Name: QueryGuard
Version: 0.1.0b4
Summary: A guard against unruly sql.
Author: Tyler Klier
Author-email: tylerklier@gmail.com
Requires-Python: >=3.9,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: rich (>=13.6.0,<14.0.0)
Requires-Dist: sqlparse (>=0.4.4,<0.5.0)
Requires-Dist: tomli (>=2.0.1,<3.0.0) ; python_version < "3.11"
Requires-Dist: typer (>=0.9.0,<0.10.0)
Description-Content-Type: text/markdown

# QueryGuard - *A guard against unruly sql*

![Logo](docs/images/logo.jpg)

[![Test](https://github.com/dataNdeadlifts/QueryGuard/actions/workflows/test.yml/badge.svg)](https://github.com/dataNdeadlifts/QueryGuard/actions/workflows/test.yml)
[![codecov](https://codecov.io/github/dataNdeadlifts/QueryGuard/graph/badge.svg?token=3TL6N3BMM4)](https://codecov.io/github/dataNdeadlifts/QueryGuard)
![PyPI - Version](https://img.shields.io/pypi/v/QueryGuard)

---

**Documentation**: [http://queryguard.readthedocs.io/](http://queryguard.readthedocs.io/)

**Source Code**: [https://github.com/dataNdeadlifts/QueryGuard](https://github.com/dataNdeadlifts/QueryGuard)

---

QueryGuard is a command line tool for analyzing SQL queries for best practices
and adherance to security policies.

It functions very similarly to static analysis tools for other programing languages
such as flake8, ruff, and ESLint but for your database queries.

## Requirements

Python 3.9+

## Installation

```console
pip install QueryGuard
```

## Example

### Check all sql files in a folder

![Simple Violation](docs/images/simple_violation.png)

### Ignore a specific rule

![Ignore Violation](docs/images/ignore_violation.png)

## License

This project is licensed under the terms of the Apache 2.0 license.

