https://github.com/timursevimli/epubconventer

A Node.js script for converting PDF files to EPUB format using the ebook-convert tool from Calibre.
https://github.com/timursevimli/epubconventer

conversion converter ebook epub pdf

Last synced: 2 days ago
JSON representation

A Node.js script for converting PDF files to EPUB format using the ebook-convert tool from Calibre.

• Host: GitHub
• URL: https://github.com/timursevimli/epubconventer
• Owner: timursevimli
• License: mit
• Created: 2023-04-04T06:55:20.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-13T12:54:45.000Z (2 months ago)
• Last Synced: 2024-10-13T19:37:18.119Z (about 1 month ago)
• Topics: conversion, converter, ebook, epub, pdf
• Language: JavaScript
• Homepage:
• Size: 1.06 MB
• Stars: 6
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Epub Converter

[![ci Status](https://github.com/timursevimli/epubconventer/workflows/CI/badge.svg)](https://github.com/timursevimli/epubconventer/actions?query=workflow%3A%22CI%22+branch%3Amaster)

[![snyk](https://snyk.io/test/github/timursevimli/epubconventer/badge.svg)](https://snyk.io/test/github/timursevimli/epubconventer)

[![npm downloads/month](https://img.shields.io/npm/dm/epubconventer.svg)](https://www.npmjs.com/package/epubconventer)

[![npm downloads](https://img.shields.io/npm/dt/epubconventer.svg)](https://www.npmjs.com/package/epubconventer)

[![license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/timursevimli/epubconventer/blob/master/LICENSE)

A Node.js script for converting PDF files to EPUB format using the ebook-convert tool from Calibre.

## Installation

Before using this script, you need to have the `ebook-convert` tool installed on your machine. You can download the latest version of Calibre, which includes the `ebook-convert` tool, from the Calibre website.

Once you have `ebook-convert` installed, you can install this script using npm:

```bash

npm install -g epubconverter

```

## CLI Usage

After installation, you can use the `epubconverter` command from the terminal to convert PDF files to EPUB format.

### Example

```bash

epubconverter --target="./path/to/pdf/files" --output="./path/to/output/directory"

```

### Options

- `--target` (required): The path to the directory containing the PDF files you want to convert.

- `--output` (optional): The path to the output directory where the converted EPUB files will be saved. If not specified, the converted files will be saved in the target directory.

### Examples

```bash

epubconverter --target="./pdfs" --output="./epubs"

```

This will convert all the PDF files in the ./pdfs directory and save the resulting EPUB files in the ./epubs directory

## Programmatic Usage

You can also use this script programmatically in your Node.js projects.

```javascript

const EpubConverter = require('epubconverter');

const converter = new EpubConverter(

  '/path/to/pdf/files',

  '/path/to/output/directory',

);

// convert all the PDF files in the target directory to EPUB format

converter.convert().finally(() => {

  console.log('All done!');

});

```

The convert method returns a Promise that resolves when all the conversions have completed.

## Requirements

- Node.js v16.18 or higher

- `ebook-convert` tool from Calibre

## License

This project is licensed under the MIT License - see the [LICENSE](https://github.com/timursevimli/epubconventer/blob/main/LICENSE) file for details.