commonmeta

command module
v0.6.47 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 11, 2025 License: MIT Imports: 1 Imported by: 0

README

Go Reference Go Report Card

commonmeta

commonmeta is a Go library to implement Commonmeta, the common Metadata Model for Scholarly Metadata. Use commonmeta to convert scholarly metadata, in a variety of formats, listed below. Commonmeta is work in progress, the first release was on April 19, 2024. Implementations in other languages are also available (Ruby, Python).

commonmeta uses semantic versioning. Currently, its major version number is still at 0, meaning the API is not yet stable, and breaking changes are expected in the internal API and commonmeta JSON format.

Supported Metadata Formats

Commonmeta reads and/or writes these metadata formats:

Format Name Content Type Read Write
Commonmeta commonmeta application/vnd.commonmeta+json yes yes
CrossRef XML crossrefxml application/vnd.crossref.unixref+xml yes yes
Crossref crossref application/vnd.crossref+json yes n/a
DataCite datacite application/vnd.datacite.datacite+json yes yes
Schema.org (in JSON-LD) schemaorg application/vnd.schemaorg.ld+json yes yes
RDF XML rdf application/rdf+xml no later
RDF Turtle turtle text/turtle no later
CSL-JSON csl application/vnd.citationstyles.csl+json yes yes
Formatted text citation citation text/x-bibliography n/a planned
Codemeta codemeta application/vnd.codemeta.ld+json later later
Citation File Format (CFF) cff application/vnd.cff+yaml later later
JATS jats application/vnd.jats+xml later later
CSV csv text/csv no later
BibTex bibtex application/x-bibtex planned planned
RIS ris application/x-research-info-systems planned planned
InvenioRDM inveniordm application/vnd.inveniordm.v1+json yes yes
JSON Feed jsonfeed application/feed+json yes later

commonmeta: the Commonmeta format is the native format for the library and used internally. Planned: we plan to implement this format for the v1.0 public release.
Later: we plan to implement this format in a later release.

Installation

Commonmeta is a single Go binary, available for download from the releases page. Download the binary for your platform (Linux, Mac, Windows; X86 or ARM architecture), and place it in your PATH. Linux packages in deb, rpm and apk formats are also available from the releases page.

Homebrew

To install commonmeta on macOS using Homebrew, run:

brew tap front-matter/commonmeta
brew install commonmeta
Go

To install commonmeta using Go, run:

go install github.com/front-matter/commonmeta@latest

Meta

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

License: MIT

Documentation

Overview

Copyright © 2024 Front Matter <info@front-matter.io>

Directories

Path Synopsis
Package authorutils provides utility functions to work with authors
Package authorutils provides utility functions to work with authors
Package cff provides a function to read CFF and convert it to commonmeta.
Package cff provides a function to read CFF and convert it to commonmeta.
Package codemeta provides a function to read Codemeta metadata and convert it to commonmeta.
Package codemeta provides a function to read Codemeta metadata and convert it to commonmeta.
Package commonmeta provides functions to read and write commonmeta metadata.
Package commonmeta provides functions to read and write commonmeta metadata.
Package crossref provides function to convert Crossref metadata to/from the commonmeta metadata format.
Package crossref provides function to convert Crossref metadata to/from the commonmeta metadata format.
Package crossrefxml provides function to convert Crossref XML metadata to/from the commonmeta metadata format.
Package crossrefxml provides function to convert Crossref XML metadata to/from the commonmeta metadata format.
Package csl converts citation-style language (CSL) metadata to/from the commonmeta metadata format.
Package csl converts citation-style language (CSL) metadata to/from the commonmeta metadata format.
Package datacite provides function to convert DataCite metadata to/from the commonmeta metadata format.
Package datacite provides function to convert DataCite metadata to/from the commonmeta metadata format.
Package dateutils provides functions to work with dates.
Package dateutils provides functions to work with dates.
Package doiutils provides a set of functions to work with DOIs
Package doiutils provides a set of functions to work with DOIs
Package inveniordm provides functions to convert InvenioRDM metadata to/from the commonmeta metadata format.
Package inveniordm provides functions to convert InvenioRDM metadata to/from the commonmeta metadata format.
Package jsonfeed converts JSON Feed metadata to/from the commonmeta metadata format.
Package jsonfeed converts JSON Feed metadata to/from the commonmeta metadata format.
Package schemaorg converts Schema.org metadata to/from the commonmeta metadata format.
Package schemaorg converts Schema.org metadata to/from the commonmeta metadata format.
Package schemautils provides functions to validate JSON documents against JSON Schema files.
Package schemautils provides functions to validate JSON documents against JSON Schema files.
Package utils provides utility functions for commonmeta.
Package utils provides utility functions for commonmeta.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL