:mod:`memote.suite.reporting.report`
====================================

.. py:module:: memote.suite.reporting.report

.. autoapi-nested-parse::

   Provide an abstract report base class that sets the interface.

   ..
       !! processed by numpydoc !!



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   memote.suite.reporting.report.Report



.. data:: LOGGER
   

   

.. py:class:: Report(result, configuration, **kwargs)

   Bases: :class:`object`

   Determine the abstract report interface.














   :Attributes:

       **result** : memote.MemoteResult
           The dictionary structure of results.

       **configuration** : memote.MemoteConfiguration
           A memote configuration structure.


   ..
       !! processed by numpydoc !!

   .. method:: render_json(self, pretty=False)

      Render the report results as JSON.


      :Parameters:

          **pretty** : bool, optional
              Whether to format the resulting JSON in a more legible way (
              default False).














      ..
          !! processed by numpydoc !!


   .. method:: render_html(self)

      Render an HTML report.
















      ..
          !! processed by numpydoc !!


   .. method:: get_configured_tests(self)

      Get tests explicitly configured.
















      ..
          !! processed by numpydoc !!


   .. method:: determine_miscellaneous_tests(self)

      Identify tests not explicitly configured in test organization.

      List them as an additional card called `Misc`, which is where they will
      now appear in the report.















      ..
          !! processed by numpydoc !!


   .. method:: compute_score(self)

      Calculate the overall test score using the configuration.
















      ..
          !! processed by numpydoc !!