org.boardlets
=============

.. py:module:: org.boardlets


Classes
-------

.. autoapisummary::

   org.boardlets.OrgBoardlet
   org.boardlets.TicketBoardlet
   org.boardlets.EditedTopicsBoardlet
   org.boardlets.EditedNewsBoardlet
   org.boardlets.PlausibleStats
   org.boardlets.PlausibleTopPages


Functions
---------

.. autoapisummary::

   org.boardlets.get_icon_for_access_level
   org.boardlets.get_icon_title


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

.. py:class:: OrgBoardlet(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)

   Bases: :py:obj:`onegov.org.models.Boardlet`


   Base class used by all boardlets.

   Use as follows::

       from onegov.app import App

       @App.boardlet(name='foo', order=(1, 1), icon='')
       class MyBoardlet(Boardlet):
           pass



   .. py:attribute:: request
      :type:  onegov.org.request.OrgRequest


   .. py:property:: session
      :type: sqlalchemy.orm.Session



   .. py:property:: layout
      :type: onegov.org.layout.DefaultLayout



   .. py:property:: plausible_api
      :type: onegov.plausible.plausible_api.PlausibleAPI | None



.. py:class:: TicketBoardlet(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)

   Bases: :py:obj:`OrgBoardlet`


   Base class used by all boardlets.

   Use as follows::

       from onegov.app import App

       @App.boardlet(name='foo', order=(1, 1), icon='')
       class MyBoardlet(Boardlet):
           pass



   .. py:property:: title
      :type: str


      Returns the title of the boardlet, which is meant to be something
      meaningful, like the most important metric used in the boardlet.




   .. py:property:: facts
      :type: collections.abc.Iterator[onegov.org.models.BoardletFact]


      Yields facts. (:class:`BoardletFact` instances)



.. py:function:: get_icon_for_access_level(access: str) -> str

.. py:function:: get_icon_title(request: onegov.org.request.OrgRequest, access: str) -> str

.. py:class:: EditedTopicsBoardlet(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)

   Bases: :py:obj:`OrgBoardlet`


   Base class used by all boardlets.

   Use as follows::

       from onegov.app import App

       @App.boardlet(name='foo', order=(1, 1), icon='')
       class MyBoardlet(Boardlet):
           pass



   .. py:property:: title
      :type: str


      Returns the title of the boardlet, which is meant to be something
      meaningful, like the most important metric used in the boardlet.




   .. py:property:: facts
      :type: collections.abc.Iterator[onegov.org.models.BoardletFact]


      Yields facts. (:class:`BoardletFact` instances)



.. py:class:: EditedNewsBoardlet(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)

   Bases: :py:obj:`OrgBoardlet`


   Base class used by all boardlets.

   Use as follows::

       from onegov.app import App

       @App.boardlet(name='foo', order=(1, 1), icon='')
       class MyBoardlet(Boardlet):
           pass



   .. py:property:: title
      :type: str


      Returns the title of the boardlet, which is meant to be something
      meaningful, like the most important metric used in the boardlet.




   .. py:property:: facts
      :type: collections.abc.Iterator[onegov.org.models.BoardletFact]


      Yields facts. (:class:`BoardletFact` instances)



.. py:class:: PlausibleStats(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)

   Bases: :py:obj:`OrgBoardlet`


   Base class used by all boardlets.

   Use as follows::

       from onegov.app import App

       @App.boardlet(name='foo', order=(1, 1), icon='')
       class MyBoardlet(Boardlet):
           pass



   .. py:property:: title
      :type: str


      Returns the title of the boardlet, which is meant to be something
      meaningful, like the most important metric used in the boardlet.




   .. py:property:: is_available
      :type: bool


      Returns true if the boardlet is active/has data. 



   .. py:property:: facts
      :type: collections.abc.Iterator[onegov.org.models.BoardletFact]


      Yields facts. (:class:`BoardletFact` instances)



.. py:class:: PlausibleTopPages(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)

   Bases: :py:obj:`OrgBoardlet`


   Base class used by all boardlets.

   Use as follows::

       from onegov.app import App

       @App.boardlet(name='foo', order=(1, 1), icon='')
       class MyBoardlet(Boardlet):
           pass



   .. py:property:: title
      :type: str


      Returns the title of the boardlet, which is meant to be something
      meaningful, like the most important metric used in the boardlet.




   .. py:property:: is_available
      :type: bool


      Returns true if the boardlet is active/has data. 



   .. py:property:: facts
      :type: collections.abc.Iterator[onegov.org.models.BoardletFact]


      Yields facts. (:class:`BoardletFact` instances)