:py:mod:`wfexs_backend.utils.orcid`
===================================

.. py:module:: wfexs_backend.utils.orcid

.. autodoc2-docstring:: wfexs_backend.utils.orcid
   :allowtitles:

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

Functions
~~~~~~~~~

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

   * - :py:obj:`validate_orcid <wfexs_backend.utils.orcid.validate_orcid>`
     - .. autodoc2-docstring:: wfexs_backend.utils.orcid.validate_orcid
          :summary:

Data
~~~~

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

   * - :py:obj:`ORCID_HOST <wfexs_backend.utils.orcid.ORCID_HOST>`
     - .. autodoc2-docstring:: wfexs_backend.utils.orcid.ORCID_HOST
          :summary:
   * - :py:obj:`ORCID_PATTERN <wfexs_backend.utils.orcid.ORCID_PATTERN>`
     - .. autodoc2-docstring:: wfexs_backend.utils.orcid.ORCID_PATTERN
          :summary:
   * - :py:obj:`ORCID_CURIE <wfexs_backend.utils.orcid.ORCID_CURIE>`
     - .. autodoc2-docstring:: wfexs_backend.utils.orcid.ORCID_CURIE
          :summary:
   * - :py:obj:`ORCID_URL_PREFIX <wfexs_backend.utils.orcid.ORCID_URL_PREFIX>`
     - .. autodoc2-docstring:: wfexs_backend.utils.orcid.ORCID_URL_PREFIX
          :summary:

API
~~~

.. py:data:: ORCID_HOST
   :canonical: wfexs_backend.utils.orcid.ORCID_HOST
   :type: Final[str]
   :value: 'orcid.org'

   .. autodoc2-docstring:: wfexs_backend.utils.orcid.ORCID_HOST

.. py:data:: ORCID_PATTERN
   :canonical: wfexs_backend.utils.orcid.ORCID_PATTERN
   :type: Final[Pattern[str]]
   :value: 'compile(...)'

   .. autodoc2-docstring:: wfexs_backend.utils.orcid.ORCID_PATTERN

.. py:data:: ORCID_CURIE
   :canonical: wfexs_backend.utils.orcid.ORCID_CURIE
   :type: Final[str]
   :value: 'orcid'

   .. autodoc2-docstring:: wfexs_backend.utils.orcid.ORCID_CURIE

.. py:data:: ORCID_URL_PREFIX
   :canonical: wfexs_backend.utils.orcid.ORCID_URL_PREFIX
   :type: Final[str]
   :value: None

   .. autodoc2-docstring:: wfexs_backend.utils.orcid.ORCID_URL_PREFIX

.. py:function:: validate_orcid(orcid_or_url: str) -> Optional[ResolvedORCID]
   :canonical: wfexs_backend.utils.orcid.validate_orcid

   .. autodoc2-docstring:: wfexs_backend.utils.orcid.validate_orcid
