<commit_before># Fastrack analytics for your business. Use SQueaLy #

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)  
[![Build Status](https://travis-ci.org/hashedin/squealy.svg?branch=phase-2)](https://travis-ci.org/hashedin/squealy)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()

SQueaLy is an open-source, self-deployable application for developers. It is a micro service for business intelligence and analytics which uses SQL queries to generate reporting APIs with fine-grained security. It gives you the power to analyze your organizational data in an environment that is completely owned by you. Hence, making it the most suitable solution for generating charts and reports out of sensitive data.

<p align="center">
  <img src="./Readme-mediafiles/architecture.png" />
</p>

## When to use SQueaLy

**When you want charts and reports but don't want to build the APIs**  

Using SQueaLy, creating APIs for your reports/charts and visualizing the output is super quick. Just write the query to fetch the data from your database and use the SQueaLy's authoring interface to visualize the output. Once satisfied, give your users the permission to view/edit the report and share the URL of your report. That's it!

<p align="center">
  <img src="./Readme-mediafiles/when_to_use_squealy.png" />
</p>

**When you want fine grained security in your reporting APIs**  

You can provide not only chart level view permissions but also user/parameter level permissions. To make that one liner straighforward, consider the following use case.
```
You have a chain of hotels based on multiple locations. You create 5 reports which are to be viewed by  
the managers of each hotel but you don't want the manager of one location to view the report of the  
hotels not managed by him. Now if you write this logic in your own code, it is going to take a lot of  
time but using SQueLy, this can be done in seconds.
```<commit_msg>Adding template parameter to heroku deploy button<commit_after># Fastrack analytics for your business. Use SQueaLy #

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy/?template=https://github.com/hashedin/squealy/tree/phase-2)  
[![Build Status](https://travis-ci.org/hashedin/squealy.svg?branch=phase-2)](https://travis-ci.org/hashedin/squealy)
[![license](https://img.shields.io/github/license/mashape/apistatus.svg)]()

SQueaLy is an open-source, self-deployable application for developers. It is a micro service for business intelligence and analytics which uses SQL queries to generate reporting APIs with fine-grained security. It gives you the power to analyze your organizational data in an environment that is completely owned by you. Hence, making it the most suitable solution for generating charts and reports out of sensitive data.

<p align="center">
  <img src="./Readme-mediafiles/architecture.png" />
</p>

## When to use SQueaLy

**When you want charts and reports but don't want to build the APIs**  

Using SQueaLy, creating APIs for your reports/charts and visualizing the output is super quick. Just write the query to fetch the data from your database and use the SQueaLy's authoring interface to visualize the output. Once satisfied, give your users the permission to view/edit the report and share the URL of your report. That's it!

<p align="center">
  <img src="./Readme-mediafiles/when_to_use_squealy.png" />
</p>

**When you want fine grained security in your reporting APIs**  

You can provide not only chart level view permissions but also user/parameter level permissions. To make that one liner straighforward, consider the following use case.
```
You have a chain of hotels based on multiple locations. You create 5 reports which are to be viewed by  
the managers of each hotel but you don't want the manager of one location to view the report of the  
hotels not managed by him. Now if you write this logic in your own code, it is going to take a lot of  
time but using SQueLy, this can be done in seconds.
```
{'fraction_non_alphanumeric': 0.08056988454925079, 'fraction_numerical': 0.0012281994595922379, 'mean_word_length': 4.487870619946092, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 15, 'https://': 11, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2509971', 'n_tokens_mistral': 1158, 'n_tokens_neox': 1101, 'n_words': 538}