:py:mod:`GeoHealthCheck.app`
============================

.. py:module:: GeoHealthCheck.app


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


Functions
~~~~~~~~~

.. autoapisummary::

   GeoHealthCheck.app.db_commit
   GeoHealthCheck.app.before_request
   GeoHealthCheck.app.public_route
   GeoHealthCheck.app.shutdown_session
   GeoHealthCheck.app.get_locale
   GeoHealthCheck.app.load_user
   GeoHealthCheck.app.unauthorized_callback
   GeoHealthCheck.app.load_user_from_request
   GeoHealthCheck.app.cssize_reliability
   GeoHealthCheck.app.cssize_reliability2
   GeoHealthCheck.app.round2
   GeoHealthCheck.app.context_processors
   GeoHealthCheck.app.home
   GeoHealthCheck.app.export
   GeoHealthCheck.app.opensearch
   GeoHealthCheck.app.export_resource
   GeoHealthCheck.app.export_resource_history
   GeoHealthCheck.app.settings
   GeoHealthCheck.app.resources
   GeoHealthCheck.app.get_resource_by_id
   GeoHealthCheck.app.register
   GeoHealthCheck.app.add
   GeoHealthCheck.app.update
   GeoHealthCheck.app.test
   GeoHealthCheck.app.edit_resource
   GeoHealthCheck.app.delete
   GeoHealthCheck.app.get_probe_edit_form
   GeoHealthCheck.app.get_check_edit_form
   GeoHealthCheck.app.login
   GeoHealthCheck.app.logout
   GeoHealthCheck.app.reset_req
   GeoHealthCheck.app.reset
   GeoHealthCheck.app.api_summary
   GeoHealthCheck.app.api_probes_avail
   GeoHealthCheck.app.api_runs



Attributes
~~~~~~~~~~

.. autoapisummary::

   GeoHealthCheck.app.LOGGER
   GeoHealthCheck.app.APP
   GeoHealthCheck.app.CONFIG
   GeoHealthCheck.app.DB
   GeoHealthCheck.app.BABEL
   GeoHealthCheck.app.MIGRATE
   GeoHealthCheck.app.LOGIN_MANAGER
   GeoHealthCheck.app.LANGUAGES
   GeoHealthCheck.app.HOST


.. py:data:: LOGGER

   

.. py:data:: APP

   

.. py:data:: CONFIG

   

.. py:data:: DB

   

.. py:data:: BABEL

   

.. py:data:: MIGRATE

   

.. py:data:: LOGIN_MANAGER

   

.. py:data:: LANGUAGES
   :value: (('en', 'English'), ('fr', 'Français'), ('de', 'German'), ('nl_NL', 'Nederlands (Nederland)'),...

   

.. py:function:: db_commit()


.. py:function:: before_request()


.. py:function:: public_route(decorated_function)


.. py:function:: shutdown_session(exception=None)


.. py:function:: get_locale()


.. py:function:: load_user(identifier)


.. py:function:: unauthorized_callback()


.. py:function:: load_user_from_request(request)


.. py:function:: cssize_reliability(value, css_type=None)

   returns CSS button class snippet based on score


.. py:function:: cssize_reliability2(value)

   returns CSS panel class snippet based on score


.. py:function:: round2(value)

   rounds a number to 2 decimal places except for values of 0 or 100


.. py:function:: context_processors()

   global context processors for templates


.. py:function:: home()

   homepage


.. py:function:: export()

   export resource list as JSON


.. py:function:: opensearch()

   generate OpenSearch description document


.. py:function:: export_resource(identifier)

   export resource as JSON or CSV


.. py:function:: export_resource_history(identifier)

   export resource history as JSON or CSV


.. py:function:: settings()

   settings


.. py:function:: resources()

   lists resources with optional filter


.. py:function:: get_resource_by_id(identifier)

   show resource


.. py:function:: register()

   register a new user


.. py:function:: add()

   add resource


.. py:function:: update(resource_identifier)

   update a resource


.. py:function:: test(resource_identifier)

   test a resource


.. py:function:: edit_resource(resource_identifier)

   edit a resource


.. py:function:: delete(resource_identifier)

   delete a resource


.. py:function:: get_probe_edit_form(probe_class, resource_identifier=None)

   get the form to edit a Probe


.. py:function:: get_check_edit_form(check_class)

   get the form to edit a Check


.. py:function:: login()

   login


.. py:function:: logout()

   logout


.. py:function:: reset_req()

   Reset password request handling.


.. py:function:: reset(token=None)

   Reset password submit form handling.


.. py:function:: api_summary(content_type='json')

   Get health summary for all Resources within this instance.


.. py:function:: api_probes_avail(resource_type=None, resource_id=None)

   Get available (configured) Probes for this
   installation, optional for resource type


.. py:function:: api_runs(resource_id, run_id=None, content_type='json')

   Get Runs (History of results) for Resource.


.. py:data:: HOST
   :value: '0.0.0.0'