imdblit

README

IMDB literature.list wrapper

A small library for processing an exported IMDB literature.list database file.

This library was created for my own ebook toolchain, so it contains features only for that purpose; fetching movies that are adaptations of novels.

Usage

A basic example might be:

package main

import (
	"fmt"
	"os"

	"github.com/mrcook/imdblit"
)

func main() {
	imdbFile, err := os.Open("./literature.list")
	if err != nil {
		panic(err)
	}
	db := imdblit.NewIMDB(imdbFile)

	movies, err := db.FindMovieAdaptations("A Christmas Carol", "Charles Dickens")
	if err != nil {
		panic(err)
	}
	for _, movie := range movies {
		fmt.Printf("%d: %s\n", movie.Year, movie.Title)
	}
}

LICENSE

Copyright (c) 2018-2023 Michael R. Cook. All rights reserved.

This work is licensed under the terms of the MIT license. For a copy, see https://opensource.org/licenses/MIT.

Documentation

Overview

Package imdblit provides the ability to search an IMDB literature.list database file, decoding each record to a set of Go structs.

Index

• type IMDB
  • func NewIMDB(r io.Reader) *IMDB
  • func (db *IMDB) DatabaseCreatedOn() time.Time
  • func (db *IMDB) ExtractAll() ([]movie.Movie, error)
  • func (db *IMDB) FindMovieAdaptations(title, author string) ([]movie.Movie, error)
  • func (db *IMDB) TotalRecordCount() int

Types

type IMDB

type IMDB struct {
	// contains filtered or unexported fields
}

An IMDB reads and processes movie records values from an input stream.

func NewIMDB

func NewIMDB(r io.Reader) *IMDB

NewIMDB returns a new IMDB that reads from r.

func (*IMDB) DatabaseCreatedOn

func (db *IMDB) DatabaseCreatedOn() time.Time

DatabaseCreatedOn will contain the datetime that the DB file was generated, once the .list has been parsed.

func (*IMDB) ExtractAll

func (db *IMDB) ExtractAll() ([]movie.Movie, error)

ExtractAll processes the DB and returns all movies and associated data.

func (*IMDB) FindMovieAdaptations

func (db *IMDB) FindMovieAdaptations(title, author string) ([]movie.Movie, error)

FindMovieAdaptations processes the DB and returns movies that are adaptations of the given book title/author.

The search will only parse the book types: ADPT, BOOK, and NOVL, which will speed up the processing considerably.

func (*IMDB) TotalRecordCount

func (db *IMDB) TotalRecordCount() int

TotalRecordCount will contain the total number of records found in the file, once the .list has been parsed.