book-highlights

module
v0.0.0-...-27efec9 Latest Latest
Warning

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

Go to latest
Published: Mar 26, 2018 License: Apache-2.0

README

DISCLAIMER: the hidden purpose of the project is to try different technologies and at the same time solve the problem of syncrhonisation book highlights between different services (which may not provide API).

With that being said, be aware of the poor implementation ahead. Feel free to contribute though.


Book Highlights

Build Status Go Report Card GitHub license

This project is a set of tools to export your book hightlights from different services (Kindle, Google Books etc) to your storage where you can work with them in any way you like plus, provide API to query them.

Services supported

Quick start

You can either build everything by yourself (see README files for each service for details) or use images from DockerHub.

Here is an example of the compose file to use pre built images:

version: '3'
services:
  kindle:
    image: "zerc/book-highlights-kindle"
    depends_on:
     - chrome
    environment:
     - API_ENTRYPOINT=API_URL
     - CHROME_DEBUG=0
  chrome:
    image: "justinribeiro/chrome-headless"
    ports:
      - "9222:9222"
    cap_add:
      - SYS_ADMIN

Where API_URL needs to be replaced to your API endpoint to accept the payload with highlights parsed.

TODO:
  • Better READMEs
  • Add a builtin service to store highlights.
  • Add an example of Ansible playbook to set up everything on the server.

Directories

Path Synopsis
src
common
Package contains common things between microservices
Package contains common things between microservices
kindle
Script to parse highlights from read.amazon.co.uk/notebook
Script to parse highlights from read.amazon.co.uk/notebook

Jump to

Keyboard shortcuts

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