NRP Invenio Documentation

https://nrp-cz.github.io/docs
Admin
NRP Invenio Documentation provides comprehensive guidance for deploying, configuring, customizing,...
Tokens:164,488
Snippets:1,772
Trust Score:8.3
Update:5 months ago
Show doc for...
Tokens:
Raw
### Setup Docker Services

Source: https://nrp-cz.github.io/docs/installation/run_script

Starts service containers for the first time and initializes the database schema, search indices, and fixture data. Use -N to skip demo data or -f to force reinitialization.

```bash
./run.sh services setup
```

```bash
./run.sh services setup -N
```

```bash
./run.sh services setup --force
```

--------------------------------

### Basic NRP Sync Client Example

Source: https://nrp-cz.github.io/docs/userguide/python_library/sync_library

Demonstrates basic usage of the sync client: getting a client, creating a record, uploading a file, and publishing the record.

```python
from nrp_cmd.sync_client import get_sync_client

# Get a client for a repository
client = get_sync_client("https://your-repository.org")

# Create a new record
record = client.records.create({
    "metadata": {
        "title": "My First Record",
        "creators": [{"name": "John Doe"}],
        "resourceType": {"id": "dataset"}
    }
})

print(f"Created record: {record.id}")

# Upload a file
file = client.files.upload(
    record,
    key="data.csv",
    metadata={"description": "My data file"},
    source="path/to/data.csv"
)

print(f"Uploaded file: {file.key}")

# Publish the record
published = client.records.publish(record)
print(f"Published record: {published.id}")

```

--------------------------------

### Run Repository Installer

Source: https://nrp-cz.github.io/docs/installation/create_instance

Execute the downloaded installer script to create a new repository. The script will prompt for the repository name, description, and languages.

```bash
bash repository_installer.sh instruments
```

--------------------------------

### OArepo-app Compatibility Example

Source: https://nrp-cz.github.io/docs/deploy/release_management

This compatibility matrix entry shows the relationship between `oarepo-app`, `oarepo`, and `invenio-app-rdm` versions, along with suggested dependency ranges for a stable setup.

```text
1.0.0| 14.2.1b9.dev0| 14.0.0b9.dev0| `oarepo[s3,rdm]>=14.0.0,<15.0.0`  
| | | `oarepo-app[production]>=1.0.0,<2.0.0`  
| | | `python>=3.14,<3.15`  
```

--------------------------------

### Verify Docker Installation

Source: https://nrp-cz.github.io/docs/installation

Tests the Docker installation by running a simple 'hello-world' container.

```bash
docker run hello-world
```

```text
Hello from Docker!
```

--------------------------------

### Install backend and frontend dependencies

Source: https://nrp-cz.github.io/docs/installation/run_instance

Install all required Python and NPM dependencies, and build frontend assets. This can take a significant amount of time on the first run.

```bash
./run.sh install
```

--------------------------------

### Install NRP Command Line Tool

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library

Install the nrp-cmd package using pip. This is a prerequisite for using the async client library.

```bash
pip install nrp-cmd

```

--------------------------------

### Create Record Example with Output

Source: https://nrp-cz.github.io/docs/userguide/commandline

Example of creating a record with metadata provided as a JSON string. The output shows the created record's details, including its ID, schema, and links. Errors are reported if required fields are missing.

```bash
# nrp-cmd create record documents '{"metadata":{"title": "blah"}}' --set blah
```

```yaml
id: z2rrt-pz252
$schema: local://documents-1.0.0.json
created: '2024-03-14T13:30:01.133502+00:00'
errors:
- field: metadata.creators
  messages:
  - Missing data for required field.
- field: metadata.resourceType
  messages:
  - Missing data for required field.
files:
  enabled: true
links:
  draft: https://127.0.0.1:5000/api/docs/z2rrt-pz252/draft
  # more links here ...
parent:
  id: rcpyq-rx266
request_types:
- type_id: publish_draft
  links:
    actions:
      create: https://127.0.0.1:5000/api/requests
revision_id: 3
updated: '2024-03-14T13:30:01.154516+00:00'
metadata:
  title: blah
```

--------------------------------

### Search Records Example

Source: https://nrp-cz.github.io/docs/userguide/commandline

Example of searching records for a specific title and storing the results.

```bash
nrp-cmd search records "metadata.title:mytitle" --set mytitle_ids
```

--------------------------------

### Initialize Sync Client

Source: https://nrp-cz.github.io/docs/userguide/python_library/sync_library

Get a sync client instance for a given repository URL.

```python
client = get_sync_client(repository)

```

--------------------------------

### Start Docker Services

Source: https://nrp-cz.github.io/docs/installation/run_script

Starts the service containers without reinitialising them, preserving all existing data.

```bash
./run.sh services start
```

--------------------------------

### Install nrp-cmd using pip and virtualenv

Source: https://nrp-cz.github.io/docs/userguide/commandline

Instructions for installing the nrp-cmd tool using Python's virtual environment and pip. Includes creating an alias for convenience.

```bash
python3 -m venv nrp-cmd
source nrp-cmd/bin/activate
pip install nrp-cmd

```

```bash
alias nrp-cmd="<path-to-nrp-cmd>/bin/nrp-cmd"
# or
alias nrp-cmd="uvx nrp-cmd"

```

--------------------------------

### Run Repository

Source: https://nrp-cz.github.io/docs/installation/run_script

Starts Docker services, a Celery worker, and the Flask/uWSGI development server. Available at https://127.0.0.1:5000/. Use --no-services to skip starting containers or --no-celery to skip the Celery worker.

```bash
./run.sh run
```

```bash
# Start only the web server (services and Celery already running elsewhere)
./run.sh run --no-services --no-celery
```

--------------------------------

### Install NRP Command-Line Tool

Source: https://nrp-cz.github.io/docs/userguide/python_library

Install the nrp-cmd package using pip. This is recommended for interactive command-line use.

```bash
pip install nrp-cmd
```

--------------------------------

### Complete Request Lifecycle Example

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_requests

Demonstrates the full lifecycle of a request, from creation to submission and monitoring. Requires the client object to be initialized.

```python
async def complete_request_lifecycle():
    """Demonstrate complete request lifecycle."""
    # 1. Create draft record
    draft = await client.records.create({
        "metadata": {
            "title": "Request Lifecycle Demo",
            "creators": [{"person_or_org": {"name": "Demo User"}}],
            "resource_type": {"id": "dataset"}
        }
    })
    print(f"✓ Created draft: {draft.id}")
    
    # 2. Check applicable requests
    request_types = await client.requests.applicable_requests(draft)
    print(f"✓ Available request types: {len(request_types.hits)}")
    
    # 3. Create publish request
    publish_type = next(
        rt for rt in request_types.hits 
        if rt.type_id == "publish_draft"
    )
    request = await client.requests.create(
        publish_type,
        payload={"message": "Ready for publication"}
    )
    print(f"✓ Created request: {request.id} (status: {request.status})")
    
    # 4. Submit request
    submitted = await client.requests.submit(request)
    print(f"✓ Submitted request (status: {submitted.status})")
    
    # 5. List requests for this record
    record_requests = await client.requests.all(topic=draft)
    print(f"✓ Record has {len(record_requests.hits.hits)} request(s)")
    
    # 6. Curator accepts (if you have permission)
    # accepted = await client.requests.accept(submitted)
    # print(f"✓ Accepted request (status: {accepted.status})")
    
    return request
 
# Run the demo
request = await complete_request_lifecycle()
```

--------------------------------

### Initialize Sync Client

Source: https://nrp-cz.github.io/docs/userguide/python_library/sync_library_records

Get an instance of the sync client for interacting with the NRP repository. Replace 'https://your-repository.org' with your actual repository URL.

```python
from nrp_cmd.sync_client import get_sync_client

client = get_sync_client("https://your-repository.org")
records_client = client.records
```

--------------------------------

### Vocabulary file example (names.yaml)

Source: https://nrp-cz.github.io/docs/customize/vocabularies/initial_data

An example of a names.yaml file containing vocabulary records with affiliations, names, and ORCID identifiers.

```yaml
# app_data/vocabularies/names.yaml
- affiliations:
  - name: Northwestern University
  family_name: Riesbeck
  given_name: Christopher
  id: 0000-0001-7673-1000
  identifiers:
  - identifier: 0000-0001-7673-1000
    scheme: orcid
- affiliations:
  - name: Helmholtz-Zentrum Dresden-Rossendorf
  family_name: Hauser
  given_name: Sandra
  id: 0000-0001-8206-6000
  identifiers:
  - identifier: 0000-0001-8206-6000
    scheme: orcid
```

--------------------------------

### Check repository prerequisites

Source: https://nrp-cz.github.io/docs/installation/run_instance

Verify that all necessary software and versions are installed and configured correctly for the repository.

```bash
./run.sh cli check-requirements -d
```

--------------------------------

### JinjaX Component Syntax Example

Source: https://nrp-cz.github.io/docs/customize/repository_ui/templating/jinjax

Shows the equivalent JinjaX component syntax for the traditional Jinja macro example. JinjaX uses a declarative, HTML-like tag syntax for components.

```jinja
{#def products, msg="World!" #} 

<Layout title="My title">
  <div>
    <h2>Hello, {{ msg }}</h2>
    <div>
      <Card title="So clean">
        {% for product in products %}
          <Product product="product" />
        {% endfor %}
      </Card>
    </div>
  </div>
  <Paginator items="products" />
</Layout>
```

--------------------------------

### Importing Components from Installed Packages

Source: https://nrp-cz.github.io/docs/customize/repository_ui/js_assets/react/components

Demonstrates how to import React components from installed packages using the `@js/` prefix, based on the webpack aliases.

```javascript
import { RecordAuthors } from "@js/invenio_app_rdm";
import { SearchBar } from "@js/oarepo_ui/search";
```

--------------------------------

### Initialize Async Client

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_records

Get an asynchronous client instance for interacting with the NRP repository. Ensure the repository URL is correct.

```python
from nrp_cmd.async_client import get_async_client

client = await get_async_client("https://your-repository.org")
records_client = client.records
```

--------------------------------

### Clone the repository

Source: https://nrp-cz.github.io/docs/installation/run_instance

Clone the repository to your local machine before proceeding with the setup.

```bash
git clone <repository-url>
cd <repository-name>
```

--------------------------------

### Download Repository Installer Script

Source: https://nrp-cz.github.io/docs/installation/create_instance

Download the `repository_installer.sh` script from the specified URL using curl.

```bash
curl -o repository_installer.sh \
    https://raw.githubusercontent.com/oarepo/oarepo/refs/heads/main/tools/repository_installer.sh
```

--------------------------------

### Install npm Packages

Source: https://nrp-cz.github.io/docs/customize/repository_ui/webpack

Command to run after modifying npm dependencies in the webpack configuration to install the specified packages.

```bash
invenio webpack install
```

--------------------------------

### Get Async Client Instance

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library

Instantiate the async client for a given repository URL. This is the primary entry point for interacting with the repository.

```python
client = await get_async_client(repository)

```

--------------------------------

### Request Lifecycle Example

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_requests

Demonstrates the complete lifecycle of a request, from creation to submission and monitoring.

```APIDOC
## Request Lifecycle Example
```python
async def complete_request_lifecycle():
    """Demonstrate complete request lifecycle."""
    # 1. Create draft record
    draft = await client.records.create({
        "metadata": {
            "title": "Request Lifecycle Demo",
            "creators": [{"person_or_org": {"name": "Demo User"}}],
            "resource_type": {"id": "dataset"}
        }
    })
    print(f"✓ Created draft: {draft.id}")
    
    # 2. Check applicable requests
    request_types = await client.requests.applicable_requests(draft)
    print(f"✓ Available request types: {len(request_types.hits)}")
    
    # 3. Create publish request
    publish_type = next(
        rt for rt in request_types.hits 
        if rt.type_id == "publish_draft"
    )
    request = await client.requests.create(
        publish_type,
        payload={"message": "Ready for publication"}
    )
    print(f"✓ Created request: {request.id} (status: {request.status})")
    
    # 4. Submit request
    submitted = await client.requests.submit(request)
    print(f"✓ Submitted request (status: {submitted.status})")
    
    # 5. List requests for this record
    record_requests = await client.requests.all(topic=draft)
    print(f"✓ Record has {len(record_requests.hits.hits)} request(s)")
    
    # 6. Curator accepts (if you have permission)
    # accepted = await client.requests.accept(submitted)
    # print(f"✓ Accepted request (status: {accepted.status})")
    
    return request
 
# Run the demo
request = await complete_request_lifecycle()
```
```

--------------------------------

### Request Lifecycle Example

Source: https://nrp-cz.github.io/docs/userguide/python_library/sync_library_requests

Demonstrates the complete lifecycle of a request, from creation to submission and monitoring.

```APIDOC
## Request Lifecycle Example

```python
def complete_request_lifecycle():
    """Demonstrate complete request lifecycle."""
    # 1. Create draft record
    draft = client.records.create({
        "metadata": {
            "title": "Request Lifecycle Demo",
            "creators": [{"person_or_org": {"name": "Demo User"}}],
            "resource_type": {"id": "dataset"}
        }
    })
    print(f"✓ Created draft: {draft.id}")
    
    # 2. Check applicable requests
    request_types = client.requests.applicable_requests(draft)
    print(f"✓ Available request types: {len(request_types.hits)}")
    
    # 3. Create publish request
    publish_type = next(
        rt for rt in request_types.hits 
        if rt.type_id == "publish_draft"
    )
    request = client.requests.create(
        publish_type,
        payload={"message": "Ready for publication"}
    )
    print(f"✓ Created request: {request.id} (status: {request.status})")
    
    # 4. Submit request
    submitted = client.requests.submit(request)
    print(f"✓ Submitted request (status: {submitted.status})")
    
    # 5. List requests for this record
    record_requests = client.requests.all(topic=draft)
    print(f"✓ Record has {len(record_requests.hits.hits)} request(s)")
    
    # 6. Curator accepts (if you have permission)
    # accepted = client.requests.accept(submitted)
    # print(f"✓ Accepted request (status: {accepted.status})")
    
    return request
 
# Run the demo
request = complete_request_lifecycle()
```
```

--------------------------------

### Catalogue file example

Source: https://nrp-cz.github.io/docs/customize/vocabularies/initial_data

Defines the vocabularies to be imported, their types, and their data file locations relative to the app_data folder.

```yaml
languages:
  pid-type: v-lng
  data-file: vocabularies/languages.yaml
names:
  pid-type: names
  data-file: vocabularies/names.yaml
```

--------------------------------

### Start draft file upload

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Start one or more draft file uploads by sending a `POST` request to the URL in `draft.links.files`. The response contains per-file links for subsequent steps.

```APIDOC
## Start draft file upload

### Description
Start one or more draft file uploads by sending a `POST` request to the URL in `draft.links.files`. The response contains per-file links for subsequent steps.

### Method
POST

### Endpoint
https://example.org/api/mymodel/abcde-12345/draft/files

### Request Body
An array of objects, where each object specifies a file to upload.
- **key** (string) - The name of the file.

### Request Example
```json
{
  "links": {
    "files": "https://example.org/api/mymodel/abcde-12345/draft/files"
  }
}
```

Then send:
```json
[
  {"key": "article.pdf"},
  {"key": "data.zip"}
]
```
```

--------------------------------

### Verify Git Version

Source: https://nrp-cz.github.io/docs/installation

Ensures that Git is installed and checks its version.

```bash
git --version
```

```text
git version 2.50.1
```

--------------------------------

### Run Invenio Shell

Source: https://nrp-cz.github.io/docs/customize/repository_ui/menus

Use this command to start the Invenio shell for interactive use.

```bash
./run.sh invenio shell
```

--------------------------------

### Create, Upload, Publish Workflow

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_records

A complete workflow example demonstrating how to create a draft record, upload a file, and then publish the record.

```APIDOC
### Create, Upload, Publish

```python
# Complete workflow
async def create_and_publish_dataset(title, data_file):
    # 1. Create draft
    draft = await client.records.create({
        "metadata": {
            "title": title,
            "creators": [{"person_or_org": {"name": "Researcher"}}],
            "resource_type": {"id": "dataset"},
            "publication_date": "2024-01-15"
        }
    })
    
    # 2. Upload data file
    file = await client.files.upload(
        draft,
        key=data_file.name,
        metadata={"description": "Dataset file"},
        source=data_file,
        progress=f"Uploading {data_file.name}"
    )
    
    # 3. Publish
    published = await client.records.publish(draft)
    
    return published
 
# Use it
published = await create_and_publish_dataset(
    "Climate Data 2024",
    "climate_data.csv"
)
print(f"Published at: {published.links.self_html}")
```
```

--------------------------------

### Set up database and services

Source: https://nrp-cz.github.io/docs/installation/run_instance

Perform the initial setup for the database and other required services. Use the `-N` option to skip adding demo data.

```bash
# the -N option is to skip adding demo data (in most cases you want that)
./run.sh services setup -N
```

--------------------------------

### Install oarepo-doi Package

Source: https://nrp-cz.github.io/docs/customize/oarepo_doi

Install the oarepo-doi package using pip. This is typically done as part of an OARepo 14 based application setup.

```bash
pip install oarepo-doi
```

--------------------------------

### Run the repository instance

Source: https://nrp-cz.github.io/docs/installation/run_instance

Start the repository, including background services like the database and search engine, as well as background tasks. The repository will be fully operational after pending tasks are processed.

```bash
./run.sh run
```

--------------------------------

### Get Draft Record Example

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Retrieve a draft record by sending a GET request to `/api/records/{id}/draft`. The returned metadata may use a schema different from the default RDM schema.

```json
{
  "id": "abcde-12345",
  "links": {
    "self": "https://example.org/api/mymodel/abcde-12345/draft"
  },
  "metadata": {
    "title": "Example record"
  }
}
```

--------------------------------

### Initialize Translation Catalog

Source: https://nrp-cz.github.io/docs/customize/repository_ui/i18n

Initializes translation catalogs for specified languages. Use this for new languages or initial setup.

```bash
./run.sh cli translations init -l cs
```

```bash
./run.sh cli translations init -l de
```

--------------------------------

### Scan All Records (YAML Output - Example)

Source: https://nrp-cz.github.io/docs/userguide/commandline

Scan all records and output them as a list of YAML documents, separated by '---'.

```yaml
id: 1
...
---
id: 2
...
```

--------------------------------

### Configure Invenio.cfg File

Source: https://nrp-cz.github.io/docs/customize/configure

Example of an invenio.cfg file demonstrating the use of configuration helpers for localization, UI settings, cron jobs, and statistics. It also shows how to set environment variables and register custom models.

```python
# invenio.cfg
from invenio_i18n import lazy_gettext as _
from oarepo import config

# localization / internationalization
config.initialize_i18n()

config.configure_generic_parameters()

config.configure_ui(
    code="myrepo",
    name=_("My NRP Repository"),
    description=_("My NRP-based repository for research data."),
)

config.configure_cron()
config.configure_stats()

import os
os.environ["DYLD_FALLBACK_LIBRARY_PATH"]="/opt/homebrew/lib"

# datasets model registration
from mymodel import mymodel_model

mymodel_model.register()
DASHBOARD_RECORD_CREATE_URL = "/mymodel/uploads/new"

```

--------------------------------

### Get a record

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Get a published record by sending `GET /api/records/{id}`. The main difference from InvenioRDM is that `metadata` may follow a repository-specific schema.

```APIDOC
## Get a record

### Description
Get a published record by sending `GET /api/records/{id}`. The main difference from InvenioRDM is that `metadata` may follow a repository-specific schema.

### Method
GET

### Endpoint
/api/records/{id}

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the record.
- **links** (object) - Links related to the record.
  - **self** (string) - URL to the record.
- **metadata** (object) - The metadata of the record, potentially using a repository-specific schema.

### Response Example
```json
{
  "id": "abcde-12345",
  "links": {
    "self": "https://example.org/api/mymodel/abcde-12345"
  },
  "metadata": {
    "title": "Published example record"
  }
}
```
```

--------------------------------

### Get latest version

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Get the latest version by sending a `GET` request to the `links.latest` URL returned for the record. The returned record uses the metadata schema of its model.

```APIDOC
## Get latest version

### Description
Get the latest version by sending a `GET` request to the `links.latest` URL returned for the record. The returned record uses the metadata schema of its model.

### Method
GET

### Endpoint
https://example.org/api/models/abcde-12345/versions/latest

### Response
#### Success Response (200)
- **id** (string) - The unique identifier of the record.
- **metadata** (object) - The metadata of the record.
  - **title** (string) - The title of the record.

### Response Example
```json
{
  "links": {
    "latest": "https://example.org/api/models/abcde-12345/versions/latest"
  }
}
```

Then a request to that URL returns:
```json
{
  "id": "abcde-12345",
  "metadata": {
    "title": "Latest published example record"
  }
}
```
```

--------------------------------

### Basic Async Client Usage

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library

Demonstrates creating a client, creating a record, uploading a file, and publishing the record using the async client library. Ensure you replace placeholder URLs and file paths with your actual values.

```python
import asyncio
from nrp_cmd.async_client import get_async_client

async def main():
    # Get a client for a repository
    client = await get_async_client("https://your-repository.org")
    
    # Create a new record
    record = await client.records.create({
        "metadata": {
            "title": "My First Record",
            "creators": [{"name": "John Doe"}],
            "resourceType": {"id": "dataset"}
        }
    })
    
    print(f"Created record: {record.id}")
    
    # Upload a file
    file = await client.files.upload(
        record,
        key="data.csv",
        metadata={"description": "My data file"},
        source="path/to/data.csv"
    )
    
    print(f"Uploaded file: {file.key}")
    
    # Publish the record
    published = await client.records.publish(record)
    print(f"Published record: {published.id}")

# Run the async function
asyncio.run(main())

```

--------------------------------

### Vocabulary file example (languages.yaml)

Source: https://nrp-cz.github.io/docs/customize/vocabularies/initial_data

Contains the actual vocabulary records, including IDs, properties, tags, and titles in different languages.

```yaml
# located at app_data/vocabularies/languages.yaml
- id: eng
  props:
    alpha_2: en
  tags:
  - individual
  - living
  title:
    en: English
- id: ces
  props:
    alpha_2: cs
  tags:
  - individual
  - living
  title:
    en: Czech
```

--------------------------------

### Initialize Sync Client

Source: https://nrp-cz.github.io/docs/userguide/python_library/sync_library_files

Instantiate the sync client for interacting with the repository. Ensure you replace 'https://your-repository.org' with your actual repository URL.

```python
from nrp_cmd.sync_client import get_sync_client

client = get_sync_client("https://your-repository.org")
files_client = client.files
```

--------------------------------

### Verify uv Version

Source: https://nrp-cz.github.io/docs/installation

Checks the installed version of uv, a Python package installer.

```bash
uv --version
```

```text
uv 0.8.18
```

--------------------------------

### Verify Python Version

Source: https://nrp-cz.github.io/docs/installation

Checks if the installed Python version is 3.14 or higher, as required for the installation.

```bash
python --version
```

```text
Python 3.14.3
```

--------------------------------

### Get a draft record

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Retrieve a draft record by sending a GET request to `/api/records/{id}/draft`.

```APIDOC
## GET /api/records/{id}/draft

### Description
Retrieves a specific draft record identified by its ID.

### Method
GET

### Endpoint
`/api/records/{id}/draft`

### Parameters
#### Path Parameters
- **id** (string) - Required - The unique identifier of the draft record.

### Response
#### Success Response (200)
- **id** (string) - The ID of the draft record.
- **links** (object) - Links related to the draft record.
  - **self** (string) - URL to the draft record.
- **metadata** (object) - The metadata of the draft record, conforming to its schema.
```

--------------------------------

### React Entry Point for Welcome Banner

Source: https://nrp-cz.github.io/docs/customize/repository_ui/webpack

Example of a React entry point file that renders a WelcomeBanner component into a specific DOM element. Ensure the DOM element with the ID 'welcome-banner' exists.

```javascript
import ReactDOM from "react-dom";
import { WelcomeBanner } from "./WelcomeBanner";

function renderWelcomeBanner() {
  const element = document.getElementById("welcome-banner");
  if (element) {
    ReactDOM.render(<WelcomeBanner />, element);
  }
}

renderWelcomeBanner();
```

--------------------------------

### Search Results Example

Source: https://nrp-cz.github.io/docs/userguide/commandline

Example structure of search results, including record IDs, links, and metadata.

```yaml
hits:
- id: 1
  links:
    self: https://myserver.cesnet.cz/api/datasets/1
    self_html: https://myserver.cesnet.cz/datasets/1
  metadata:
    title: My dataset
- id: 2
  ...
total: 100
links:
  self: ...
  next: ...
  prev: ...
```

--------------------------------

### Complete Request Lifecycle Example

Source: https://nrp-cz.github.io/docs/userguide/python_library/sync_library_requests

Demonstrates the full lifecycle of a request, from creating a draft record to submitting and listing requests. Ensure you have the necessary permissions to execute all steps.

```python
def complete_request_lifecycle():
    """Demonstrate complete request lifecycle."""
    # 1. Create draft record
    draft = client.records.create({
        "metadata": {
            "title": "Request Lifecycle Demo",
            "creators": [{"person_or_org": {"name": "Demo User"}}],
            "resource_type": {"id": "dataset"}
        }
    })
    print(f"✓ Created draft: {draft.id}")
    
    # 2. Check applicable requests
    request_types = client.requests.applicable_requests(draft)
    print(f"✓ Available request types: {len(request_types.hits)}")
    
    # 3. Create publish request
    publish_type = next(
        rt for rt in request_types.hits 
        if rt.type_id == "publish_draft"
    )
    request = client.requests.create(
        publish_type,
        payload={"message": "Ready for publication"}
    )
    print(f"✓ Created request: {request.id} (status: {request.status})")
    
    # 4. Submit request
    submitted = client.requests.submit(request)
    print(f"✓ Submitted request (status: {submitted.status})")
    
    # 5. List requests for this record
    record_requests = client.requests.all(topic=draft)
    print(f"✓ Record has {len(record_requests.hits.hits)} request(s)")
    
    # 6. Curator accepts (if you have permission)
    # accepted = client.requests.accept(submitted)
    # print(f"✓ Accepted request (status: {accepted.status})")
    
    return request
 
# Run the demo
request = complete_request_lifecycle()
```

--------------------------------

### Get Published File Metadata

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Retrieve metadata for a published file by sending a GET request to its 'links.self' URL.

```json
{
  "key": "article.pdf",
  "links": {
    "self": "https://example.org/api/mymodel/abcde-12345/files/article.pdf"
  }
}
```

```http
GET https://example.org/api/mymodel/abcde-12345/files/article.pdf
```

--------------------------------

### Complete Workflow: Create, Upload, Publish Dataset

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_records

A comprehensive example demonstrating the creation of a draft record, uploading a data file, and then publishing the dataset.

```python
# Complete workflow
async def create_and_publish_dataset(title, data_file):
    # 1. Create draft
    draft = await client.records.create({
        "metadata": {
            "title": title,
            "creators": [{"person_or_org": {"name": "Researcher"}}],
            "resource_type": {"id": "dataset"},
            "publication_date": "2024-01-15"
        }
    })
    
    # 2. Upload data file
    file = await client.files.upload(
        draft,
        key=data_file.name,
        metadata={"description": "Dataset file"},
        source=data_file,
        progress=f"Uploading {data_file.name}"
    )
    
    # 3. Publish
    published = await client.records.publish(draft)
    
    return published
 
# Use it
published = await create_and_publish_dataset(
    "Climate Data 2024",
    "climate_data.csv"
)
print(f"Published at: {published.links.self_html}")
```

--------------------------------

### Get all versions

Source: https://nrp-cz.github.io/docs/userguide/api_docs

List all versions by sending a `GET` request to the URL in `links.versions` returned for the record. This works as in InvenioRDM.

```APIDOC
## Get all versions

### Description
List all versions by sending a `GET` request to the URL in `links.versions` returned for the record. This works as in InvenioRDM.

### Method
GET

### Endpoint
https://example.org/api/models/abcde-12345/versions

### Response
#### Success Response (200)
- **hits** (object) - Contains the version results.
  - **hits** (array) - An array of version objects.
    - **id** (string) - The unique identifier of the version.

### Response Example
```json
{
  "links": {
    "versions": "https://example.org/api/models/abcde-12345/versions"
  }
}
```

Then a request to that URL returns:
```json
{
  "hits": {
    "hits": [
      {
        "id": "abcde-12345"
      }
    ]
  }
}
```
```

--------------------------------

### Get Draft File Metadata

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Retrieve metadata for a specific draft file by sending a GET request to its 'links.self' URL.

```json
{
  "key": "article.pdf",
  "links": {
    "self": "https://example.org/api/mymodel/abcde-12345/draft/files/article.pdf"
  }
}
```

```http
GET https://example.org/api/mymodel/abcde-12345/draft/files/article.pdf
```

--------------------------------

### Initialize Async Client and Files API

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_files

Instantiate the asynchronous client and access the files API. Ensure you replace 'https://your-repository.org' with your actual repository URL.

```python
from nrp_cmd.async_client import get_async_client

client = await get_async_client("https://your-repository.org")
files_client = client.files
```

--------------------------------

### Download Record and All Associated Files

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_files

This example shows how to download a record's metadata and all its associated files to a specified directory. It creates a structured output directory for the record and its files.

```python
async def download_record_with_files(record_id, output_dir):
    """Download record metadata and all files."""
    from pathlib import Path
    import json
    
    # Create output directory
    output_path = Path(output_dir) / record_id
    output_path.mkdir(parents=True, exist_ok=True)
    
    # Get record (can be draft or published)
    record = await client.records.draft_records.read(record_id)
    
    # Save metadata
    metadata_file = output_path / "metadata.json"
    with open(metadata_file, 'w') as f:
        json.dump(record.metadata, f, indent=2)
    
    # Download files
    files = await client.files.list(record)
    files_dir = output_path / "files"
    files_dir.mkdir(exist_ok=True)
    
    for file in files:
        file_path = files_dir / file.key
        await client.files.download(
            file,
            str(file_path),
            progress=f"Downloading {file.key}"
        )
        
        # Also save file metadata
        file_meta_path = files_dir / f"{file.key}.metadata.json"
        with open(file_meta_path, 'w') as f:
            json.dump({
                "key": file.key,
                "size": file.size,
                "checksum": file.checksum,
                "mimetype": file.mimetype,
                "metadata": file.metadata
            }, f, indent=2)
    
    return output_path
 
# Use it
saved_to = await download_record_with_files(
    "abc-123",
    "/backups"
)
print(f"Downloaded to: {saved_to}")
```

--------------------------------

### Get a Published Record

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Retrieve a published record using a GET request to /api/records/{id}. Metadata schemas may vary.

```json
{
  "id": "abcde-12345",
  "links": {
    "self": "https://example.org/api/mymodel/abcde-12345"
  },
  "metadata": {
    "title": "Published example record"
  }
}
```

--------------------------------

### Create Record and Upload Multiple Files

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_files

A workflow example demonstrating how to create a new record, upload multiple files to it, and then publish the record. This is useful for batch uploads.

```python
async def create_record_with_files(title, file_paths):
    """Create record and upload multiple files."""
    # Create draft record
    draft = await client.records.create({
        "metadata": {
            "title": title,
            "creators": [{"person_or_org": {"name": "Researcher"}}],
            "resource_type": {"id": "dataset"}
        }
    })
    
    # Upload each file
    for path in file_paths:
        filename = Path(path).name
        await client.files.upload(
            draft,
            key=filename,
            metadata={"description": f"Data file: {filename}"},
            source=path,
            progress=f"Uploading {filename}"
        )
    
    # Publish the record
    published = await client.records.publish(draft)
    return published
 
# Use it
published = await create_record_with_files(
    "Research Dataset 2024",
    [
        "/data/experiment1.csv",
        "/data/experiment2.csv",
        "/data/README.txt"
    ]
)
```

--------------------------------

### Workflow Request Definition Example

Source: https://nrp-cz.github.io/docs/customize/workflows/workflows

An example of defining a workflow request type, specifying requesters and recipients for actions like publishing a draft.

```python
class DefaultWorkflowRequests(WorkflowRequestPolicy):
    publish_draft = WorkflowRequest(
        requesters=[
            RecordOwners(),
        ],
        recipients=[PrimaryCommunityRole("curator")],
        transitions=...,
        escalations=...,
    )
```

--------------------------------

### Initialize React App

Source: https://nrp-cz.github.io/docs/customize/repository_ui/js_assets

This snippet shows how to initialize a React application. It imports `ReactDOM` and your main `SearchApp` component, then renders it into the specified root element after the DOM is loaded.

```javascript
import ReactDOM from "react-dom";
import { SearchApp } from './SearchApp';

document.addEventListener('DOMContentLoaded', () => {
  const rootElement = document.getElementById('search-root');
  if (rootElement) {
    ReactDOM.render(<SearchApp />, rootElement);
  }
});
```

--------------------------------

### Change Directory and Check Prerequisites

Source: https://nrp-cz.github.io/docs/installation/create_instance

Navigate into the newly created repository directory and run the `check-requirements` command to verify all necessary prerequisites are met.

```bash
cd instruments
./run.sh cli check-requirements -d
```

--------------------------------

### Get All Versions of a Record

Source: https://nrp-cz.github.io/docs/userguide/api_docs

List all versions by sending a GET request to the record's links.versions URL. The response contains a list of version identifiers.

```json
{
  "links": {
    "versions": "https://example.org/api/models/abcde-12345/versions"
  }
}
```

```json
{
  "hits": {
    "hits": [
      {
        "id": "abcde-12345"
      }
    ]
  }
}
```

--------------------------------

### Initialize Async Client

Source: https://nrp-cz.github.io/docs/userguide/python_library/async_library_requests

Initialize the asynchronous client and access the requests client. Ensure you replace 'https://your-repository.org' with your actual repository URL.

```python
from nrp_cmd.async_client import get_async_client

client = await get_async_client("https://your-repository.org")
requests_client = client.requests
```

--------------------------------

### Get Repository Information

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Send a GET request to this endpoint to list available metadata schemas and other repository parameters. The response includes a URL describing the metadata schemas.

```http
GET /.well-known/repository
```

--------------------------------

### Fulltext+Keyword Valid Input JSON Example

Source: https://nrp-cz.github.io/docs/customize/model_backend/model_reference

Example of a JSON object with values conforming to the 'fulltext+keyword' data type configuration. Fields are suitable for both search and exact matching.

```json
{
  "title": "Machine Learning Applications in Bioinformatics: A Comprehensive Survey",
  "journal_name": "Journal of Computational Biology",
  "author_name": "Dr. Jane Smith"
}
```

--------------------------------

### Workflow Request Policy Example

Source: https://nrp-cz.github.io/docs/customize/workflows/create

Configure request policies for workflows using `WorkflowRequestPolicy`. This example defines a delete request with specific requesters, recipients, and state transitions.

```python
from oarepo_workflows import (
    WorkflowRequestPolicy,
    IfInState,
    WorkflowRequest,
    WorkflowTransitions,
    AutoApprove,
    WorkflowRequestEscalation,
)
from oarepo_runtime.services.permissions import UserWithRole, RecordOwners
from oarepo_requests.services.permissions import IfRequestedBy
from oarepo_communities.services.permissions import (
    CommunityRole,
    DefaultCommunityRole,
    CommunityMembers,
    DefaultCommunityMembers
)


class WorkflowNameRequests(WorkflowRequestPolicy):
    """Specific requests here"""
    delete_request = WorkflowRequest(
        requesters = [
            IfInState("published", [RecordOwners(), CommunityRole("curator")]),
        ],
        recipients = [
            IfRequestedBy(
                CommunityRole("curator"),
                then_=[AutoApprove()],
                else_=[CommunityRole("curator")],
            )
        ],
        transitions = WorkflowTransitions(
            submitted = 'deleting',
            accepted = 'deleted',
            declined = 'draft'
        )
        escalations = [
            WorklfowEscalation(
                after=timedelta(days=14),
                recipients=[UserWithRole("administrator")]
            )
        ]
    )
```

--------------------------------

### Initialize New Language Catalog

Source: https://nrp-cz.github.io/docs/customize/repository_ui/i18n

Run this command to initialize a new language catalog. This script typically sets up the necessary files for a new language based on existing configurations.

```bash
npm run init_catalog

```

--------------------------------

### Add Repository with Options

Source: https://nrp-cz.github.io/docs/userguide/commandline

Command syntax for adding a repository, including optional parameters for specifying a token, anonymous access, setting as default, and disabling TLS verification.

```bash
nrp-cmd add repository <servername> <alias> [--token token] [--anonymous] [--default] [--no-verify-tls]

```

--------------------------------

### Get Latest Version of a Record

Source: https://nrp-cz.github.io/docs/userguide/api_docs

Retrieve the latest version of a record by sending a GET request to the links.latest URL. The returned record uses its model's metadata schema.

```json
{
  "links": {
    "latest": "https://example.org/api/models/abcde-12345/versions/latest"
  }
}
```

```json
{
  "id": "abcde-12345",
  "metadata": {
    "title": "Latest published example record"
  }
}
```

--------------------------------

### Workflow Permission Policy Example

Source: https://nrp-cz.github.io/docs/customize/workflows/create

Define custom permissions for workflow actions using `WorkflowPermissionPolicy`. This example shows permissions for create, search, read, update, and delete actions.

```python
from oarepo_workflows import WorkflowPermissionPolicy

class WorkflowNamePermissions(WorkflowPermissionPolicy):

    # can_create can not use InState as no record exists yet
    can_create = [
        CommunityMembers(),
        SystemProcess(),
    ]

    # it is safe to specify AnyUser here, as inside invenio code the can_read
    # is checked as well
    can_search = [AnyUser(), SystemProcess()]

    can_read = [
        RecordOwners(),
        CommunityRole("curator"),
        IfInState("approving", CommunityRole("approver")),
        IfInState("approved", CommunityRole("approver"), CommunityRole("publisher")),
        IfInState("published",
            IfRestricted(
                "visibility",
                then_=[CommunityMembers()],
                else_=[AnyUser()],
            )
        ),
        SystemProcess()
    ]

    can_update = [
        IfInState("draft", RecordOwners(), CommunityRole("curator")),
        SystemProcess()
    ]

    can_delete = [
        IfInState("draft", RecordOwners(), CommunityRole("curator")),
        # published record can not be deleted directly by anyone else than system
        SystemProcess()
    ]
```

--------------------------------

### Run.sh Usage and Commands

Source: https://nrp-cz.github.io/docs/installation/run_script

Provides a detailed overview of available commands and options for the run.sh script, including service management, model operations, and more.

```bash
Usage: run.sh command [options]

Commands:

  install                    Install the repository
  upgrade                    Upgrade the repository (clean cache and reinstall)
  services                   Docker services management
      setup                  Setup docker services
      start                  Start docker services
      stop                   Stop docker services
      destroy                Destroy docker services
  model                      Record model management
      create [model-name] [config-file]
                             Create a new record model (config file is optional)
      update [model-name] [answers-file]
                             Update an existing record model (answers file is optional)
  info                       Show Python version and models information
  local                      Local package management
      add <path>             Add a local package to tool.uv.sources
      remove <name|--all>    Remove a local package or all from tool.uv.sources
  run                        Run the repository
      [--no-services]        Do not start docker services
      [--no-celery]          Do not start background tasks
  cli [subcommand]           Run the invenio-cli command
  invenio [subcommand]       Run an invenio command inside the virtual environment

  self-update                Update the runner script to the latest version
  translations               Manage backend translations
      init <lang>            Initialize backend translations for the given language
      extract                Extract backend translations
      update                 Update backend translations
      compile                Compile backend translations
  jstranslations             Manage frontend (JS) translations
      extract                Extract frontend (JS) translations
  index                      Index management commands
      rebuild                Rebuild the search index (drops and recreates)
  reset                      Perform a full reset of the repository (removes all data and re-installs)

Options:
  --help                     Show this help message
```

--------------------------------

### Add Repository and Create/Upload Record

Source: https://nrp-cz.github.io/docs/userguide/commandline

Demonstrates adding a repository and creating a new record with a file upload. The record URL can be stored in a variable for later use. Supports metadata in JSON format or a separate file.

```bash
# add a repository, will ask for token
nrp-cmd add repository https://data.narodni-repozitar.cz/ catchall --default

```

```bash
# create a new record and upload file to it. Store the record url to variable rec
nrp-cmd create record --community brno \
        '{"title": "My Record"}' \
        /tmp/myfile.txt '{"title":"My file"}' --set rec

```

```bash
# or with metadata in file
nrp-cmd create record --community brno \
        metadata.json \
        /tmp/myfile.txt /tmp/myfile-metadata.json --set rec

```

```bash
# publish the record
nrp-cmd publish record @rec

```

--------------------------------

### Configure Sync Client with Custom Settings

Source: https://nrp-cz.github.io/docs/userguide/python_library/sync_library

Create and use a custom configuration for the sync client, specifying repository URL, token, and TLS verification.

```python
from nrp_cmd.config import Config, RepositoryConfig
from yarl import URL

# Create custom configuration
config = Config()
config.add_repository(RepositoryConfig(
    alias="my-repo",
    url=URL("https://your-repository.org/api"),
    token="your-access-token",
    verify_tls=True
))

# Use custom configuration
client = get_sync_client("my-repo", config=config)

```

--------------------------------

### Fulltext Valid Input JSON Example

Source: https://nrp-cz.github.io/docs/customize/model_backend/model_reference

Example of a JSON object with values conforming to the 'fulltext' data type configuration. Each field contains string data suitable for full-text search.

```json
{
  "abstract": "This research investigates the impact of machine learning algorithms on data processing efficiency in large-scale distributed systems.",
  "research_methods": "We employed a mixed-methods approach combining quantitative analysis and qualitative interviews.",
  "technical_info": "The system was implemented using Python 3.9, TensorFlow 2.8, and deployed on Kubernetes clusters."
}
```

--------------------------------

### List Known Repositories

Source: https://nrp-cz.github.io/docs/userguide/commandline

Command to display a list of all configured repositories, showing their aliases, URLs, and whether they are set as the default.

```bash
nrp-cmd list repositories

```

--------------------------------

### Create administration group and permissions

Source: https://nrp-cz.github.io/docs/installation/run_instance

Set up an 'administration' group and grant it necessary permissions for administration and moderation tasks. This is the recommended way to support administration users.

```bash
./run.sh invenio roles create administration
```

```bash
./run.sh invenio access allow administration-access role administration
```

```bash
./run.sh invenio access allow administration-moderation role administration
```

--------------------------------

### Verify Docker Compose Version

Source: https://nrp-cz.github.io/docs/installation

Checks the installed version of Docker Compose.

```bash
docker-compose --version
```

```text
Docker Compose version v2.39.2
```

--------------------------------

### Verify pnpm Version

Source: https://nrp-cz.github.io/docs/installation

Checks if pnpm is installed and its version meets the requirements.

```bash
pnpm --version
```

```text
10.19.0
```

--------------------------------

### Create Initial Administrator User

Source: https://nrp-cz.github.io/docs/installation/run_instance

Use this command to create an initial administrator user and add them to the administration group. This user can then be used to log in to the instance.

```bash
./run.sh invenio users create -a -c admin@test.com

# add the user to the administration group
./run.sh invenio roles add admin@test.com administration
```
Tokens:
Raw