https://github.com/e-e-e/open-packaging-format

A simple opf metadata parser
https://github.com/e-e-e/open-packaging-format

epub metadata open-package-format opf parser

Last synced: about 2 months ago
JSON representation

A simple opf metadata parser

• Host: GitHub
• URL: https://github.com/e-e-e/open-packaging-format
• Owner: e-e-e
• Created: 2017-04-25T05:02:14.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-26T07:26:56.000Z (over 7 years ago)
• Last Synced: 2025-04-20T13:09:34.190Z (about 2 months ago)
• Topics: epub, metadata, open-package-format, opf, parser
• Language: JavaScript
• Homepage:
• Size: 51.8 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
# Open Packaging Format

[![npm version](https://badge.fury.io/js/open-packaging-format.svg)](https://badge.fury.io/js/open-packaging-format) [![Build Status](https://travis-ci.org/e-e-e/open-packaging-format.svg?branch=master)](https://travis-ci.org/e-e-e/open-packaging-format) [![dependencies Status](https://david-dm.org/e-e-e/open-packaging-format/status.svg)](https://david-dm.org/e-e-e/open-packaging-format) [![Coverage Status](https://coveralls.io/repos/github/e-e-e/open-packaging-format/badge.svg?branch=master)](https://coveralls.io/github/e-e-e/open-packaging-format?branch=master) [![Code Climate](https://codeclimate.com/github/e-e-e/open-packaging-format/badges/gpa.svg)](https://codeclimate.com/github/e-e-e/open-packaging-format)

An simple parser for opf metadata files. This is an incomplete implementation of the [OPF specification](http://www.idpf.org/epub/20/spec/OPF_2.0.1_draft.htm).

## Install

```bash

npm install open-packaging-format;

```

## Simple Use:

```js

import { readOPF } from 'open-packaging-format';

readOPF('some/dir/to/metadata.opf')

  .then((opf) => {

    console.log(opf.title);

    console.log(opf.description);

    for (const id of opf.identifiers) {

      console.log(id);

    }

  })

  .catch(console.error);

```

demonstrating writing data to an OPF and then that data to a file:

```js

import OPF, { writeOPF } from 'open-packaging-format';

const opf = new OPF();

opf.title = 'This is a good title';

o.writeOPF('/path/to/your.xml', opf)

  .catch(console.error);

```