# OAPEN Books
## 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 OAPEN Library metadata.

This plugin defines one or more:

* `mimetypes` so that OAPEN json data can be stored as enclosures in InterNetNews (INN) articles.
* `newsgroups` so OAPEN 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 OAPEN data into an OME EducationalResource.
* `oapen_models.py`: Generated by Pydantic tools to make it fast and reliable to import OAPEN metadata.
* `bulk_import.py`: Utilities to convert data directly from the OAPEN 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.oapen.book+json

**NEWSGROUPS:**

{'ome.oapen_books': 'Metadata from OAPEN Library open access books https://library.oapen.org'}
```text
server/plugins/oapen_books
├── __init__.py
├── bulk_import.py
├── oapen_item.json
├── oapen_models.py
├── oapen_python_books.json
├── plugin.py
└── README.md

1 directory, 7 files
```