minsci.xmu.tools.multimedia package

Submodules

minsci.xmu.tools.multimedia.cataloger module

Summarizes and generates metadata for the objects in an ecatalogue export

class minsci.xmu.tools.multimedia.cataloger.Cataloger(*args, **kwargs)

Bases: minsci.xmu.xmu.XMu

Contains methods to generate metadata for a set of catalog objects

get(identifier, default=None, ignore_suffix=False)

Retrieves catalog data matching a given identifier

get_one(identifier, default=None, ignore_suffix=False)

static index_identifier(identifier)

Indexes identification numbers from a catalog record

is_attached(mul_irn, cat_irn)

Tests if multimedia is already linked in a catalog record

iterate(element)

Indexes the objects in an EMu export file

pprint(pause=False)

Pretty prints the catalog dictionary

class minsci.xmu.tools.multimedia.cataloger.Mediator(*args, **kwargs)

Bases: minsci.xmu.xmu.XMu

get(key)

iterate(element)

Placeholder for iteration method

match_one(fn)

minsci.xmu.tools.multimedia.cataloger.descriptify(summary)

Converts a summary dict to a Description

minsci.xmu.tools.multimedia.cataloger.full(rec)

minsci.xmu.tools.multimedia.cataloger.minimize(rec)

minsci.xmu.tools.multimedia.cataloger.summarify(rec)

minsci.xmu.tools.multimedia.embedder module

Tools to embed metadata in image files

class minsci.xmu.tools.multimedia.embedder.EmbedField(name, length, function)

Bases: tuple

function

Alias for field number 2

length

Alias for field number 1

name

Alias for field number 0

class minsci.xmu.tools.multimedia.embedder.Embedder(output_dir, overwrite=True)

Bases: object

Tools to embed metadata in image files

change_output_directory(output_dir)

Change the output directory

derive_metadata(rec, include_empty=False)

Derives image metadata from source data

embed_metadata(rec, path, new_name=None)

Embed metadata in the image file at the specified path

Parameters:

• path (str) – path to the image file
• rec (dict) – metadata about the image
• verify (bool) – specifies whether to verify image after embedding

Returns:

Boolean indicating whether embed succeeded

get_caption(rec)

Placeholder function returning the caption

get_copyright(rec)

Placeholder function returning copyright info

get_creator(rec)

Placeholder function returning the creator

get_credit_line(rec)

Placeholder function returning the credit line

get_date_created(rec)

Placeholder function returning the date created

get_datetime_created(rec)

Placeholder function returning the full date and time created

get_headline(rec)

Placeholder function returning the headline

get_inventory_numbers(rec)

Placeholder function returning the headline

get_job_id(rec)

Placeholder function returning the job ID

get_keywords(rec)

Placeholder function returning keywords

get_mtime(path, mask='%Y:%m:%d %H:%M:%S%z')

Get modification time for file at path

get_object_name(rec)

Placeholder function returning the object name

get_source(rec)

Placeholder function returning the media source

get_special_instructions(rec)

Placeholder function returning special instructions

get_subjects(rec)

Placeholder function returning subject codes

get_time_created(rec)

Placeholder function returning the time created

get_transmission_reference(rec)

Placeholder function returning the transmission reference

minsci.xmu.tools.multimedia.hasher module

Contains methods to hash a file or image data from a file

minsci.xmu.tools.multimedia.hasher.hash_file(path)

Returns MD5 hash of a file

Parameters:path (str) – path to image Returns:Hash as string

minsci.xmu.tools.multimedia.hasher.hash_image_data(path, output_dir='images')

Returns MD5 hash of the image data in a file

Parameters:path (str) – path to image file Returns:Hash of image data as string

minsci.xmu.tools.multimedia.hasher.hasher(filestream, size=8192)

Generate MD5 hash for a file

Parameters:

• filestream (file) – stream of file to hash
• size (int) – size of block. Should be multiple of 128.

Returns:

Tuple of (filename, hash)

Module contents

Provides tools to create and embed metadata in images