Skip to main content

CLI commands to catalogue all your movie reviews

Project description

   __  ______  __      ___     __
  /  |/  /| | / /      | | /| / /
 / /|_/ / | |/ /       | |/ |/ / 
/_/  /_/o |___/ie revie|__/|__/ 

Fastfetch inspired movie reviews

Catalogue your own movie review inside your terminal.

Python License

pipx install mvw


  ▁▁     ╭─────────────────────────────────────╮
 ▁▁▁│    │ These are some demos when using MVW │
┌┘└ ░▌   ╰─────────────────────────────────────╯
╚═══╝    F: Psst.. his name is MOAI (nice to meet u)                                     

Interactive

Default usage where you will get to experience the full experience of MVW. You will get to search, rate, review and also save your review. Every reviews will be saved in your local machine!

Interactive Command

List

You will get to see every past reviews that you had done in a simple interface supported by iterfzf) which uses the "Fuzzy Search"

List Command

Config

Everything that you can see in the config list can be configurable. From the poster_width, theme, your name, and even worldwide-boxoffice feature

Config Command

Theme

NOTE: Some browser not fully support nerdfont rendering of svg, you can see below if it is supported.

  • Gruvbox (The Default Theme) Gruvbox

  • Catppuccin Catpuccin

  • Nord Nord


Features

Features Notes
Auto fetch movie data Uses OMDb API behind the hood to fetch movie data fast
Pixelated poster Unique way to view the poster (fully intentional)
Configurable poster size Can change the poster width
Review history All review are saved in a database
Autocomplete Provided by the Typer library
Themes Gruvbox, Catppuccino, Nord
Save Review The review can be saved in svg format with the theme
Worldwide Boxoffice Use webscrap tech to find the global box office
Half-star Rating Support 0.5 star rating
Review Editor Use default editor to edit review
Caching Poster No need to download the poster everytime fetching
Easy update When searching same movie, will use past review
Reset Config Default to the factory setting with single command
Moai help Fun gimmick to help you in the process (can be hide dont worry)
  ▁▁     ╭─────────────────────────╮
 ▁▁▁│    │ Why am I at the bottom? │
┌┘└ ░▌   ╰─────────────────────────╯
╚═══╝    F: Cause heroes appear last.. right..                                  

Motivation

I have a deep interest in TUI/CLI and also movie in general. I also have a vault in Obsidian where I catalogue movies that I watch but you know how it goes.. (Legend says that it was still there waiting for me :D) At first, as someone like me whose personality (TUI + Movie) will obviously create a movie player that does everything (find, torrent, play, and done) which has already been done so many times. So instead I just want to make something different and that's where I (finally) remember about my Obsidian movie catalogue. Then the code begins..

And also, I just want to learn new things :)


Installation

Method Command
pipx (recommended) pipx install mvw
uv uv tool install mvw
pip pip install mvw

NOTE: This CLI require a nerdfont to have the icon fully showed --> This repo seems legit way to install nerdfont but its up to you how to install, google it, you got this!

Usage

mvw

CLI

# Configure
mvw config -h

# All configure settings
mvw config --api-key "OMDB API key"       # Required
mvw config --name "Name"                  # Optional
mvw config --poster-width 30
mvw config --theme "gruvbox"
mvw config --moai                         # Toggle
mvw config --review                       # Toggle
mvw config --worldwide-boxoffice          # Toggle
mvw config --reset                        # Toggle

# List all reviewed movies
mvw list

# Preview the reviewed movies
mvw preview --id "ttxxxxxx"
mvd preview --title "Inception"

# Delete the reviewed movies
mvw delete --id "ttxxxxxx"
mvd delete --title "Inception"

Configuration

Settings are atuomatically configured using mvw config

FAQ

  ▁▁     ╭─────────────────╮
 ▁▁▁│    │ Why am I here?  │
┌┘└ ░▌   ╰─────────────────╯
╚═══╝     F: Just for fun i guess

Why does the poster pixelated?

During the early build of the project, I could not figure out a way to pipe a kitty image into the iterfzf preview section. It took a long time to process so I try another method which is using rich_pixel library which supports rich and also works on every OS. As of now, thats what I could think of to solve it. TLDR: you can think it as the intended style

Why do I need to register an API key?

Short answer: It's easier for me to implement and it's very fast!

Long answer: During the early build, I tried to use an API from TMDb, however I found that the registering process are quite intimidating. Then, I found OMDb (which is almost the same as TMDb but easier API key registration). Later down the road, I also tried a no-API-key path Cinemagoer. However, I couldn't (as of now) make it work yet. Naybe in the future, another non-API option will arise?!

Who is MOAI?

It is just a console.print that I decided to add a face. I choose Moai because, the emoji 🗿 is just too perfect and one of my friends has used it during the phonk era (a lot). The emoji name is also MOAI so I thought why not just MO(AI) it. Same to LLM in Ollama, just too good to not use.


Inspiration

mvw is built with Typer and inspired by:

  • fastfetch - Visual system information Display.

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mvw-0.1.0.tar.gz (15.0 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mvw-0.1.0-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file mvw-0.1.0.tar.gz.

File metadata

  • Download URL: mvw-0.1.0.tar.gz
  • Upload date:
  • Size: 15.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mvw-0.1.0.tar.gz
Algorithm Hash digest
SHA256 fdf4841d634230b2725788d5113045e9c1729eda322a63bbd10b96ca75ddcc85
MD5 39a5bab672381429c2eabe25d770353d
BLAKE2b-256 6ffd358a3ac95b53a82e6a8f9fa4d8a12d97849e439c7697e41c53fc97bcbed6

See more details on using hashes here.

File details

Details for the file mvw-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: mvw-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for mvw-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a67f0fcad98f1eeebae8f78d895126198dfdb62a9e8f59c9a8ede3409816d22
MD5 fdb7dbe2f61cd4114a280e6931af5044
BLAKE2b-256 51eee1fcb2475f925758361bf5947ce6dfbf02b5dae8b885db22177fc6d0b320

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page