Reference

Classes

Main classes provided by the package

Author: This object stores the information about an author.
Book: This model stores all row data read from goodreads_export.csv file.
Narrator: The Narrator model stores information about a narrator found in the “Additional Authors” column

Methods for the Author class

Author.display_name: Provides either the Author’s full real name, or their nom de plume
Author.first_name: Gives access to the Author’s first name if available, else “”
Author.last_name: Gives access to the Author’s last name if available, else their nom deplume
Author.last_first_name: Generates the Author’s name as “Last Name, First Name”
Author.is_pen_name
Author.real_name
Author.slug: Generates a slug string format: ‘last-first’ using active name.

Methods for the Book class

Book.title: Gives the title of the book, excluding series name and position
Book.original_title: Gives the original book title with additional spaces removed.
Book.series: Gives access to the Series Model
Book.is_a_crossover: This is True if the book belongs to more than a single series.
Book.is_series_collection: This is True if the book is a collection containing more than one book from a single series
Book.is_single_book: This is True if the book is part of a single series and is not a collection.
Book.is_a_stand_alone_book: This is a standalone book. Does not belong to any series

Methods for the Narrator class

Narrator.full_name: Gives access to Narrator’s Full Name
Narrator.first_name: Gives access to the Narrator’s first name if available, else “”
Narrator.last_name: Gives access to the Narrator’s last name if available, else their nom deplume
Narrator.slug: Gives an http safe slug based on the narrator’s full name. lastname-firstname
Narrator.name_with_short_tag: Gives narrator’s full name with short tag
Narrator.name_with_long_tag: Gives narrator’s full name with long tag

io.load_csv(): Loads and parses a Goodreads CSV file return a list of Books
io.export_to_stream(): Writes the book data directly into an open file-like stream (file or stdout).
io.NameFormatter: This Enum helps control the formatting of Narrator names.