3
0
Fork 0

feat: add basic support for "reports" feature

not much here yet, but trying to keep it lean and unopinionated since
implementations will probably vary a bit
This commit is contained in:
Lance Edgar 2025-01-11 19:04:30 -06:00
parent 1bfab90d35
commit 20d4d4d93f
9 changed files with 395 additions and 1 deletions

View file

@ -0,0 +1,6 @@
``wuttjamaican.reports``
========================
.. automodule:: wuttjamaican.reports
:members:

View file

@ -247,6 +247,33 @@ Glossary
portion of the :term:`app`. Similar to a "plugin" concept; see
:doc:`narr/providers/index`.
report
The concept of a report is intentionally vague, in the context of
WuttJamaican. Basically it is something which can be "ran"
(usually with :term:`report params`) to generate a data set. The
output can be viewed in the app UI, or it can be saved to file.
The base class is :class:`~wuttjamaican.reports.Report`. See
also :term:`report handler`.
report handler
The :term:`handler` responsible for running :term:`reports
<report>`, for display in app UI or saved to file etc.
Base class is :class:`~wuttjamaican.reports.ReportHandler`.
report key
Unique key which identifies a particular :term:`report`.
report module
This refers to a Python module which contains :term:`report`
definitions.
report params
This refers to the input parameters used when running a
:term:`report`. It is usually a simple mapping of key/value
pairs.
settings table
Table in the :term:`app database` which is used to store
:term:`config settings<config setting>`. See also

View file

@ -87,5 +87,6 @@ Contents
api/wuttjamaican.install
api/wuttjamaican.people
api/wuttjamaican.progress
api/wuttjamaican.reports
api/wuttjamaican.testing
api/wuttjamaican.util