2021-01-16 - I'm archiving this project. I may pick it back up at a later date, but if I do so, it'll be under the ProseGrinder org under a new repo and not my personal account.
A free, lightweight text analytics library for prose fiction.
Bookworm is an attempt to discover relevant statics in fiction. An initial experiment, developed in Python and NLTK, is hosted at https://bookworm.davidlday.com, and demonstrates some initial findings at discovering basic editor preference across 10 relatively popular and well-respected SF/F/H magazines.
The goal of this library is to encourage the application of practical, meaningful statistical analysis in the submission process, a critical part of the publishing value chain, and to provide a foundation for creating an open platform for analysing prose fiction.
This library is written in Java, uses Maven as its build mechanism, and has minimal dependencies. It is constructed from the ground up to target specific elements of fiction, such as words instead of general tokens, structure, point of view, and dialogue.
The main class is com.prosegrinder.bookworm.util.Prose, which takes a single block of text (short story, novel, etc) as the argument to its constructor, and provides methods for getting at all of the underlying elements and statistics.
Also included is a com.prosegrinder.bookworm.util.ReadabilityScores class, which provides a consistent set of readability statitics. In my research, I found variation among publicly accessible formulas which could lead to inconsistent results.
A sister project, bookworm-restserver, wraps this library in a self-contained, deployable REST API for easy use across various languages. See that project for more details on plans around the REST API.
Binary downloads available at: https://github.com/davidlday/bookworm/releases
WIKI: https://github.com/davidlday/bookworm/wiki
Issue tracker: https://github.com/davidlday/bookworm/issues
- Java (JDK) 1.8+
- Apache Maven 3+
- Internet access
git clone https://github.com/davidlday/bookworm.git bookworm
cd bookworm
mvn clean compile test install
This will put the library in your local Maven repository.
- Bookworm is a free library, but still considered experimental.
- I'm not currently accepting pull requests, but will entertain feature suggestions. Pull requests will be welcome once the core library is relatively stable.