onboarding.models.town_assistant
================================

.. py:module:: onboarding.models.town_assistant


Attributes
----------

.. autoapisummary::

   onboarding.models.town_assistant._valid_subdomain


Classes
-------

.. autoapisummary::

   onboarding.models.town_assistant.TownAssistant


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

.. py:data:: _valid_subdomain

.. py:class:: TownAssistant(app: onegov.onboarding.app.OnboardingApp, current_step_number: int = 1)

   Bases: :py:obj:`onegov.onboarding.models.assistant.Assistant`


   An assistant guiding a user through onegov.town6 onboarding. 


   .. py:method:: first_step(request: onegov.core.request.CoreRequest, form: onegov.onboarding.forms.TownForm) -> onegov.core.types.RenderData | webob.Response


   .. py:method:: last_step(request: onegov.core.request.CoreRequest, form: onegov.onboarding.forms.FinishForm) -> onegov.core.types.RenderData | webob.Response


   .. py:property:: config
      :type: dict[str, Any]



   .. py:method:: get_subdomain(name: str) -> str


   .. py:method:: get_domain(name: str) -> str


   .. py:method:: get_schema(name: str) -> str


   .. py:method:: add_town(name: str, user: str, color: str, request: onegov.core.request.CoreRequest) -> onegov.core.types.RenderData