orgmdb.el
Tools for managing your watchlist in org-mode and some functions for interacting with OMDb API.
Installing
Download the orgmdb.el
and put it into your load path, then you can use it by (require 'orgmdb)
.
Another option is to use use-package
and quelpa
:
(use-package orgmdb
:ensure t
:quelpa (orgmdb
:fetcher github
:repo "isamert/orgmdb.el"))
Planned to be released on MELPA.
Demo
Displaying detailed movie information
Filling movie metadata
Opening a local video
Configuration
You need get yourself an API key to be able to use this package, see OMDb website. After getting yourself an API key, you can start using.
(setq orgmdb-omdb-apikey "YOUR-API-KEY")
Interactive usage
orgmdb.el
offers several actions that you can call upon a movie/show/episode objects. These actions can be accessed by calling orgmdb-act
function. A movie/show object is simply an org header with a tag, like the following:
* Crouching Tiger, Hidden Dragon (2000) :movie:
* Succession (2018-) :series:
You can put your cursor on one of the headers and call orgmdb-act
. From the menu, you can select Fill movie properties
to pull movie metadata under the :PROPERTIES:
drawer of the selected header. From now on, you can use other actions defined under the orgmdb-act
menu.
An episode object is a special one, because it can be either a header containing an episode marker object (meaning something like S02E05
) with an :episode:
tag:
* Succession (2018-) :series:
** S01E08 - Prague :episode:
or it can be simply an episode marker object:
* Succession (2018-) :series:
- ...
- I watched S01E08 yesterday and it was cool.
- ^^^^^^ here is our episode marker object
In both cases, if your cursor is on the episode object, orgmdb-act
will understand the context and show the actions accordingly.
Here are the actions and their simple explanations:
Fill properties
- Fill the metadata of the current object.
Show detailed info
- Open a nicely formatted org buffer and display a detailed info of the current object with a small poster of it.
Select an episode...
- Select an episode of the currently focused show and act on it.
Open local video
- Find the local video file containing the current movie/show/episode. It searches video files under
orgmdb-video-dir
and looks for files withorgmdb-video-file-extensions
extensions.orgmdb-player-function
is used for opening the video file.
Defining new actions
You can define new actions for movie/show/episode objects using orgmdb-defaction
function. See the following example:
(orgmdb-defaction
:name 'show-info
;; ^ Define a unique name for this action
:definition "Show title of the currently selected object"
;; ^ User-facing definition of the action
:on '(movie show episode)
;; ^ On what objects this action should appear?
:act (cl-function
(lambda (type &key title imdb-id episode &allow-other-keys)
(message "The title is %s, imdb-id is %s" title imdb-id))))
Library usage
(let ((movie (orgmdb :title "in the mood for love")))
(format "Movie name: %s, Year: %s, Plot: %s"
(orgmdb-title movie)
(orgmdb-year movie)
(orgmdb-plot movie)))
(orgmdb :title "thinking of ending things" :year 2020)
;; This returns something like this:
((Title . "I'm Thinking of Ending Things")
(Year . "2020")
(Rated . "R")
(Released . "04 Sep 2020")
(Runtime . "134 min")
(Genre . "Drama, Thriller")
(Director . "Charlie Kaufman")
(Writer . "Charlie Kaufman (written for the screen by), Iain Reid (based on the book by)")
(Actors . "Jesse Plemons, Jessie Buckley, Toni Collette, David Thewlis") (Plot . "Full of misgivings, a young woman travels with her new boyfriend to his parents' secluded farm. Upon arriving, she comes to question everything she thought she knew about him, and herself.")
(Language . "English, Spanish")
(Country . "USA") ...)