Metadata-Version: 2.1
Name: django-query-to-table
Version: 0.1.9
Summary: A simple to use Django package to turn your sql query into a beautiful reporting html table
Home-page: https://github.com/birddevelper/django-query-to-table
Download-URL: https://pypi.org/project/django-query-to-table/
Author: M.Shaeri
License: GNU
Keywords: Django,Report,HTML,Table,SQL
Description-Content-Type: text/markdown
License-File: LICENSE.txt

[![Downloads](https://static.pepy.tech/personalized-badge/django-query-to-table?period=total&units=international_system&left_color=black&right_color=green&left_text=Downloads)](https://pepy.tech/project/django-query-to-table)

### django-query-to-table is an easy to use django package to generate html table from sql query.

You can read more about this package here : [django query to table](https://mshaeri.com/blog/generate-html-table-report-from-sql-query-in-django/)

The package contains one function named "generateFromSql" accepting 12 arguments :

* cursor : DB cursor
* title : The title of the report that will be shown on top of table
* sqltext : The sql select query to retrieve data
* footerCols : A list of columns name that you want to have Sum of values on footer . Example : ['amount','price']
* htmlClass : Html CSS classes for the table
* direction (default = "ltr") : Indicates direction of the report page.  "ltr"- Left to Right , "rtl" -  Right to Left
* font (default = "Tahoma") : Font of title and table contents
* totalText (default = "Total") : Title of footer row that will be the put below the first column.
* rowIndex (default = False) : Indicates whether the table should have index column or not.
* headerRowColor (default = '#eeeeee') :  The header (title) row background color.
* evenRowColor (default = '#ffffff') :  The even rows background color.
* oddRowColor (default = '#ffffff') :  The odd rows background color.



## Installation
To install django-query-to-table using pip :

```shell
pip install django-query-to-table
```

## Usage :


```python
from django.db import connection
from django_query_to_table import DjangoQtt
from django.http import HttpResponse

# view function in Django project
def listOfPersons(request):
  cursor = connection.cursor()
  reportTitle = "Employee List"
  sqlQuery = "SELECT FirstName as 'First Name', LastName as 'Last Name', phone as 'Phone Number', salary as 'Salary' FROM persons"
  columnsToBeSummarized = ['Salary']
  fontName = "Arial"
  cssClasses = "reportTable container"
  headerRowBackgroundColor = '#ffeeee'
  evenRowsBackgroundColor = '#ffeeff'
  oddRowsBackgroundColor = '#ffffff'
  table = DjangoQtt.generateFromSql(cursor, reportTitle, sqlQuery, columnsToBeSummarized, cssClasses,
                                  "ltr", fontName, "Total Salary", True,
                                  headerRowBackgroundColor, evenRowsBackgroundColor, oddRowsBackgroundColor
                                  )
  # table is a string variable contianing the html table showing the query result

  return HttpResponse(table)
   
 ```

