# OER Commons
## Open Metadata Exchange (OME) plugin

An OME plugin defines how to import and publish metadata from an Open Education Resources system.

`plugin.py` provides the class that enables OME to understand OER Commons metadata.

This plugin defines one or more:

* `mimetypes` so that OER Commons json data can be stored as enclosures in InterNetNews (INN) articles.
* `newsgroups` so OER Commons metadata can be published to and subscribed from those INN newsgroups.

The plugin is composed of at least three code files.

* `plugin.py`: Defines `mimetypes`, `newsgroups`, and a `make_metadata_card()` function that translates OER Commons data into an OME EducationalResource.
* `oercommons_models.py`: Generated by Pydantic tools to make it fast and reliable to import OER Commons metadata.
* `bulk_import.py`: Utilities to convert data directly from the OER Commons API into OME EducationalResources.

> [!NOTE]
>
> Please ***do NOT edit*** this line and below because when the docs are rebuilt, these lines will be overwritten by scripts/sync_plugin_docs.py.

**MIMETYPES:**
1. application/vnd.oercommons.oer-commons+json

**NEWSGROUPS:**

{'ome.oercommons': "Metadata from ISKME's OER Commons https://oercommons.org"}
```text
server/plugins/oercommons
├── __init__.py
├── bulk_import.py
├── oercommons_article.eml
├── oercommons_item.json
├── oercommons_models.py
├── oercommons_ome_item.json
├── oercommons.json
├── plugin.py
└── README.md

1 directory, 9 files
```