:py:mod:`anod.sandbox.main`
===========================

.. py:module:: anod.sandbox.main

.. autoapi-nested-parse::

   Main entry point for e3-sandbox command.



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


Functions
~~~~~~~~~

.. autoapisummary::

   anod.sandbox.main.main



Attributes
~~~~~~~~~~

.. autoapisummary::

   anod.sandbox.main.logger


.. py:data:: logger

   

.. py:function:: main(get_argument_parser: Literal[True]) -> argparse.ArgumentParser
                 main(get_argument_parser: Literal[False] = False) -> None

   Manipulate an Anod sandbox.

   This function creates the main code for the entry-point e3-sandbox. To
   create new actions it is possible to create new sandbox plugins. e.g. to
   add a new plugin ``foo`` from a package ``e3-contrib``, derives the
   class py:class:`SandBoxAction` and register the extension by adding in
   py:file:`e3-contrib/setup.py`::

       entry_points={
           'e3.anod.sandbox.sandbox_action': [
               'foo = e3_contrib.sandbox_actions.SandBoxFoo']
       }

   :param get_argument_parser: if True, return the argument parser instead
       of running the action
   :return: the argument parser if get_argument_parser is True, None otherwise