Iridium

The metal Iridium is used to refine and enhance metal alloys. Similarly, this package provides an enhanced Python coating around the InvenioRDM APIs.

It provides:

• a lower-level Python API wrapping the public InvenioRDM backend APIs
• a higher-level object-oriented convenience API (in progress)

Currently only the Vocabulary and Draft/Record APIs are supported.

Other APIs (such as Communities and Requests APIs) might follow when there is interest and the REST APIs are stabilized.

Getting Started

Probably you are interested in the high-level API. For this, read the tutorial.

It is not advised to use the low-level API directly, unless you are an InvenioRDM expert. The low-level API documentation is minimal and located here.

Development

This project uses Poetry for dependency management. So you will need to have poetry installed. Then you can run the following lines (maybe adapted to your operating system). It will clone this repository and run a poetry install.

$ git clone https://github.com/Materials-Data-Science-and-Informatics/iridium.git
$ cd iridium
$ poetry install

Run pre-commit install (see https://pre-commit.com) after cloning. This enables pre-commit to enforce the required linting hooks.

Run pytest (see https://docs.pytest.org) before merging your changes to make sure you did not break anything. To check coverage, use pytest --cov.

To generate documentation, run pdoc --html -o docs iridium (see https://pdoc.dev).

Acknowledgements

  

This project was developed at the Institute for Materials Data Science and Informatics (IAS-9) of the Jülich Research Center and funded by the Helmholtz Metadata Collaboration (HMC), an incubator-platform of the Helmholtz Association within the framework of the Information and Data Science strategic initiative.