Skip to content

HarimbolaSantatra/mm-cli

Repository files navigation

MMCLI

MMCLI is a command line malagasy encyclopedia and dictionary. It makes a request to malagasyword.org and use Beautiful Soup to parse the HTML result.

Screenshot

screenshot

Setup

The the latest release is the only stable version. Everything else is a work-in-progress as this project still has many in-progress or unresolved issues.

From the release

  1. Download the latest release and copy BOTH the binary (mm) and the scraping script (mm-parsing) to your PATH.
  2. Setup a python virtual environment (See below)
  3. ./mm health

From source

Go is required. Follow the installation instructions if it's not installed yet.

  1. Clone the repo: git clone https://github.com/HarimbolaSantatra/mm-cli
  2. Setup a python virtual environment. For example:
mkdir ~/.python-venv
python3 -m venv ~/.python-venv/bs4
source ~/.python-venv/bs4/bin/activate
python3 -m pip install -r requirements.txt
  1. Build and install the executable and the parsing script: make install
  2. Run the tests: make test
  3. Test: mm health

Usage

View existing commands:

./mm help
A client for searching malagasy words, proverbs and misc

Usage:
  mm [flags]
  mm [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  health      Check health of malagasyword.org and the HTTP client
  help        Help about any command
  search      Search for a word
  version     Print version number

Flags:
  -h, --help   help for mm

Use "mm [command] --help" for more information about a command.

Examples

  • Search for a word: ./mm search "rafozana"

Acknowledgment