hicues 0.1.0

Extract cue point locations from Hindenburg Journalist projects

hicues

hicues (HIndenburg CUES) is a command line helper tool for Hindenburg Journalist that reads a project file and lists the cue points and their locations on the timeline along with their names. As of October 2021, you cannot get such a list within Hindenburg Journalist itself.

By default, the program keeps running and listens to changes to the file; the output is refreshed when the file is changed.

Installation

The best way to install hicues is via pip: pip install hicues. You can alternatively install it from the source: python setup.py install.

Usage

Basic usage

Run the program in the command line using hicues path/to/myproject.nhsx. You will then see a table with the cue points in your project (if there are any). The table gets refreshed when you save the file. You can stop the program by pressing ctrl-c.

Command line parameters

For more advanced use cases, you can use some of the following parameters.

flag	option	description
-h	--help	Show the help
-t	--no-track	Don't show track names in the table-formatted output
-r	--no-region	Don't show region names in the table-formatted output
-d	--dump	Dump the list of cuepoints to output once instead of watching for changes forever
-v	--verbose	Print diagnostic messages to stderr
-j	--json	Output the results in JSON format instead of a formatted table
	--json-indent	If the output is JSON, this many spaces will be used to indent it. If not passed, everything will be on one line

Python package

The main function, get_cue_points_from_file() can be accessed by

from hicues import cue_finder
cue_finder.get_cue_points_from_file(filename)

This function returns a dictionary with the cue points ordered by their appearance on the timeline. Each cue point has four keys: timestamp, which is a datetime.time object with the location of the cue point on the timeline; name, the label associated with the cue point; region, the name of the region to which the cue point is attached; and track, showing the name of the track where the the region is located.

Contributing

Issue submissions and pull requests are welcome. Simple fixes do not require an issue to be submitted, however, do submit one if your pull request includes a lot of changes or new features.

Changelog

• 0.1.0:
  • initial public release