https://github.com/hadynz/puppeteer-goodreads

Scrapes private Kindle highlights for a Goodreads user using automation by headless chrome
https://github.com/hadynz/puppeteer-goodreads

automation goodreads headless-chrome puppeteer

Last synced: 10 days ago
JSON representation

Scrapes private Kindle highlights for a Goodreads user using automation by headless chrome

• Host: GitHub
• URL: https://github.com/hadynz/puppeteer-goodreads
• Owner: hadynz
• License: mit
• Created: 2020-01-03T00:32:37.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2020-12-23T12:36:41.000Z (about 4 years ago)
• Last Synced: 2024-12-30T02:23:02.103Z (about 1 month ago)
• Topics: automation, goodreads, headless-chrome, puppeteer
• Language: HTML
• Homepage:
• Size: 273 KB
• Stars: 1
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  

  



# puppeteer-goodreads

Scrapes private Kindle highlights for a Goodreads user using automation by headless chrome.

This module was built using the excellent [node-typescript-boilerplate].

## Install

```bash

npm install --save puppeteer-goodreads

```

## Usage

This example signs into a [Goodreads](https://goodreads.com) account.

```js

// Import using CommonJS `require`

const { PuppeteerGoodreads } = require('puppeteer-goodreads')

// Import using Typescript. Module interfaces are also available for your consumption

import { PuppeteerGoodreads, Book, Highlight } from 'puppeteer-goodreads';

const defaultOptions = { headless: false, /* ... */ };

const goodreads = new PuppeteerGoodreads({ puppeteer: defaultOptions });

/* Logs in to Goodreads with credentials using a headless chrome brwoser session */

const success = await goodreads.signin('xxx', 'xxx');

/* Returns list of books with Kindle highlights for currently logged in Goodreads user */

const books = await goodreads.getMyBooks();

/* Returns all Kindle highlights for a given book for logged in Goodreads user */

const highlights = await goodreads.getBookHighlights(book);

await goodreads.close();

```

## License

MIT © [Hady Osman](https://github.com/hadynz)

[node-typescript-boilerplate]: https://github.com/jsynowiec/node-typescript-boilerplate