More docs! w/ some emphasis on "reports" section

This commit is contained in:
Lance Edgar 2021-01-15 15:16:23 -06:00
parent 2072e41e19
commit da9823324d
38 changed files with 358 additions and 71 deletions

View file

@ -0,0 +1,19 @@
==============
Report Handler
==============
Each app will have exactly one "report handler" which is reponsible for the
overall logic of running and emailing reports etc. It also determines which
report types are available to be ran.
Rattail provides a default report handler so unless you have custom
requirements, you will not need to define your own report handler. See the
:class:`~rattail:rattail.reporting.handlers.ReportHandler` class for more
details.
Programmatically you can access your report handler like so::
# assuming you already have config
app = config.get_app()
handler = app.get_report_handler()