:py:mod:`wfexs_backend.fetchers.doi`
====================================

.. py:module:: wfexs_backend.fetchers.doi

.. autodoc2-docstring:: wfexs_backend.fetchers.doi
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`fetchDOI <wfexs_backend.fetchers.doi.fetchDOI>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.fetchDOI
          :summary:

Data
~~~~

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

   * - :py:obj:`DOI_SCHEME <wfexs_backend.fetchers.doi.DOI_SCHEME>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.DOI_SCHEME
          :summary:
   * - :py:obj:`DOI_RA_REST <wfexs_backend.fetchers.doi.DOI_RA_REST>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.DOI_RA_REST
          :summary:
   * - :py:obj:`DOI_HANDLE_REST <wfexs_backend.fetchers.doi.DOI_HANDLE_REST>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.DOI_HANDLE_REST
          :summary:
   * - :py:obj:`ZENODO_RECORD_PREFIX <wfexs_backend.fetchers.doi.ZENODO_RECORD_PREFIX>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.ZENODO_RECORD_PREFIX
          :summary:
   * - :py:obj:`ZENODO_NEW_RECORD_PREFIX <wfexs_backend.fetchers.doi.ZENODO_NEW_RECORD_PREFIX>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.ZENODO_NEW_RECORD_PREFIX
          :summary:
   * - :py:obj:`B2SHARE_RECORD_PREFIX <wfexs_backend.fetchers.doi.B2SHARE_RECORD_PREFIX>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.B2SHARE_RECORD_PREFIX
          :summary:
   * - :py:obj:`OSF_IO_RECORD_PREFIX <wfexs_backend.fetchers.doi.OSF_IO_RECORD_PREFIX>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.OSF_IO_RECORD_PREFIX
          :summary:
   * - :py:obj:`WORKFLOWHUB_RECORD_PREFIX <wfexs_backend.fetchers.doi.WORKFLOWHUB_RECORD_PREFIX>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.doi.WORKFLOWHUB_RECORD_PREFIX
          :summary:

API
~~~

.. py:data:: DOI_SCHEME
   :canonical: wfexs_backend.fetchers.doi.DOI_SCHEME
   :value: 'doi'

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.DOI_SCHEME

.. py:data:: DOI_RA_REST
   :canonical: wfexs_backend.fetchers.doi.DOI_RA_REST
   :value: 'https://doi.org/doiRA/'

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.DOI_RA_REST

.. py:data:: DOI_HANDLE_REST
   :canonical: wfexs_backend.fetchers.doi.DOI_HANDLE_REST
   :value: 'https://doi.org/api/handles/'

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.DOI_HANDLE_REST

.. py:data:: ZENODO_RECORD_PREFIX
   :canonical: wfexs_backend.fetchers.doi.ZENODO_RECORD_PREFIX
   :value: '/record/'

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.ZENODO_RECORD_PREFIX

.. py:data:: ZENODO_NEW_RECORD_PREFIX
   :canonical: wfexs_backend.fetchers.doi.ZENODO_NEW_RECORD_PREFIX
   :value: '/doi/10.5281/zenodo.'

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.ZENODO_NEW_RECORD_PREFIX

.. py:data:: B2SHARE_RECORD_PREFIX
   :canonical: wfexs_backend.fetchers.doi.B2SHARE_RECORD_PREFIX
   :value: '/records/'

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.B2SHARE_RECORD_PREFIX

.. py:data:: OSF_IO_RECORD_PREFIX
   :canonical: wfexs_backend.fetchers.doi.OSF_IO_RECORD_PREFIX
   :value: '/'

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.OSF_IO_RECORD_PREFIX

.. py:data:: WORKFLOWHUB_RECORD_PREFIX
   :canonical: wfexs_backend.fetchers.doi.WORKFLOWHUB_RECORD_PREFIX
   :value: '/workflows/'

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.WORKFLOWHUB_RECORD_PREFIX

.. py:function:: fetchDOI(remote_file: wfexs_backend.common.URIType, cachedFilename: wfexs_backend.common.PathLikePath, secContext: Optional[SecurityContextConfig] = None) -> wfexs_backend.fetchers.ProtocolFetcherReturn
   :canonical: wfexs_backend.fetchers.doi.fetchDOI

   .. autodoc2-docstring:: wfexs_backend.fetchers.doi.fetchDOI