oasislmf.cli.api
================

.. py:module:: oasislmf.cli.api


Classes
-------

.. autoapisummary::

   oasislmf.cli.api.ListApiCmd
   oasislmf.cli.api.RunApiCmd
   oasislmf.cli.api.RunInputApiCmd
   oasislmf.cli.api.RunLossApiCmd
   oasislmf.cli.api.DeleteApiCmd
   oasislmf.cli.api.GetApiCmd
   oasislmf.cli.api.ApiCmd


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

.. py:class:: ListApiCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Issue API GET requests via the command line


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'PlatformList'



.. py:class:: RunApiCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Run a model via the Oasis Platoform API end to end


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'PlatformRun'



.. py:class:: RunInputApiCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Run a model via the Oasis Platoform API end to end


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'PlatformRunInputs'



.. py:class:: RunLossApiCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Run a model via the Oasis Platoform API end to end


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'PlatformRunLosses'



.. py:class:: DeleteApiCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Delete items from the Platform API


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'PlatformDelete'



.. py:class:: GetApiCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisComputationCommand`


   Download files from the Oasis Platoform API


   .. py:attribute:: formatter_class


   .. py:attribute:: computation_name
      :value: 'PlatformGet'



.. py:class:: ApiCmd(*args, **kwargs)

   Bases: :py:obj:`oasislmf.cli.command.OasisBaseCommand`


   The base command to inherit from for each command.

   2 additional arguments (``--verbose`` and ``--config``) are added to
   the parser so that they are available for all commands.


   .. py:attribute:: sub_commands