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

.. py:module:: wfexs_backend.fetchers.osf_io

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

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

Functions
~~~~~~~~~

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

   * - :py:obj:`fetchOSFIO <wfexs_backend.fetchers.osf_io.fetchOSFIO>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.osf_io.fetchOSFIO
          :summary:

Data
~~~~

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

   * - :py:obj:`OSF_IO_SCHEME <wfexs_backend.fetchers.osf_io.OSF_IO_SCHEME>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.osf_io.OSF_IO_SCHEME
          :summary:
   * - :py:obj:`OSF_IO_RECORD_REST <wfexs_backend.fetchers.osf_io.OSF_IO_RECORD_REST>`
     - .. autodoc2-docstring:: wfexs_backend.fetchers.osf_io.OSF_IO_RECORD_REST
          :summary:

API
~~~

.. py:data:: OSF_IO_SCHEME
   :canonical: wfexs_backend.fetchers.osf_io.OSF_IO_SCHEME
   :value: 'osf.io'

   .. autodoc2-docstring:: wfexs_backend.fetchers.osf_io.OSF_IO_SCHEME

.. py:data:: OSF_IO_RECORD_REST
   :canonical: wfexs_backend.fetchers.osf_io.OSF_IO_RECORD_REST
   :value: 'https://api.osf.io/v2/nodes/'

   .. autodoc2-docstring:: wfexs_backend.fetchers.osf_io.OSF_IO_RECORD_REST

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

   .. autodoc2-docstring:: wfexs_backend.fetchers.osf_io.fetchOSFIO