goodreads-metadata-scraper

Crates.iogoodreads-metadata-scraper
lib.rsgoodreads-metadata-scraper
version0.2.0
sourcesrc
created_at2024-11-15 08:09:57.828683
updated_at2024-11-17 10:53:48.710096
descriptionA simple library to scrape book metadata from Goodreads
homepagehttps://github.com/tiago-cos/goodreads-metadata-scraper
repositoryhttps://github.com/tiago-cos/goodreads-metadata-scraper
max_upload_size
id1448870
size69,632
Tiago Costa Sousa (tiago-cos)

documentation

README

Goodreads Metadata Scraper

An async Rust library to fetch and scrape book metadata from Goodreads by using an ISBN, Goodreads book ID, or a combination of title and author. This library is useful for applications that need book data from Goodreads without access to an official API.

Features

  • Retrieve metadata by ISBN
  • Retrieve metadata by Goodreads ID
  • Retrieve metadata by title (optionally with author for better accuracy)
  • Structured metadata output with fields such as title, author, publication year, and more
  • Query builder pattern for flexible request customization

Installation

Add this crate to your Cargo.toml:

[dependencies]
goodreads-metadata-scraper = "0.1.0"

Usage

Here are a few examples of how to use the library. The primary entry point is MetadataRequestBuilder, which allows you to specify search criteria before calling execute to fetch metadata.

Fetching Metadata by ISBN

use grscraper::MetadataRequestBuilder;

let isbn = "9780141381473";
let metadata = MetadataRequestBuilder::default()
    .with_isbn(isbn)
    .execute()
    .await?
    .expect("Book not found");

assert_eq!(metadata.title, "The Lightning Thief");
println!("{:?}", metadata);

Fetching Metadata by Goodreads ID

use grscraper::MetadataRequestBuilder;

let goodreads_id = "175254";
let metadata = MetadataRequestBuilder::default()
    .with_id(goodreads_id)
    .execute()
    .await?
    .expect("Book not found");

assert_eq!(metadata.title, "Pride and Prejudice");
println!("{:?}", metadata);

Fetching Metadata by Title and Author

For better accuracy, you can also specify an author along with the title:

use grscraper::MetadataRequestBuilder;

let title = "The Last Magician";
let author = "Lisa Maxwell";
let metadata = MetadataRequestBuilder::default()
    .with_title(title)
    .with_author(author)
    .execute()
    .await?
    .expect("Book not found");

assert_eq!(metadata.title, title);
println!("{:?}", metadata);

Error Handling

This crate uses a custom error type, ScraperError, which handles errors that may occur during the metadata fetching and parsing process. ScraperError includes:

  • FetchError: Errors during HTTP requests (from reqwest)
  • ParseError: HTML parsing errors (from scraper)
  • SerializeError: JSON serialization errors (from serde_json)

Limitations

  • As this library relies on web scraping, any changes in Goodreads' HTML structure may break functionality.
  • This library is intended for personal or small-scale use, as frequent requests to Goodreads may be rate-limited.

Note: When running tests, it is highly recommended to run them with the --test-threads=1 flag to avoid rate-limiting issues with Goodreads.

License

This project is licensed under the GNU General Public License (GPL). See the LICENSE file for more details.


This library provides an accessible alternative for retrieving Goodreads book metadata, enabling developers to integrate Goodreads data without an official API. Feel free to contribute by submitting issues or pull requests!

Commit count: 10

cargo fmt