cessda.cmv.console

Validation suite for the CESSDA Data Catalogue

https://github.com/cessda/cessda.cmv.console

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Academic email domains
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Validation suite for the CESSDA Data Catalogue

Basic Info
  • Host: GitHub
  • Owner: cessda
  • License: apache-2.0
  • Language: Java
  • Default Branch: main
  • Homepage:
  • Size: 1.15 MB
Statistics
  • Stars: 0
  • Watchers: 4
  • Forks: 0
  • Open Issues: 0
  • Releases: 6
Created about 3 years ago · Last pushed 7 months ago
Metadata Files
Readme Changelog Contributing License Code of conduct Citation

README.md

CESSDA Metadata Validator: Command Line Runner

Build Status Quality Gate Status Coverage SQAaaS badge shields.io

This repository contains the source code for a command line application of the CESSDA Metadata Validator.

Prerequisites

Java 11 or greater is required to build and run this application.

Quick Start

  1. Check prerequisites and install any required software.
  2. Clone the repository to your local workspace.
  3. Build the application using .\mvnw clean verify.
  4. Run the application using the following command: .\mvnw exec:java.

Project Structure

This project uses the standard Maven project structure.

<ROOT> ├── .mvn # Maven wrapper. ├── src # Contains all source code and assets for the application. | ├── main | | ├── java # Contains release source code of the application. | | └── resources # Contains release resources assets. | └── test | ├── java # Contains test source code. | └── resources # Contains test resource assets. └── target # The output directory for the build.

Technology Stack

Several frameworks are used in this application.

| Framework/Technology | Description | |-----------------------------------------------------------------------------------|-------------------------------------------| | CESSDA Metadata Validator | Validates XMLs according to the CMM | | Jib | Java Docker/OCI image builder | | Jackson | JSON/YAML Serializer/Deserializer | | logstash-logback-encoder | JSON Encoder for Logback | | Apache Commons IO | Library of utilities for IO functionality |

Configuration

The validator is configured using configuration.yaml.

yaml rootDirectory: repositories: - code: UKDS # Friendly name of the repository. directory: UKDS/ # Base directory to search for metadata. profile: file://validation-profile.xml # URL to the validation profile. validationGate: BASIC # The validation gate to use. Acceptable values are BASIC, BASICPLUS, STANDARD, EXTENDED and STRICT.

Owner

  • Name: CESSDA
  • Login: cessda
  • Kind: organization
  • Location: Norway

Citation (CITATION.cff)

#
# Copyright © 2017-2023 CESSDA ERIC (support@cessda.eu)
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: CMV: Command Line Runner
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Matthew
    family-names: Morris
    email: matthew.morris@cessda.eu
    affiliation: CESSDA ERIC

GitHub Events

Total
  • Release event: 1
  • Delete event: 41
  • Issue comment event: 3
  • Push event: 42
  • Pull request review event: 43
  • Pull request event: 80
  • Create event: 45
Last Year
  • Release event: 1
  • Delete event: 41
  • Issue comment event: 3
  • Push event: 42
  • Pull request review event: 43
  • Pull request event: 80
  • Create event: 45

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 0
  • Total pull requests: 58
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 days
  • Total issue authors: 0
  • Total pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.02
  • Merged pull requests: 39
  • Bot issues: 0
  • Bot pull requests: 52
Past Year
  • Issues: 0
  • Pull requests: 37
  • Average time to close issues: N/A
  • Average time to close pull requests: 1 day
  • Issue authors: 0
  • Pull request authors: 2
  • Average comments per issue: 0
  • Average comments per pull request: 0.03
  • Merged pull requests: 22
  • Bot issues: 0
  • Bot pull requests: 36
Top Authors
Issue Authors
Pull Request Authors
  • dependabot[bot] (95)
  • matthew-morris-cessda (9)
  • Joshocan (1)
Top Labels
Issue Labels
Pull Request Labels
dependencies (95) java (23) enhancement (3) bug (1)