Metadata-Version: 2.1
Name: techlib-nr-datasets-metadata
Version: 3.1.15
Summary: Czech National Repository datasets data model.
License: MIT
Keywords: Czech,Nation,Repository,Invenio,datasets
Author: Miroslav Bauer
Author-email: Miroslav.Bauer@cesnet.cz
Requires-Python: >=3.8,<4.0
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Dist: oarepo (>=3.3,<4.0)
Requires-Dist: oarepo-rdm-records (>=3.2.0,<4.0.0)
Description-Content-Type: text/markdown

# nr-datasets-metadata

[![Build Status](https://travis-ci.org/Narodni-repozitar/nr-datasets.svg?branch=master)](https://travis-ci.org/Narodni-repozitar/nr-datasets)
[![Coverage Status](https://coveralls.io/repos/github/Narodni-repozitar/nr-datasets/badge.svg?branch=master)](https://coveralls.io/github/Narodni-repozitar/nr-datasets?branch=master)


Disclaimer: The library is part of the Czech National Repository, and therefore the README is written in Czech.
General libraries extending [Invenio](https://github.com/inveniosoftware) are concentrated under the [Oarepo
 namespace](https://github.com/oarepo).

  ## Instalace

 Nejedná se o samostatně funkční knihovnu, proto potřebuje běžící Invenio a závislosti Oarepo.
 Knihovna se instaluje ze zdroje.

 ```bash
git clone git@github.com:Narodni-repozitar/nr-datasets-metadata.git
cd nr-datasets-metadata
pip install poetry
poetry install
```

Pro testování a/nebo samostané fungování knihovny je nutné instalovat tests z extras.

```bash
poetry install --extras tests
```

:warning: Pro instalaci se používá Manažer závilostí **Poetry** více infromací lze naleznout v
[dokumentaci](https://python-poetry.org/docs/)

## Účel

Knihovna rozšiřuje [obecný metadatový model](https://github.com/Narodni-repozitar/nr-common)
o pole pro datasetové záznamy. Datasetům je přiřazen endpoint **/datasets**. Knihovna
poskytuje API pro CRUD operace pod proxy **nr_datasets**.

## Použití

Bude dopsáno.

