https://github.com/b1anca/kindle-notebook
Fetch your Kindle Highlights along with their context using the Selenium Webdriver
https://github.com/b1anca/kindle-notebook
kindle ruby ruby-gem selenium-webdriver
Last synced: about 2 months ago
JSON representation
Fetch your Kindle Highlights along with their context using the Selenium Webdriver
- Host: GitHub
- URL: https://github.com/b1anca/kindle-notebook
- Owner: b1anca
- License: mit
- Created: 2023-05-06T21:57:02.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-07-02T20:26:54.000Z (about 3 years ago)
- Last Synced: 2025-08-29T22:00:30.863Z (10 months ago)
- Topics: kindle, ruby, ruby-gem, selenium-webdriver
- Language: Ruby
- Homepage:
- Size: 82 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Kindle Notebook
Fetch your Kindle Highlights along with their context using the Selenium Webdriver
[](https://badge.fury.io/rb/kindle-notebook)
## Installation
Install the gem and add to the application's Gemfile by executing:
```sh
$ bundle add kindle-notebook
```
If bundler is not being used to manage dependencies, install the gem by executing:
```sh
$ gem install kindle-notebook
```
## Configuration
You can either create a `.env` file and add your credentials, the default values will be fetched from this file, or configure the gem, for example in an initializer file.
```rb
KindleNotebook.configure do |config|
config.url = "https://read.amazon.com/"
config.login = ENV["AMAZON_EMAIL"]
config.password = ENV["AMAZON_PASSWORD"]
config.selenium_driver = :firefox
config.headless_mode = false
config.min_highlight_words = 1
config.max_highlight_words = 3
end
```
The configuration options `min_highlight_words` and `max_highlight_words` determine the range for a highlight's word count. Highlights with a word count outside this range will not be considered will be filtered out.
## Usage
Sign in:
```rb
client = KindleNotebook::Client.new
client.sign_in
```
Get the highlights from a book:
```rb
books = client.books
book = books.first
book.fetch_highlights
book.highlights
```
To write to a CSV file:
```rb
book.to_csv_file # => "Docker: A Project-Based Approach to Learning - Cannon, Jason.csv"
```
## Examples
Book:
```rb
#
```
Highlight:
```rb
#
```
Book CSV:
```csv
text,page,context,book_asin,raw_text,raw_context
journald,120,"If you get stuck, the logging component of systemd, called journald, can also help.",B09FJ3411G,"journald,","used, for example. If you get stuck, the logging component of systemd, called journald, can also help. This journald command displays the last 20 entries in the"
swarm,225,"Docker Swarm In this chapter, you're going to learn how to create and use a Docker",B09FJ3411G,swarm.,"Docker Swarm In this chapter, you're going to learn how to create and use a Docker"
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
### Testing
This gem is using [puffing-billy](https://github.com/oesmith/puffing-billy) for testing which needs the geckodriver executable. It can be installed with:
```sh
$ sudo apt-get install firefox-geckodriver # or
$ brew install geckodriver
```
The executable should be in your `PATH`, if it is not you can run the following command (please adapt the location of the geckodriver executable with yours):
```sh
$ echo 'export PATH=$PATH:/home/user/.cache/selenium/geckodriver/linux64/0.33.0' >> ~/.zshrc
```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/b1anca/kindle-notebook. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/b1anca/kindle-notebook/blob/master/CODE_OF_CONDUCT.md).
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Code of Conduct
Everyone interacting in the KindleNotebook project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/b1anca/kindle-notebook/blob/main/CODE_OF_CONDUCT.md).