# World Historical Gazetteer
## 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 World Historical Gazetteer (WHG) metadata.

This plugin defines one or more:

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

**NEWSGROUPS:**

{'ome.whg': 'Metadata from World Historical Gazetteer (WHG) https://whgazetteer.org'}
```text
server/plugins/whg
├── __init__.py
├── bulk_import.py
├── plugin.py
├── README.md
├── whg_article.eml
├── whg_item.json
├── whg_models.py
├── whg_ome_item.json
└── whg.json

1 directory, 9 files
```