feriennet.boardlets
===================

.. py:module:: feriennet.boardlets


Classes
-------

.. autoapisummary::

   feriennet.boardlets.FeriennetBoardlet
   feriennet.boardlets.DisabledTicketBoardlet
   feriennet.boardlets.DisabledEditedPagesBoardlet
   feriennet.boardlets.DisabledEditedNewsBoardlet
   feriennet.boardlets.DisabledPlausibleStats
   feriennet.boardlets.DisabledPlausibleTopPages
   feriennet.boardlets.PeriodBoardlet
   feriennet.boardlets.ActivitiesBoardlet
   feriennet.boardlets.BookingsBoardlet
   feriennet.boardlets.AttendeesBoardlet
   feriennet.boardlets.MatchingBoardlet
   feriennet.boardlets.BillingPortlet


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

.. py:class:: FeriennetBoardlet(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.feriennet.request.FeriennetRequest


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



   .. py:property:: period
      :type: onegov.activity.models.PeriodMeta | None



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



   .. py:property:: state
      :type: Literal['success', 'warning', 'failure']


      Yields one of three states:

      * 'success'
      * 'warning'
      * 'failure'




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

   Bases: :py:obj:`onegov.org.boardlets.TicketBoardlet`


   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:: is_available
      :type: bool


      Returns true if the boardlet is active/has data. 



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

   Bases: :py:obj:`onegov.org.boardlets.EditedTopicsBoardlet`


   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:: is_available
      :type: bool


      Returns true if the boardlet is active/has data. 



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

   Bases: :py:obj:`onegov.org.boardlets.EditedNewsBoardlet`


   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:: is_available
      :type: bool


      Returns true if the boardlet is active/has data. 



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

   Bases: :py:obj:`onegov.org.boardlets.PlausibleStats`


   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:: is_available
      :type: bool


      Returns true if the boardlet is active/has data. 



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

   Bases: :py:obj:`onegov.org.boardlets.PlausibleTopPages`


   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:: is_available
      :type: bool


      Returns true if the boardlet is active/has data. 



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

   Bases: :py:obj:`FeriennetBoardlet`


   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:: state
      :type: Literal['success', 'failure']


      Yields one of three states:

      * 'success'
      * 'warning'
      * 'failure'




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


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



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

   Bases: :py:obj:`FeriennetBoardlet`


   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:: occasions
      :type: sqlalchemy.orm.Query[onegov.activity.Occasion]



   .. py:property:: occasions_count
      :type: int



   .. py:property:: activities_count
      :type: int



   .. py:method:: occasion_states() -> dict[onegov.feriennet.collections.match.OccasionState, int]


   .. 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:: state
      :type: Literal['success', 'warning', 'failure']


      Yields one of three states:

      * 'success'
      * 'warning'
      * 'failure'




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


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



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

   Bases: :py:obj:`FeriennetBoardlet`


   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:: counts
      :type: dict[onegov.activity.models.booking.BookingState | Literal['total'], int]



   .. py:property:: attendees_count
      :type: int



   .. 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:: state
      :type: Literal['success', 'warning', 'failure']


      Yields one of three states:

      * 'success'
      * 'warning'
      * 'failure'




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


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



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

   Bases: :py:obj:`FeriennetBoardlet`


   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:: attendee_counts
      :type: dict[str, int]



   .. 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:: state
      :type: Literal['success', 'warning', 'failure']


      Yields one of three states:

      * 'success'
      * 'warning'
      * 'failure'




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


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



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

   Bases: :py:obj:`FeriennetBoardlet`


   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:: happiness
      :type: float



   .. py:property:: unlucky_count
      :type: int



   .. 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:: state
      :type: Literal['success', 'warning', 'failure']


      Yields one of three states:

      * 'success'
      * 'warning'
      * 'failure'




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


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



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

   Bases: :py:obj:`FeriennetBoardlet`


   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:: amounts
      :type: dict[str, decimal.Decimal]



   .. 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:: state
      :type: Literal['success', 'warning', 'failure']


      Yields one of three states:

      * 'success'
      * 'warning'
      * 'failure'




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


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