Metadata-Version: 2.1
Name: oarepo-invenio-model
Version: 2.0.2
Summary: Invenio data model for OARepo
Home-page: https://github.com/oarepo/invenio_oarepo_invenio_model
Author: Miroslav Simek
Author-email: miroslav.simek@vscht.cz
License: MIT
Description: OARepo Invenio data model
        =========================
        
        [![image][]][1]
        [![image][2]][3]
        [![image][4]][5]
        [![image][6]][7]
        
        Invenio base record model.
        
        Instalation
        ----------
        ```bash
            pip install oarepo-invenio-model
        ```
        Usage
        -----
        The library provides extensible Invenio base record model.
        
        JSON Schema
        -----------
        Add this package to your dependencies and use it via $ref in json
        schema.
        
        ### Usage example
        ```json
        {
          "type": "object",
          "allOf": [
            {
              "properties": {
                "title": {
                  "type": "string"
                }
              }
            },
            {
              "$ref": "/schemas/invenio-v1.0.0.json#/definitions/InvenioRecord"
            }
          ],
          "additionalProperties": "false"
        }
        ```
        Elastic Search Mapping
        ----------------------
        Use `oarepo-mapping-includes` library for extanding invenio base record model mapping.
        ### Usage example
        ```json
        {
          "mappings": {
            "dynamic": "strict",
            "oarepo:extends": "invenio-v1.0.0.json#/InvenioRecord",
            "properties": {
                 "title": {
                "type": "text"
              }
            }
          }
        }
        ```
         
        Marshmallow
        -----------
        You can extense your schema with Invenio base model schema by inheriting from `InvenioRecordMetadataSchemaV1Mixin`.
        ### Usage example
        ```python
        class SampleSchemaV1(InvenioRecordMetadataSchemaV1Mixin):
            title = fields.String(validate=validate.Length(min=5), required=True)
        ```
          [image]: https://img.shields.io/github/license/oarepo/oarepo-invenio-model.svg
          [1]: https://github.com/oarepo/oarepo-invenio-model/blob/master/LICENSE
          [2]: https://img.shields.io/travis/oarepo/oarepo-invenio-model.svg
          [3]: https://travis-ci.org/oarepo/oarepo-invenio-model
          [4]: https://img.shields.io/coveralls/oarepo/oarepo-invenio-model.svg
          [5]: https://coveralls.io/r/oarepo/oarepo-invenio-model
          [6]: https://img.shields.io/pypi/v/oarepo-invenio-model.svg
          [7]: https://pypi.org/pypi/oarepo-invenio-model
        
        Changes
        =======
        
        \[Version 2.0.0\]
        =================
        
        > -   Update schemas, mappings and marshmallow to latest records rest
        >     schemas
        > -   Switch record id type from string to PersistentIdentifier
        
        \[Version 1.1.0\]
        =================
        
        > -   Export Invenio ES mappings
        
        Invenio base record model.
        
        
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
Provides-Extra: tests
Provides-Extra: validate
