mzo

A (third-party) command-line interface to your Monzo account. Because Sometimes the command-line is more convenient then swiping and tapping.

This README covers the environment setup. If you are looking for the documentation and more straight forward installation instructions see the docs.

Prerequisites

At the time of writing this the project is using Python 3.10. You will need that version of python installed before starting. If you don't currently have a method of managing multiple Python versions on your machine, I would recommend checking out pyenv.

The projects dependencies are also managed by poetry. You should head over there and make sure that you also have that tool setup.

Finally I've used a package.json in my Python project (heresy I'm sure), which aggregates all ancillary project scripts together for building and deploying. Specifically I'm using the yarn package manager for these npm dependencies.

Summoning Ritual

Once you've completed the prerequisites above you should be able to bring the application to life with the following commands.

# clone the source code to your machine
$ git clone https://github.com/jamesstidard/mzo-cli

$ cd mzo-cli/

$ poetry env use /path/to/python/3.10/python
$ poetry install --with=dev

Run

$ mzo --help

Test

$ yarn test

Document

$ yarn docs:dev

Deploy mzo

$ yarn mzo:deploy

Deploy Docs

$ yarn docs:deploy