tbr-deal-finder 0.1.0__tar.gz

tbr_deal_finder-0.1.0/.github/workflows/publish-to-pypi.yaml

@@ -0,0 +1,27 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - 'v*'  # Trigger on version tags
+
+jobs:
+  deploy:
+    name: Build and publish Python 🐍 distributions 📦 to PyPI
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/tbr_deal_finder  # This will link to your package on PyPI
+
+    permissions:
+      # For PyPI's trusted publishing.
+      id-token: write
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: "Install uv"
+        uses: astral-sh/setup-uv@v5
+      - name: Create build
+        run: uv build
+      - name: Publish to PyPi
+        run: uv publish

tbr_deal_finder-0.1.0/.gitignore

@@ -0,0 +1,208 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+.venv/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

tbr_deal_finder-0.1.0/.python-version

@@ -0,0 +1 @@
+3.13

tbr_deal_finder-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 WillNye
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

tbr_deal_finder-0.1.0/PKG-INFO

@@ -0,0 +1,167 @@
+Metadata-Version: 2.4
+Name: tbr-deal-finder
+Version: 0.1.0
+Summary: Track price drops and find deals on books in your TBR list across audiobook and ebook formats.
+License: MIT
+License-File: LICENSE
+Requires-Python: >=3.13
+Requires-Dist: aiohttp>=3.12.14
+Requires-Dist: audible>=0.10.0
+Requires-Dist: click>=8.2.1
+Requires-Dist: duckdb>=1.3.2
+Requires-Dist: pandas>=2.3.1
+Requires-Dist: questionary>=2.1.0
+Requires-Dist: tqdm>=4.67.1
+Requires-Dist: unidecode>=1.4.0
+Description-Content-Type: text/markdown
+
+# tbr-deal-finder
+
+Track price drops and find deals on books in your TBR (To Be Read) list across audiobook and ebook formats.
+
+## Features
+- Uses your StoryGraph exports, Goodreads exports, and custom csvs (spreadsheet) to track book deals
+- Supports multiple of the library exports above 
+- Supports multiple locales and currencies
+- Finds the latest and active deals from supported sellers
+- Simple CLI interface for setup and usage
+- Only get notified for new deals or view all active deals 
+
+## Support
+
+### Audiobooks
+* Audible
+* Chirp
+* Libro.fm (Work in progress)
+
+### Locales
+* US
+* CA
+* UK
+* AU
+* FR
+* DE
+* JP
+* IT
+* IN
+* ES
+* BR
+
+## Installation Guide
+
+### Python (Recommended)
+1. If it's not already on your computer, download Python https://www.python.org/downloads/
+   1. tbr-deal-finder requires Python3.13 or higher
+2. Optional: Install and use virtualenv
+3. Open your Terminal/Commmand Prompt
+4. Run `pip3.13 install tbr-deal-finder`
+
+### UV
+1. Clone the repository:
+   ```sh
+   git clone https://github.com/yourusername/tbr-deal-finder.git
+   cd tbr-deal-finder
+   ```
+2. Install uv:
+   https://docs.astral.sh/uv/getting-started/installation/
+
+## Configuration
+This tool relies on 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.
+
+### tbr-deal-finder setup
+
+#### Python
+```sh
+tbr-deal-finder setup
+```
+
+#### UV
+```sh
+uv run -m tbr_deal_finder.main setup
+```
+
+You will be prompted to:
+- Enter the path(s) to your StoryGraph export CSV file(s)
+- Select your locale (country/region)
+- Set your maximum price for deals
+- Set your minimum discount percentage
+
+The configuration will be saved for future runs.
+
+## Usage
+All commands are available via the CLI:
+
+- `setup`         – Set up or update your configuration interactively.
+- `latest-deals`  – Find and print the latest book deals based on your config.
+- `active-deals`  – Show all currently active deals.
+
+#### Python
+```sh
+tbr-deal-finder [COMMAND]
+```
+
+#### UV
+```sh
+uv run -m tbr_deal_finder.main [COMMAND]
+```
+
+Example:
+```sh
+tbr-deal-finder latest-deals
+
+# or
+
+uv run -m tbr_deal_finder.main latest-deals
+```
+
+## Updating your TBR
+To update tbr-deal-finder as your TBR changes, regenerate and download your library export.
+See [Configuration](#Configuration) for steps.
+
+
+## Updating the tbr-deal-finder
+
+### Python
+```sh
+pip3.13 install tbr-deal-finder --upgrade
+```
+
+### UV
+```sh
+# From the repo directory
+git checkout main && git fetch
+```
+
+
+---
+
+Happy deal hunting!

tbr_deal_finder-0.1.0/README.md

@@ -0,0 +1,150 @@
+# tbr-deal-finder
+
+Track price drops and find deals on books in your TBR (To Be Read) list across audiobook and ebook formats.
+
+## Features
+- Uses your StoryGraph exports, Goodreads exports, and custom csvs (spreadsheet) to track book deals
+- Supports multiple of the library exports above 
+- Supports multiple locales and currencies
+- Finds the latest and active deals from supported sellers
+- Simple CLI interface for setup and usage
+- Only get notified for new deals or view all active deals 
+
+## Support
+
+### Audiobooks
+* Audible
+* Chirp
+* Libro.fm (Work in progress)
+
+### Locales
+* US
+* CA
+* UK
+* AU
+* FR
+* DE
+* JP
+* IT
+* IN
+* ES
+* BR
+
+## Installation Guide
+
+### Python (Recommended)
+1. If it's not already on your computer, download Python https://www.python.org/downloads/
+   1. tbr-deal-finder requires Python3.13 or higher
+2. Optional: Install and use virtualenv
+3. Open your Terminal/Commmand Prompt
+4. Run `pip3.13 install tbr-deal-finder`
+
+### UV
+1. Clone the repository:
+   ```sh
+   git clone https://github.com/yourusername/tbr-deal-finder.git
+   cd tbr-deal-finder
+   ```
+2. Install uv:
+   https://docs.astral.sh/uv/getting-started/installation/
+
+## Configuration
+This tool relies on 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.
+
+### tbr-deal-finder setup
+
+#### Python
+```sh
+tbr-deal-finder setup
+```
+
+#### UV
+```sh
+uv run -m tbr_deal_finder.main setup
+```
+
+You will be prompted to:
+- Enter the path(s) to your StoryGraph export CSV file(s)
+- Select your locale (country/region)
+- Set your maximum price for deals
+- Set your minimum discount percentage
+
+The configuration will be saved for future runs.
+
+## Usage
+All commands are available via the CLI:
+
+- `setup`         – Set up or update your configuration interactively.
+- `latest-deals`  – Find and print the latest book deals based on your config.
+- `active-deals`  – Show all currently active deals.
+
+#### Python
+```sh
+tbr-deal-finder [COMMAND]
+```
+
+#### UV
+```sh
+uv run -m tbr_deal_finder.main [COMMAND]
+```
+
+Example:
+```sh
+tbr-deal-finder latest-deals
+
+# or
+
+uv run -m tbr_deal_finder.main latest-deals
+```
+
+## Updating your TBR
+To update tbr-deal-finder as your TBR changes, regenerate and download your library export.
+See [Configuration](#Configuration) for steps.
+
+
+## Updating the tbr-deal-finder
+
+### Python
+```sh
+pip3.13 install tbr-deal-finder --upgrade
+```
+
+### UV
+```sh
+# From the repo directory
+git checkout main && git fetch
+```
+
+
+---
+
+Happy deal hunting!

tbr_deal_finder-0.1.0/pyproject.toml

@@ -0,0 +1,31 @@
+[project]
+name = "tbr-deal-finder"
+version = "0.1.0"
+description = "Track price drops and find deals on books in your TBR list across audiobook and ebook formats."
+readme = "README.md"
+requires-python = ">=3.13"
+license = {text = "MIT"}
+dependencies = [
+    "aiohttp>=3.12.14",
+    "audible>=0.10.0",
+    "click>=8.2.1",
+    "duckdb>=1.3.2",
+    "pandas>=2.3.1",
+    "questionary>=2.1.0",
+    "tqdm>=4.67.1",
+    "unidecode>=1.4.0",
+]
+
+[project.scripts]
+lotad = "lotad.cli:cli"
+
+[tool.setuptools.package-data]
+"lotad" = [
+    "queries/**/*.sql",
+    "reports/*.j2",
+    "data/*.json"
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

tbr_deal_finder-0.1.0/tbr_deal_finder/__init__.py

@@ -0,0 +1,9 @@
+import os
+from pathlib import Path
+
+__VERSION__ = "0.1.0"
+
+QUERY_PATH = Path(__file__).parent.joinpath("queries")
+
+TBR_DEALS_PATH = Path.home() / ".tbr_deal_finder"
+os.makedirs(TBR_DEALS_PATH, exist_ok=True)