gazette.path
============

.. py:module:: gazette.path


Functions
---------

.. autoapisummary::

   gazette.path.get_auth
   gazette.path.get_principal
   gazette.path.get_users
   gazette.path.get_user
   gazette.path.get_groups
   gazette.path.get_group
   gazette.path.get_categories
   gazette.path.get_category
   gazette.path.get_organizations
   gazette.path.get_organization
   gazette.path.get_page_move
   gazette.path.get_issues
   gazette.path.get_issue
   gazette.path.get_issue_pdf
   gazette.path.get_notices
   gazette.path.get_notice


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

.. py:function:: get_auth(request: onegov.gazette.request.GazetteRequest, to: str = '/') -> onegov.user.Auth

.. py:function:: get_principal(app: onegov.gazette.GazetteApp) -> onegov.gazette.models.Principal

.. py:function:: get_users(app: onegov.gazette.GazetteApp) -> onegov.user.UserCollection

.. py:function:: get_user(app: onegov.gazette.GazetteApp, username: str) -> onegov.user.User | None

.. py:function:: get_groups(app: onegov.gazette.GazetteApp) -> onegov.user.UserGroupCollection[onegov.user.UserGroup]

.. py:function:: get_group(app: onegov.gazette.GazetteApp, id: str) -> onegov.user.UserGroup | None

.. py:function:: get_categories(app: onegov.gazette.GazetteApp) -> onegov.gazette.collections.CategoryCollection

.. py:function:: get_category(app: onegov.gazette.GazetteApp, id: int) -> onegov.gazette.models.Category | None

.. py:function:: get_organizations(app: onegov.gazette.GazetteApp) -> onegov.gazette.collections.OrganizationCollection

.. py:function:: get_organization(app: onegov.gazette.GazetteApp, id: int) -> onegov.gazette.models.Organization | None

.. py:function:: get_page_move(app: onegov.gazette.GazetteApp, subject_id: int, direction: onegov.core.orm.abstract.MoveDirection, target_id: int) -> onegov.gazette.models.OrganizationMove

.. py:function:: get_issues(app: onegov.gazette.GazetteApp) -> onegov.gazette.collections.IssueCollection

.. py:function:: get_issue(app: onegov.gazette.GazetteApp, name: str) -> onegov.gazette.models.Issue | None

.. py:function:: get_issue_pdf(request: onegov.gazette.request.GazetteRequest, app: onegov.gazette.GazetteApp, name: str) -> onegov.gazette.models.issue.IssuePdfFile | None

.. py:function:: get_notices(app: onegov.gazette.GazetteApp, state: onegov.notice.models.NoticeState, page: int = 0, term: str | None = None, order: str | None = None, direction: str | None = None, from_date: datetime.date | None = None, to_date: datetime.date | None = None, categories: list[str] | None = None, organizations: list[str] | None = None, source: uuid.UUID | None = None, own: bool | None = None) -> onegov.gazette.collections.GazetteNoticeCollection

.. py:function:: get_notice(app: onegov.gazette.GazetteApp, name: str) -> onegov.gazette.models.GazetteNotice | None