goodreads-normalizer
  • Reference

Skills

A skill is a package of structured files that teaches an AI coding agent how to work with a specific tool or framework. The skill below was generated by Great Docs from this project’s documentation. Install it in your agent and it will be able to run commands, edit configuration, write content, and troubleshoot problems without step-by-step guidance from you.

Any agent — install with npx:

npx skills add https://bas-man.github.io/goodreads-normalizer/

Codex / OpenCode

Tell the agent:
Fetch the skill file at https://bas-man.github.io/goodreads-normalizer/skill.md and follow the instructions.

Manual — download the skill file:

curl -O https://bas-man.github.io/goodreads-normalizer/skill.md

Or browse the SKILL.md file.

SKILL.md

---
name: goodreads-normalizer
description: >
  Add your description here. Use when writing Python code that uses the goodreads_normalizer package.
license: MIT
compatibility: Requires Python >=3.12.
---

# goodreads_normalizer

Add your description here

## Installation

```bash
pip install goodreads-normalizer
```

## API overview

### 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

### Author Methods

Methods for the Author class

- `Author.display_name`
- `Author.first_name`
- `Author.last_name`
- `Author.last_first_name`
- `Author.is_pen_name`
- `Author.real_name`
- `Author.slug`

### Book Methods

Methods for the Book class

- `Book.title`
- `Book.original_title`
- `Book.series`
- `Book.is_a_crossover`
- `Book.is_series_collection`
- `Book.is_single_book`
- `Book.is_a_stand_alone_book`

### Narrator Methods

Methods for the Narrator class

- `Narrator.full_name`
- `Narrator.first_name`
- `Narrator.last_name`
- `Narrator.slug`
- `Narrator.name_with_short_tag`
- `Narrator.name_with_long_tag`

### I/O Utilities

- `io.load_csv`
- `io.export_to_stream`
- `io.NameFormatter`

## Resources

- [Full documentation](https://bas-man.github.io/goodreads-normalizer/)
- [llms.txt](llms.txt) — Indexed API reference for LLMs
- [llms-full.txt](llms-full.txt) — Comprehensive documentation for LLMs
- [Source code](https://github.com/Bas-Man/goodreads-normalizer)

Developed by Adam.S.
Site created with Great Docs.