<div>
  <h1>TBR Deal Finder <img src="assets/icon.png" alt="TBR Deal Finder" width="128" height="128" style="vertical-align: middle; margin-left: 10px;"></h1>
</div>
Track price drops and find deals on books in your TBR (To Be Read) and wishlist across digital book retailers.

## Features
- Use your StoryGraph exports, Goodreads exports, and custom csvs (spreadsheet) to track book deals
- Supports multiple library exports
- Tracks deals on the wishlist of all your configured retailers like audible (excluding kindle)
- Supports multiple locales
- Find the latest and active deals from supported sellers
- Only get notified for new deals or view all active deals 
- Filters out books you already own to prevent purchasing the same book on multiple retailers
- Track historical pricing* (History limited to your runs making it more accurate over time)
- Compare pricing across digital retailers

## Support

### Audiobooks
* Audible
* Chirp
* Libro.fm

### EBooks
* Kindle

### Locales
* US
* CA
* UK
* AU
* FR
* DE
* JP
* IT
* IN
* ES
* BR

## Configuration
This tool can use the csv generated by the app you use to track your TBRs.
Here are the steps to get your export.

### StoryGraph
* Open https://app.thestorygraph.com/ in the browser of your choice
* Click on your profile icon in the top right corner
* Select "Manage Account"
* Scroll down to "Manage Your Data"
* Click the button "Export StoryGraph Library"
* You will be navigated to https://app.thestorygraph.com/user-export
* Click "Generate export"
* Wait a few minutes and refresh the page
* A new item will appear that says "Your export from ... - Download" will appear
* Click "Download"

### Goodreads
* Open https://www.goodreads.com/review/import in the browser of your choice
* At the top of the page click the button "Export Library"
* Wait a few minutes and refresh the page
* A new item will appear that says "Your export from ..." will appear
* Click it to download the csv

### Custom csv
If you've got your own CSV you're using to track your TBRs all you need are the following columns for it to be in a valid format
* `Title`
* `Authors`
* `Read Status`* (See below)
 
Optionally, you can add the `Read Status` column. Set `to-read` for all books you want to be tracked.
If you don't add this column the deal finder will run on ALL books in the CSV.

## Installation Guide
Each guide contains everything you need: installation, usage, and updating instructions.

### Choose Your Guide
- [📱 **Desktop App Guide**](docs/desktop-app.md) - For users who prefer graphical interfaces
- [🐍 **Python CLI Guide**](docs/python-cli.md) - For command-line and automation users
- [🛠️ **Development Guide**](docs/development.md) - For developers and contributors

---

Happy deal hunting!
