https://github.com/adiwg/mdtranslator

Metadata translation tool built using Ruby
https://github.com/adiwg/mdtranslator

Last synced: 26 days ago
JSON representation

Metadata translation tool built using Ruby

• Host: GitHub
• URL: https://github.com/adiwg/mdtranslator
• Owner: adiwg
• License: unlicense
• Created: 2014-01-09T03:24:15.000Z (over 11 years ago)
• Default Branch: develop
• Last Pushed: 2024-05-22T18:52:50.000Z (about 1 year ago)
• Last Synced: 2024-05-22T20:01:13.073Z (about 1 year ago)
• Language: Ruby
• Homepage: https://www.adiwg.org/mdTranslator/
• Size: 6 MB
• Stars: 14
• Watchers: 12
• Forks: 12
• Open Issues: 66
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
[![Build Status](https://travis-ci.org/adiwg/mdTranslator.svg?branch=master)](https://travis-ci.org/adiwg/mdTranslator)

[![Gem Version](https://badge.fury.io/rb/adiwg-mdtranslator.svg)](http://badge.fury.io/rb/adiwg-mdtranslator)

# mdTranslator

**mdtranslator** was written by the [Alaska Data Integration Working Group](http://www.adiwg.org) (ADIwg) to assist researchers with authoring both spatial and non-spatial metadata for projects and datasets. Input to the mdtranslator is a JSON record conforming to the [mdJson-schemas](http://mdTools.adiwg.org). The user can request the mdTranslator to translate the mdJson input into one or more established metadata standards. The mdTranslator currently supports translation to ISO 19115-2, ISO 19110, HTML, and mdJson 2x. The mdTranslator part of an open source architecture toolkit that allows developers to write additional readers and/or writers as may be required.

## Installation

Add this line to your application's Gemfile:

    gem 'adiwg-mdtranslator'

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install adiwg-mdtranslator

## CLI Usage

    $ mdtranslator help translate

## Development

**Note about version number**  

The version should be updated in 2 locations:

`version.json` & `lib/adiwg/mdtranslator/version.rb`

The former is used during the tag/release action and the latter is used by the application itself. Ideally, there should be a test to confirm these are the same.

### Requirements

Requires

- [Ruby](https://www.ruby-lang.org/en/documentation/installation/)

- bundler (`gem install bundler`)

- rake (`gem install rake`)

### Tests

In order to run the tests, first install the dependencies

    $ bundle install

Then, run the rake command

    $ bundle exec rake

_TODO: There are currently 4 tests that are not passing, related to mdJSON readers and writers_

## Contributing

1. Fork it ( https://github.com/[my-github-username]/mdTranslator/fork )

2. Create your feature branch (`git checkout -b my-new-feature`)

3. Commit your changes (`git commit -am 'Add some feature'`)

4. Push to the branch (`git push origin my-new-feature`)

5. Create a new Pull Request