pysiral._version
================

.. py:module:: pysiral._version

.. autoapi-nested-parse::

   =======
   Purpose
   =======

   This module read the auto-generated version information toml files
   and makes the importable.




Attributes
----------

.. autoapisummary::

   pysiral._version.__author__
   pysiral._version._THIS_DIR
   pysiral._version._software_version_data
   pysiral._version._git_version_data
   pysiral._version.GIT_VERSION_LOCAL
   pysiral._version.GIT_BRANCH_LOCAL
   pysiral._version.GIT_ORIGIN_LOCAL
   pysiral._version.SOFTWARE_VERSION
   pysiral._version.GIT_VERSION
   pysiral._version.GIT_BRANCH
   pysiral._version.GIT_ORIGIN


Functions
---------

.. autoapisummary::

   pysiral._version.get_git_revision_hash
   pysiral._version.get_git_branch
   pysiral._version.get_git_origin


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

.. py:data:: __author__
   :value: 'Stefan Hendricks <stefan.hendricks@awi.de>'


.. py:data:: _THIS_DIR

.. py:function:: get_git_revision_hash(target='HEAD') -> Union[str, None]

.. py:function:: get_git_branch() -> Union[str, None]

.. py:function:: get_git_origin() -> Union[str, None]

.. py:data:: _software_version_data

.. py:data:: _git_version_data

.. py:data:: GIT_VERSION_LOCAL
   :value: ''


.. py:data:: GIT_BRANCH_LOCAL
   :value: ''


.. py:data:: GIT_ORIGIN_LOCAL
   :value: ''


.. py:data:: SOFTWARE_VERSION

.. py:data:: GIT_VERSION

.. py:data:: GIT_BRANCH

.. py:data:: GIT_ORIGIN