Metadata-Version: 2.1
Name: oarepo-rdm-records
Version: 3.2.1
Summary: OARepo rdm records data model
Home-page: https://github.com/oarepo/oarepo-rdm-records
Author: Alzbeta Pokorna
Author-email: alzbeta.pokorna@cesnet.cz
License: MIT
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Development Status :: 4 - Beta
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pycountry
Requires-Dist: oarepo-mapping-includes
Requires-Dist: oarepo-invenio-model
Requires-Dist: oarepo-validate
Requires-Dist: idutils
Requires-Dist: edtf
Requires-Dist: oarepo-multilingual
Requires-Dist: marshmallow-utils (>=0.4.0)
Requires-Dist: oarepo-taxonomies
Provides-Extra: tests
Requires-Dist: pydocstyle ; extra == 'tests'
Requires-Dist: oarepo[tests] (~=3.3.0) ; extra == 'tests'

OARepo rdm records model
====================
[![image][]][1]
[![image][2]][3]
[![image][4]][5]
[![image][6]][7]

Instalation
----------
```bash
    pip install oarepo-rdm-records
```
Usage
-----
The library provides a modified [InvenioRDMRecords](https://github.com/inveniosoftware/invenio-rdm-records.git) data
model for OARepo resource records. 

JSON Schema
----------
Add this package to your dependencies and use it via $ref in json
schema as ``"[server]/dataset-v2.0.0.json#/definitions/DataSet"``. 
Elastic Search mapping is handled automatically via Eleastic Search templates.

### Usage example
```json
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "allOf": [
    {
      "$ref": "dataset-v2.0.0.json#/definitions/DataSet"
    }
  ]
}
```

```json
{
  "type": "object",
  "properties": {
    "these": {
        "titles" : {"cs": "neco", "en": "something"}
        }
  }
}
```

Modified fields of data model
-----------------------------
##### titles
- fully required oarepo multilingual data type
##### descriptions
- fully optional oarepo multilingual data type
##### subjects
- ```subject``` is required oarepo multilingual data type
##### locations
- ```description``` is optional oarepo multilingual data type
##### licenses
- ```license``` is required oarepo multilingual data type

 [image]: https://img.shields.io/travis/oarepo/oarepo-rdm-records.svg
  [1]: https://travis-ci.org/oarepo/oarepo-rdm-records
  [2]: https://img.shields.io/coveralls/oarepo/oarepo-rdm-records.svg
  [3]: https://coveralls.io/r/oarepo/oarepo-rdm-records
  [4]: https://img.shields.io/github/license/oarepo/oarepo-rdm-records.svg
  [5]: https://github.com/oarepo/oarepo-rdm-records/blob/master/LICENSE
  [6]: https://img.shields.io/pypi/v/oarepo-rdm-records.svg
  [7]: https://pypi.org/pypi/oarepo-rdm-records

<!--
Copyright (C) 2020 CESNET z.s.p.o.

oarepo-rdm-records is free software; you can redistribute it and/or modify it
under the terms of the MIT License; see LICENSE file for more details.
-->

# Changes

## Version 2.0.0 (released 2020-08-25)

- Initial public release.

# Version 3.1.6
Metadata field "Identifiers" now has all properties set as optional and new property "status" was added (for DOI request purposes).

