people.cli
==========

.. py:module:: people.cli


Attributes
----------

.. autoapisummary::

   people.cli.cli
   people.cli.EXPORT_FIELDS


Functions
---------

.. autoapisummary::

   people.cli.clear
   people.cli.export_xlsx
   people.cli.import_xlsx
   people.cli.list_people


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

.. py:data:: cli

.. py:function:: clear(dry_run: bool) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Deletes all people.

   Does not support agencies and memberships at the moment.

   Example:

       onegov-people --select '/org/govikon' clear



.. py:data:: EXPORT_FIELDS

.. py:function:: export_xlsx(filename: str) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Exports all people to an excel file.

   Does not support agencies and memberships at the moment.

   Example:

       onegov-people --select '/onegov_org/govikon' export people.xlsx



.. py:function:: import_xlsx(file: IO[bytes]) -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]

   Imports people from an excel file.

   Does not support agencies and memberships at the moment.

   Example:

       onegov-people --select '/onegov_org/govikon' import people.xlsx



.. py:function:: list_people() -> collections.abc.Callable[[onegov.core.request.CoreRequest, onegov.core.framework.Framework], None]