RO-Crate Validation Service

This project presents a Flask-based API for validating RO-Crates.

Project Structure

app/
├── ro_crates/
│   ├── routes/
│   │   ├── __init__.py         # Registers blueprints
│   │   └── post_routes.py      # POST API routes
│   └── __init__.py             
├── services/
│   ├── logging_service.py      # Centralised logging
│   └── validation_service.py   # Queue RO-Crates for validation
├── tasks/
│   └── validation_tasks.py     # Validate RO-Crates
├── utils/
│   ├── config.py               # Configuration
│   ├── minio_utils.py          # Methods for interacting with MinIO
│   └── webhook_utils.py        # Methods for sending webhooks

Setting up the project

Prerequisites

• Docker with Docker Compose

Installation

1. Clone the repository:

   git clone https://github.com/eScienceLab/Cratey-Validator.git
   cd crate-validation-service

2. Build and start the services using Docker Compose:

   docker compose build
   docker compose up

3. Set up the MinIO bucket

   1. Open the MinIO web interface at http://localhost:9000.

   2. Log in with your MinIO credentials.

   3. Create a new bucket named ro-crates.

   4. Enable versioning for the ro-crates bucket — this is important for tracking unique object versions.

      

   5. Upload your RO-Crate files to the ro-crates bucket.

   6. To verify that versioning is enabled:

      • Select the uploaded RO-Crate object in the ro-crates bucket.
      • Navigate to the Actions panel on the right.
      • The Display Object Versions option should be clickable.

      

Example Usage

curl -X POST http://localhost:5001/ro_crates/post/validate_by_id_no_webhook -d "id=1"