:py:mod:`wfexs_backend`
=======================

.. py:module:: wfexs_backend

.. autodoc2-docstring:: wfexs_backend
   :allowtitles:

Subpackages
-----------

.. toctree::
   :titlesonly:
   :maxdepth: 3

   wfexs_backend.pushers
   wfexs_backend.container_factories
   wfexs_backend.workflow_engines
   wfexs_backend.utils
   wfexs_backend.fetchers

Submodules
----------

.. toctree::
   :titlesonly:
   :maxdepth: 1

   wfexs_backend.__main__
   wfexs_backend.side_caches
   wfexs_backend.wfexs_backend
   wfexs_backend.encrypted_fs
   wfexs_backend.security_context
   wfexs_backend.common
   wfexs_backend.docs_module
   wfexs_backend.ro_crate
   wfexs_backend.cache_handler
   wfexs_backend.workflow

Package Contents
----------------

Functions
~~~~~~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`describeGitRepo <wfexs_backend.describeGitRepo>`
     - .. autodoc2-docstring:: wfexs_backend.describeGitRepo
          :summary:
   * - :py:obj:`get_WfExS_version <wfexs_backend.get_WfExS_version>`
     - .. autodoc2-docstring:: wfexs_backend.get_WfExS_version
          :summary:
   * - :py:obj:`get_WfExS_version_str <wfexs_backend.get_WfExS_version_str>`
     - .. autodoc2-docstring:: wfexs_backend.get_WfExS_version_str
          :summary:

Data
~~~~

.. list-table::
   :class: autosummary longtable
   :align: left

   * - :py:obj:`__author__ <wfexs_backend.__author__>`
     - .. autodoc2-docstring:: wfexs_backend.__author__
          :summary:
   * - :py:obj:`__copyright__ <wfexs_backend.__copyright__>`
     - .. autodoc2-docstring:: wfexs_backend.__copyright__
          :summary:
   * - :py:obj:`__license__ <wfexs_backend.__license__>`
     - .. autodoc2-docstring:: wfexs_backend.__license__
          :summary:
   * - :py:obj:`__version__ <wfexs_backend.__version__>`
     - .. autodoc2-docstring:: wfexs_backend.__version__
          :summary:
   * - :py:obj:`__url__ <wfexs_backend.__url__>`
     - .. autodoc2-docstring:: wfexs_backend.__url__
          :summary:
   * - :py:obj:`__official_name__ <wfexs_backend.__official_name__>`
     - .. autodoc2-docstring:: wfexs_backend.__official_name__
          :summary:

API
~~~

.. py:data:: __author__
   :canonical: wfexs_backend.__author__
   :value: 'José M. Fernández <https://orcid.org/0000-0002-4806-5140>, Laura Rodriguez-Navas <https://orcid.org/...'

   .. autodoc2-docstring:: wfexs_backend.__author__

.. py:data:: __copyright__
   :canonical: wfexs_backend.__copyright__
   :value: '© 2020-2024 Barcelona Supercomputing Center (BSC), ES'

   .. autodoc2-docstring:: wfexs_backend.__copyright__

.. py:data:: __license__
   :canonical: wfexs_backend.__license__
   :value: 'Apache 2.0'

   .. autodoc2-docstring:: wfexs_backend.__license__

.. py:data:: __version__
   :canonical: wfexs_backend.__version__
   :value: '1.0.0rc0'

   .. autodoc2-docstring:: wfexs_backend.__version__

.. py:data:: __url__
   :canonical: wfexs_backend.__url__
   :value: 'https://github.com/inab/WfExS-backend'

   .. autodoc2-docstring:: wfexs_backend.__url__

.. py:data:: __official_name__
   :canonical: wfexs_backend.__official_name__
   :value: 'WfExS-backend'

   .. autodoc2-docstring:: wfexs_backend.__official_name__

.. py:function:: describeGitRepo(repo: str) -> Tuple[str, str, str]
   :canonical: wfexs_backend.describeGitRepo

   .. autodoc2-docstring:: wfexs_backend.describeGitRepo

.. py:function:: get_WfExS_version() -> Tuple[str, Optional[str], Optional[str]]
   :canonical: wfexs_backend.get_WfExS_version

   .. autodoc2-docstring:: wfexs_backend.get_WfExS_version

.. py:function:: get_WfExS_version_str() -> str
   :canonical: wfexs_backend.get_WfExS_version_str

   .. autodoc2-docstring:: wfexs_backend.get_WfExS_version_str