ra-systems / django-slick-reporting

Powerful and Efficient reporting engine with Charting capabilities

Django Slick Reporting

A one stop reports engine with batteries included.

Features

• Effortlessly create Simple, Grouped, Time series and Crosstab reports in a handful of code lines.
• Create Chart(s) for your reports with a single line of code.
• Create Custom complex Calculation.
• Optimized for speed.
• Easily extendable.

Installation

Use the package manager pip to install django-slick-reporting.

pip install django-slick-reporting

Usage

So you have a model that contains data, let's call it MySalesItems

You can simply use a code like this

# in your urls.py
path("path-to-report", TotalProductSales.as_view())


# in views.py
from django.db.models import Sum
from slick_reporting.views import ReportView, Chart
from slick_reporting.fields import SlickReportField
from .models import MySalesItems


class TotalProductSales(ReportView):

    report_model = MySalesItems
    date_field = "date_placed"
    group_by = "product"
    columns = [
        "title",
        SlickReportField.create(Sum, "quantity"),
        SlickReportField.create(Sum, "value", name="sum__value"),
    ]

    chart_settings = [
        Chart(
            "Total sold $",
            Chart.BAR,
            data_source="value__sum",
            title_source="title",
        ),
    ]

To get something this

Time Series

# in views.py
from slick_reporting.views import ReportView
from slick_reporting.fields import SlickReportField
from .models import MySalesItems


class MonthlyProductSales(ReportView):
    report_model = MySalesItems
    date_field = "date_placed"
    group_by = "product"
    columns = ["name", "sku"]

    # Settings for creating time series report
    time_series_pattern = (
        "monthly"  # or "yearly" , "weekly" , "daily" , others and custom patterns
    )
    time_series_columns = [
        SlickReportField.create(
            Sum, "value", verbose_name=_("Sales Value"), name="value"
        )
    ]

    chart_settings = [
        Chart(
            _("Total Sales Monthly"),
            Chart.PIE,
            data_source=["value"],
            title_source=["name"],
            plot_total=True,
        ),
    ]

Cross Tab

# in views.py
from slick_reporting.views import ReportView
from slick_reporting.fields import SlickReportField
from .models import MySalesItems


class MyCrosstabReport(ReportView):

    crosstab_field = "client"
    crosstab_ids = [1, 2, 3]
    crosstab_columns = [
        SlickReportField.create(Sum, "value", verbose_name=_("Value for")),
    ]
    crosstab_compute_remainder = True

    columns = [
        "some_optional_field",
        # You can customize where the crosstab columns are displayed in relation to the other columns
        "__crosstab__",
        # This is the same as the Same as the calculation in the crosstab, but this one will be on the whole set. IE total value
        SlickReportField.create(Sum, "value", verbose_name=_("Total Value")),
    ]

Low level

The view is a wrapper over the ReportGenerator class, which is the core of the reporting engine. You can interact with the ReportGenerator using same syntax as used with the ReportView .

from slick_reporting.generator import ReportGenerator
from .models import MySalesModel


class MyReport(ReportGenerator):
    report_model = MySalesModel
    group_by = "product"
    columns = ["title", "__total__"]


# OR
my_report = ReportGenerator(
    report_model=MySalesModel, group_by="product", columns=["title", "__total__"]
)
my_report.get_report_data()  # -> [{'title':'Product 1', '__total__: 56}, {'title':'Product 2', '__total__: 43}, ]

This is just a scratch, for more please visit the documentation

Batteries Included

Slick Reporting comes with

• A Bootstrap Filter Form
• Charting support Chart.js
• Powerful tables datatables.net

A Preview:

Demo site

Available on Django Slick Reporting

Documentation

Available on Read The Docs

Road Ahead

This project is young and can use your support.

Some of the ideas / features that ought be added

• Support Other backends like SQL Alchemy & Pandas

Running tests

Create a virtual environment (maybe with virtual slick_reports_test), activate it; Then ,

$ git clone [e-mail]:ra-systems/django-slick-reporting.git
$ cd tests
$ python -m pip install -e ..

$ python runtests.py
#     Or for Coverage report
$ coverage run --include=../* runtests.py [-k]
$ coverage html

Support & Contributing

Please consider star the project to keep an eye on it. Your PRs, reviews are most welcome and needed.

We honor the well formulated Django's guidelines to serve as contribution guide here too.

Authors

• Ramez Ashraf - Initial work - RamezIssac

Cross Reference

If you like this package, chances are you may like those packages too!

Django Tabular Permissions Display Django permissions in a HTML table that is translatable and easy customized.

Django Ra ERP Framework A framework to build business solutions with ease.

If you find this project useful or promising , You can support us by a github ⭐