org.boardlets

Classes

`OrgBoardlet`	Base class used by all boardlets.
`TicketBoardlet`	Base class used by all boardlets.
`EditedTopicsBoardlet`	Base class used by all boardlets.
`EditedNewsBoardlet`	Base class used by all boardlets.
`PlausibleStats`	Base class used by all boardlets.
`PlausibleTopPages`	Base class used by all boardlets.
`CitizenTicketBoardlet`	Base class used by all boardlets.
`CitizenReservationBoardlet`	Base class used by all boardlets.

Functions

`get_icon_for_access_level`(→ str)
`get_icon_title`(→ str)

Module Contents

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

Bases: 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

request: onegov.org.request.OrgRequest[source]

property session: sqlalchemy.orm.Session[source]

property layout: onegov.org.layout.DefaultLayout[source]

property plausible_api: onegov.plausible.plausible_api.PlausibleAPI | None[source]

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

Bases: 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

property title: str[source]: The title of the boardlet — typically the most important metric.

property facts: collections.abc.Iterator[onegov.org.models.BoardletFact][source]: Facts as BoardletFact instances.

org.boardlets.get_icon_for_access_level(access: str) → str[source]

org.boardlets.get_icon_title(request: onegov.org.request.OrgRequest, access: str) → str[source]

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

Bases: 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

property title: str[source]: The title of the boardlet — typically the most important metric.

property facts: collections.abc.Iterator[onegov.org.models.BoardletFact][source]: Facts as BoardletFact instances.

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

Bases: 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

property title: str[source]: The title of the boardlet — typically the most important metric.

property facts: collections.abc.Iterator[onegov.org.models.BoardletFact][source]: Facts as BoardletFact instances.

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

Bases: 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

property title: str[source]: The title of the boardlet — typically the most important metric.

property is_available: bool[source]: True if the boardlet is active/has data.

property facts: collections.abc.Iterator[onegov.org.models.BoardletFact][source]: Facts as BoardletFact instances.

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

Bases: 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

property title: str[source]: The title of the boardlet — typically the most important metric.

property is_available: bool[source]: True if the boardlet is active/has data.

property facts: collections.abc.Iterator[onegov.org.models.BoardletFact][source]: Facts as BoardletFact instances.

class org.boardlets.CitizenTicketBoardlet(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)[source]

Bases: 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

property title: str[source]: The title of the boardlet — typically the most important metric.

property url: str[source]: A URL the title of the boardlet should link to.

property facts: collections.abc.Iterator[onegov.org.models.BoardletFact][source]: Facts as BoardletFact instances.

class org.boardlets.CitizenReservationBoardlet(name: str, order: tuple[int, int], icon: str, request: onegov.org.request.OrgRequest)[source]

Bases: 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

property title: str[source]: The title of the boardlet — typically the most important metric.

property reservation_counts: dict[tuple[bool, bool], int][source]

property is_available: bool[source]: True if the boardlet is active/has data.

property url: str[source]: A URL the title of the boardlet should link to.

property facts: collections.abc.Iterator[onegov.org.models.BoardletFact][source]: Facts as BoardletFact instances.