The CLI version of my movie diversity function.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
data
images
lambda
utils
.gitignore
README.md
index.js
package-lock.json
package.json

README.md

Movie Gender Diversity CLI

This is a CLI tool for determining the breakdown by gender of a movie. I grab the data from the Movie DB, a website similar to IMDB but with an API.

How to use it

You can install the application globally on your system from npm with the command npm install movie-diversity-cli -g.

Download Instructions

Then to actually use the script you can call it by movie-diversity get "movie name". If you're searching for a movie with multiple words in the title you'll need to surround the title with quotes.

example call

Here's an example response you might get:

response

You can also get a random movie by movie-diversity random. Omitting arguments to the function will also result in this call.

example call for a random movie

If you don't want to install it globally you can use npx to create a temporary install: npx movie-diversity-cli. npx call example

How it works

The process of creating an 'analysis' kicks off with a movie title. This title is fed into the MovieDB search API after which the bot selects the first movie listed. Once there is a movie associated with the request, the program grabs the cast members and aggregates the genders of the first 20 cast members.

This is done in an Amazon Lambda function. You can see code for that process under lambda/. If you want to run the Lambda code yourself, you'll need to grab your own API key from the MovieDB.

The cast members are billed according to importance, so choosing the top 20 should lead to a accurate study, as minor characters with little screen time are not as relevant (though definitely still important!) The output distribution is then displayed to the user.

For picking a random movie the program makes a call to a Datasette JSON API with a list of a 100 popular movies. From there it filters the list to only movies from after 1975, in order to make sure that we have enough data for an analysis. It then picks a random movie from that list and feeds it into the main function.

The future

  • Expand analysis to include ethnicity information as well, in addition to other groups
  • Have more detailed error messages, including ones for when the movie was actually found, but did not have enough cast members for an analysis

Credits

I'd like to thank Tim Pettersen for their tutorial on how to build a CLI tool in Node, The Movie DB for providing such a useful API, and Carbon for providing an easy way to create instruction images.

the movie db