Skip to content

Repository files navigation

Build Status Gem Version

mdTranslator

mdtranslator was written by the Alaska Data Integration Working Group (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. 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
  • 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

About

Metadata translation tool built using Ruby

Resources

Stars

Watchers

Forks

Releases

Packages

Used by

Contributors

Languages