Skip to content
Extension for OpenRefine to support FAIR metadata
Java JavaScript HTML CSS Dockerfile
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/ISSUE_TEMPLATE [FOR-38] Documentation and release preparations (#23) Dec 23, 2019
project-repository [FOR-46] Update to OpenRefine 3.3 (#35) Feb 8, 2020
src [FOR-46] Update to OpenRefine 3.3 (#35) Feb 8, 2020
.dockerignore [FOR-1][FOR-2] Metadata extension skeleton (#1) Sep 24, 2019
.eslintignore [FOR-11] Storing data in FAIR storage (#13) Nov 25, 2019
.gitignore [FOR-1][FOR-2] Metadata extension skeleton (#1) Sep 24, 2019
.travis.yml
CHANGELOG.md [FOR-46] Update to OpenRefine 3.3 (#35) Feb 8, 2020
CODE_OF_CONDUCT.md Preparations for releasing (#26) Jan 5, 2020
CONTRIBUTING.md Preparations for releasing (#26) Jan 5, 2020
Dockerfile [FOR-46] Update to OpenRefine 3.3 (#35) Feb 8, 2020
LICENSE
README.md [FOR-46] Update to OpenRefine 3.3 (#35) Feb 8, 2020
pom.xml [FOR-46] Update to OpenRefine 3.3 (#35) Feb 8, 2020

README.md

OpenRefine-metadata-extension

Build Status GitHub All Releases Docker Pulls License Documentation Codacy Badge

OpenRefine extension to support FAIR Metadata with use of FAIR Data Point

Installation

Distribution ZIP/TGZ files are located at releases page.

Just download it and unzip/untar into the extensions folder in your OpenRefine instance, for more information visit OpenRefine - Installing Extensions.

$ unzip metadata-X.Y.Z-OpenRefine-3.3.zip path/to/openrefine-3.3/webapp/extensions
# or
$ tar xzvf metadata-X.Y.Z-OpenRefine-3.3.tgz -C path/to/openrefine-3.3/webapp/extensions

Via Docker

We publish Docker images that contains OpenRefine 3.3 together with the metadata extension. Only requirement is having Docker service running:

$ docker run -p 3333:3333 fairdata/openrefine-metadata-extension

Then just open localhost:3333 in your favorite web browser. Optionally you can change the port binding or run it "detached". Visit Docker run documentation for more information.

To persist data and eventually be able to share them across multiple instances of OpenRefine, you need to mount /data directory, for example:

$ docker run -p 3333:3333 -v /home/me/openrefine-data:/data:z fairdata/openrefine-metadata-extension

To add other extensions (e.g. RDF extension), you can just put them into the mounted folder according to the official documentation. Always also check installation instruction of the desired extension. For the previous example, you should place your extensions to the directory /home/me/openrefine-data/extensions.

Configuration

Configuration files are located in extensions/metadata/module/config folder and examples are provided. In case of Dockerized instance, you need to mount this folder with your configuration files as volume similarly to data folder.

For more information, visit our documentation.

Development

You are required to have Maven installed with other necessary tools for building Java (see OpenRefine - Documentation for Developers):

$ mvn clean compile

To create a distribution ZIP/TGZ files, run:

$ mvn package

After issuing these commands, prepared ZIP/TGZ files should be located in target directory according to the Maven output.

We maintain a CHANGELOG, you should also take a look at our Contributing guidelines and Code of Conduct.

Build with Docker

You can also use provided multistage Dockerfile that builds the extension and then runs it in OpenRefine. Therefore, you don't need any Java dependencies locally, just Docker:

$ docker build -t openrefine-metadata:local-tag .
$ docker run -p 3333:3333 openrefine-metadata:local-tag

Then open http://localhost:3333 in your favorite web browser.

You can also build a Docker image with specific OpenRefine version using argument (see Dockerfile for details):

docker build  . -t  openrefine-metadata:local-or3.2 --build-arg OPENREFINE_VERSION=3.2

Note that we are using Java SE 8 (LTS), concretely OpenJDK 8 in Docker images (to comply with OpenRefine requirements).

License

This project is licensed under MIT license - see the LICENSE file for more information.

You can’t perform that action at this time.