Django Slick Reporting

一个功能齐全的报告引擎。

特性

轻松创建简单、分组、时间序列和交叉表报告，只需几行代码。
只需一行代码即可为报告创建图表。
创建自定义复杂计算。
针对速度进行了优化。
易于扩展。

安装

使用包管理器 pip <https://pip.pypa.io/en/stable/>_ 安装django-slick-reporting。

.. code-block:: console

    pip install django-slick-reporting

使用方法

假设我们有一个包含典型销售数据的模型SalesTransaction。我们可以从该模型中提取不同种类的信息。

让我们从"分组"报告开始。这将生成一个报告，显示在特定时间内每种产品销售的数量和价值。

.. code-block:: python

# 在 views.py 中
from django.db.models import Sum
from slick_reporting.views import ReportView, Chart
from slick_reporting.fields import ComputationField
from .models import MySalesItems


class TotalProductSales(ReportView):
    report_model = SalesTransaction
    date_field = "date"
    group_by = "product"
    columns = [
        "name",
        ComputationField.create(
            Sum, "quantity", verbose_name="总销售数量", is_summable=False
        ),
        ComputationField.create(
            Sum, "value", name="sum__value", verbose_name="总销售额 $"
        ),
    ]

    chart_settings = [
        Chart(
            "总销售额 $",
            Chart.BAR,
            data_source=["sum__value"],
            title_source=["name"],
        ),
        Chart(
            "总销售额 $ [饼图]",
            Chart.PIE,
            data_source=["sum__value"],
            title_source=["name"],
        ),
    ]


# 然后，在 urls.py 中
path("total-sales-report", TotalProductSales.as_view())

使用这段代码，你将得到类似这样的结果：

.. image:: https://i.ibb.co/SvxTM23/Selection-294.png :target: https://i.ibb.co/SvxTM23/Selection-294.png :alt: 视图页面中的结果

时间序列

时间序列报告是按时间段生成的报告。时间段可以是每日、每周、每月、每年或自定义。计算将针对时间序列中的每个时间段执行。

示例：在一个日期范围内，每个产品每月的销售额是多少？

.. code-block:: python

# 在 views.py 中
from slick_reporting.views import ReportView
from slick_reporting.fields import ComputationField
from .models import SalesTransaction


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

    time_series_pattern = "monthly"
    # 或 "yearly"、"weekly"、"daily"，以及其他自定义模式
    time_series_columns = [
        ComputationField.create(
            Sum, "value", verbose_name=_("销售额"), name="value"
        )  # 每月将计算的内容
    ]

    chart_settings = [
        Chart(
            _("月度总销售额"),
            Chart.PIE,
            data_source=["value"],
            title_source=["name"],
            plot_total=True,
        ),
        Chart(
            "总销售额 [面积图]",
            Chart.AREA,
            data_source=["value"],
            title_source=["name"],
            plot_total=False,
        ),
    ]

.. image:: https://github.com/ra-systems/django-slick-reporting/blob/develop/docs/source/topics/_static/timeseries.png?raw=true :alt: 时间序列报告 :align: center

交叉表

使用交叉表报告（也称为矩阵报告）来显示三个或更多查询项之间的关系。交叉表报告以行和列的形式显示数据，并在交叉点汇总信息。

.. code-block:: python

    # 在 views.py 中
    from slick_reporting.views import ReportView
    from slick_reporting.fields import ComputationField
    from .models import MySalesItems


    class MyCrosstabReport(ReportView):

        crosstab_field = "client"
        crosstab_ids = [1, 2, 3]
        crosstab_columns = [
            ComputationField.create(Sum, "value", verbose_name=_("对应的值")),
        ]
        crosstab_compute_remainder = True

        columns = [
            "some_optional_field",
            # 你可以自定义交叉表列相对于其他列的显示位置
            "__crosstab__",
            # 这与交叉表中的计算相同，但这一列将计算整个集合的总值
            ComputationField.create(Sum, "value", verbose_name=_("总值")),
        ]

.. image:: https://github.com/ra-systems/django-slick-reporting/blob/develop/docs/source/topics/_static/crosstab.png?raw=true :alt: 主页 :align: center

低级接口

视图是ReportGenerator类的封装，这是报告引擎的核心。您可以使用与ReportView相同的语法与ReportGenerator进行交互。

.. code-block:: python

from slick_reporting.generator import ReportGenerator
from .models import MySalesModel


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


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

这只是您可以做的和自定义的一小部分。

演示网站

可在 Django Slick Reporting <https://django-slick-reporting.com/>_ 上查看

您也可以在本地使用

.. code-block:: console

    # 克隆仓库
    git clone https://github.com/ra-systems/django-slick-reporting.git
    # 创建虚拟环境并激活
    python -m venv /path/to/new/virtual/environment
    source /path/to/new/virtual/environment/bin/activate

    cd django-slick-reporting/demo_proj
    pip install -r requirements.txt
    python manage.py migrate
    python manage.py create_entries
    python manage.py runserver

create_entries 命令将为演示应用生成数据

文档

可在 Read The Docs <https://django-slick-reporting.readthedocs.io/en/latest/>_ 上查看

您可以在本地运行文档

.. code-block:: console

<激活您的虚拟环境>
cd docs
pip install -r requirements.txt
sphinx-build -b html source build

未来计划

继续丰富演示项目
添加仪表盘功能

运行测试

创建一个虚拟环境（可以使用 virtual slick_reports_test），激活它；然后，

.. code-block:: console

$ git clone git+git@github.com:ra-systems/django-slick-reporting.git
$ cd tests
$ python -m pip install -e ..

$ python runtests.py
#     或者生成覆盖率报告
$ coverage run --include=../* runtests.py [-k]
$ coverage html