Simple CLI for your Monzo account.
Project description
monz
Simple CLI for your Monzo account.
Installation
Since monz
is a command line tool, the recommended installation method is via pipx:
$ pipx install monz
Of course, you can just install it directly from PyPI (ideally, inside a virtualenv):
$ python -m pip install monz
Quick start
Authentication
Before you can access your Monzo account details through monz
, you need to
authenticate it. You can do that with a (temporary) access token (for example, from
the Monzo Developer Portal), or go through a one time OAuth setup that will save
the token on disk and automatically refresh it when it expires.
To do the latter, you should first create an OAuth client in Monzo developer tools
(with the "Redirect URL" set to http://localhost:6600/monz
) and run the
monz authorize
command with the obtained client ID and client secret.
For more information, please take a look at: https://monz.pawelad.dev/en/latest/getting_started/#authentication
Usage
The default subcommand is info
, which shows your account balance and its
latest transaction:
$ monz
Balance: £203.78
Total balance: £303.78
Currency: GBP
Spend today: £4.20
Local currency: THB
Local exchange rate: 45.558219
Last transaction:
-£17.29 | MomCorp
ID: tx_0000Lxo9IgPERj43i03iKH
Description: MomCorp
Amount: -£17.29
Currency: GBP
Category: general
Notes: ✨
Created: Feb 12, 3024, 12:39:22 PM
Settled: Feb 13, 3024, 1:36:48 AM
You can view all linked accounts:
$ monz accounts
Account 'acc_87539319' (GB)
ID: acc_87539319
Description: user_1729
Currency: GBP
Account Number: 0101100101
Sort Code: 04-00-04
Type: uk_retail
Closed: No
Created: Dec 31, 2999, 11:59:59 PM
If you have only one (active) account, it will be used everywhere by default.
If you have more, you'll have to pass its ID explicitly when needed via the
--account_id
option.
Finally, you can see your latest transactions:
$ monz transactions -n 2
-£17.29 | MomCorp
ID: tx_0000Lxo9IgPERj43i03iKH
Description: MomCorp
Amount: -£17.29
Currency: GBP
Category: general
Notes: ✨
Created: Feb 12, 3024, 12:39:22 PM
Settled: Feb 13, 3024, 1:36:48 AM
-£100.00 | pot_0000aDhHH8z3jvram0L0Di
ID: tx_0000FskkLc0KB7aK0SV4cd
Description: pot_0000aDhHH8z3jvram0L0Di
Amount: -£100.00
Currency: GBP
Category: savings
Created: Feb 6, 3024, 10:49:22 AM
Settled: Feb 6, 3024, 10:49:22 AM
You can see all available subcommands and options by running monz --help
(or adding
--help
to any subcommand).
Authors
Developed and maintained by Paweł Adamczak.
Source code is available at GitHub.
If you'd like to contribute, please take a look at the contributing guide.
Released under Mozilla Public License 2.0.
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
Built Distribution
File details
Details for the file monz-1.0.0.tar.gz
.
File metadata
- Download URL: monz-1.0.0.tar.gz
- Upload date:
- Size: 11.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f97cfd4d045e3f2c6c203471424fdbe188fa283f614626fbafc5a46c553c836c |
|
MD5 | fd079389f512674b8598ce9eb5e365de |
|
BLAKE2b-256 | 98138538832c25e80269a6e507e8dcf0cb305ae3cbe44c348d2fa652403070f1 |
File details
Details for the file monz-1.0.0-py3-none-any.whl
.
File metadata
- Download URL: monz-1.0.0-py3-none-any.whl
- Upload date:
- Size: 12.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.3
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | f9d804b3601b2df6a0584a4f1419f429c1b9d4e4986d244be1f2016da70d67ff |
|
MD5 | 53da58e0992ebf3614c1ebaa2b2bc156 |
|
BLAKE2b-256 | ecebd1d58e8183806f33dd0ac1b4c35e2f09fd6a657c38f2ce7aa6071bf906dc |