ome_plugin
==========

.. py:module:: ome_plugin


Classes
-------

.. autoapisummary::

   ome_plugin.EducationResource
   ome_plugin.OMEPlugin


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

.. py:class:: EducationResource(/, **data: Any)

   Bases: :py:obj:`pydantic.BaseModel`


   The metadata for an education resource to be communicated in the Exchange.  This
   could be a lesson plan, one or more datasets, documents, worksheets, images, or
   videos.

   Attributes:
       title: Description of title
       description: Description of description
       authors: Description of author
       authoring_institution: Description of authoring_institution
       subject_tags: Description of subject_tags
       creation_date: Description of creation_date
       last_modified_date: Description of last_modified_date
       usage: Description of usage


   .. py:attribute:: title
      :type:  str
      :value: ''



   .. py:attribute:: description
      :type:  str
      :value: ''



   .. py:attribute:: authors
      :type:  list[str]
      :value: []



   .. py:attribute:: authoring_institution
      :type:  str
      :value: ''



   .. py:attribute:: subject_tags
      :type:  list[str]
      :value: []



   .. py:attribute:: creation_date
      :type:  datetime.datetime | None
      :value: None



   .. py:attribute:: last_modified_date
      :type:  datetime.datetime | None
      :value: None



   .. py:attribute:: source_url
      :type:  str
      :value: ''



.. py:class:: OMEPlugin

   This class is a placeholder for the OMEPlugin functionality.
   It is currently empty and does not implement any specific methods or properties.


   .. py:attribute:: mimetypes
      :type:  tuple[str, Ellipsis]
      :value: ()



   .. py:attribute:: newsgroups
      :type:  dict[str, str]


   .. py:method:: make_metadata_card_from_url(url: str) -> EducationResource

      This method is a placeholder for creating a metadata card.
      It currently does not implement any functionality.



   .. py:method:: make_metadata_card_from_json(json_payload: str) -> EducationResource

      This method is a placeholder for creating a metadata card from JSON.
      It currently does not implement any functionality.