| Name | monz JSON |
| Version |
1.1.1
JSON |
| download |
| home_page | None |
| Summary | Simple CLI for your Monzo account. |
| upload_time | 2024-09-11 14:07:34 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | None |
| keywords |
monzo
cli
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# monz
[][pypi monz]
[][pypi monz]
[][rtfd monz]
[][codecov monz]
[][license]
[][black]
[][rickroll]
Simple CLI for your Monzo account.
## Installation
Since `monz` is a command line tool, the recommended installation method is via [pipx]:
```console
$ pipx install monz
```
Of course, you can just install it directly from [PyPI] (ideally, inside a
[virtualenv]):
```console
$ 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:
```console
$ 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:
```console
$ 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][pawelad].
Source code is available at [GitHub][github monz].
If you'd like to contribute, please take a look at the
[contributing guide].
Released under [Mozilla Public License 2.0][license].
[black]: https://github.com/psf/black
[codecov monz]: https://app.codecov.io/github/pawelad/monz
[contributing guide]: ./CONTRIBUTING.md
[github monz]: https://github.com/pawelad/monz
[license]: ./LICENSE
[monzo developer portal]: https://developers.monzo.com/
[monzo developer tools]: https://developers.monzo.com/
[pawelad]: https://pawelad.me/
[pipx]: https://github.com/pypa/pipx
[pypi monz]: https://pypi.org/project/monz/
[pypi]: https://pypi.org/
[rickroll]: https://www.youtube.com/watch?v=I6OXjnBIW-4&t=15s
[rtfd monz]: https://monz.rtfd.io/
[virtualenv]: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/
Raw data
{
"_id": null,
"home_page": null,
"name": "monz",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "monzo, cli",
"author": null,
"author_email": "Pawe\u0142 Adamczak <pawel.ad@gmail.com>",
"download_url": "https://files.pythonhosted.org/packages/10/b5/9dfac615f8b5b669a9a18937f9721748c4831a5c604da7646b16717c5ab6/monz-1.1.1.tar.gz",
"platform": null,
"description": "# monz\n[][pypi monz]\n[][pypi monz]\n[][rtfd monz]\n[][codecov monz]\n[][license]\n[][black]\n[][rickroll]\n\nSimple CLI for your Monzo account.\n\n## Installation\nSince `monz` is a command line tool, the recommended installation method is via [pipx]:\n\n```console\n$ pipx install monz\n```\n\nOf course, you can just install it directly from [PyPI] (ideally, inside a\n[virtualenv]):\n\n```console\n$ python -m pip install monz\n```\n\n## Quick start\n\n### Authentication\nBefore you can access your Monzo account details through `monz`, you need to\nauthenticate it. You can do that with a (temporary) access token (for example, from\nthe [Monzo Developer Portal]), or go through a one time OAuth setup that will save\nthe token on disk and automatically refresh it when it expires.\n\nTo do the latter, you should first create an OAuth client in [Monzo developer tools]\n(with the \"Redirect URL\" set to `http://localhost:6600/monz`) and run the\n`monz authorize` command with the obtained client ID and client secret.\n\nFor more information, please take a look at:\nhttps://monz.pawelad.dev/en/latest/getting_started/#authentication\n\n### Usage\nThe default subcommand is `info`, which shows your account balance and its\nlatest transaction:\n\n```console\n$ monz\nBalance: \u00a3203.78\nTotal balance: \u00a3303.78\nCurrency: GBP\nSpend today: \u00a34.20\nLocal currency: THB\nLocal exchange rate: 45.558219\n\nLast transaction:\n -\u00a317.29 | MomCorp\nID: tx_0000Lxo9IgPERj43i03iKH\nDescription: MomCorp\nAmount: -\u00a317.29\nCurrency: GBP\nCategory: general\nNotes: \u2728 \nCreated: Feb 12, 3024, 12:39:22 PM\nSettled: Feb 13, 3024, 1:36:48 AM\n```\n\nYou can view all linked accounts:\n\n```console\n$ monz accounts\n Account 'acc_87539319' (GB) \nID: acc_87539319\nDescription: user_1729\nCurrency: GBP\nAccount Number: 0101100101 \nSort Code: 04-00-04 \nType: uk_retail \nClosed: No \nCreated: Dec 31, 2999, 11:59:59 PM \n```\n\nIf you have only one (active) account, it will be used everywhere by default.\nIf you have more, you'll have to pass its ID explicitly when needed via the\n`--account_id` option.\n\nFinally, you can see your latest transactions:\n\n```\n$ monz transactions -n 2 \n -\u00a317.29 | MomCorp\nID: tx_0000Lxo9IgPERj43i03iKH\nDescription: MomCorp\nAmount: -\u00a317.29\nCurrency: GBP\nCategory: general\nNotes: \u2728 \nCreated: Feb 12, 3024, 12:39:22 PM\nSettled: Feb 13, 3024, 1:36:48 AM\n\n -\u00a3100.00 | pot_0000aDhHH8z3jvram0L0Di \nID: tx_0000FskkLc0KB7aK0SV4cd\nDescription: pot_0000aDhHH8z3jvram0L0Di\nAmount: -\u00a3100.00\nCurrency: GBP\nCategory: savings\nCreated: Feb 6, 3024, 10:49:22 AM\nSettled: Feb 6, 3024, 10:49:22 AM\n```\n\nYou can see all available subcommands and options by running `monz --help` (or adding\n`--help` to any subcommand).\n\n## Authors\nDeveloped and maintained by [Pawe\u0142 Adamczak][pawelad].\n\nSource code is available at [GitHub][github monz].\n\nIf you'd like to contribute, please take a look at the\n[contributing guide].\n\nReleased under [Mozilla Public License 2.0][license].\n\n\n[black]: https://github.com/psf/black\n[codecov monz]: https://app.codecov.io/github/pawelad/monz\n[contributing guide]: ./CONTRIBUTING.md\n[github monz]: https://github.com/pawelad/monz\n[license]: ./LICENSE\n[monzo developer portal]: https://developers.monzo.com/\n[monzo developer tools]: https://developers.monzo.com/\n[pawelad]: https://pawelad.me/\n[pipx]: https://github.com/pypa/pipx\n[pypi monz]: https://pypi.org/project/monz/\n[pypi]: https://pypi.org/\n[rickroll]: https://www.youtube.com/watch?v=I6OXjnBIW-4&t=15s\n[rtfd monz]: https://monz.rtfd.io/\n[virtualenv]: https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Simple CLI for your Monzo account.",
"version": "1.1.1",
"project_urls": {
"Documentation": "https://monz.readthedocs.io/",
"GitHub": "https://github.com/pawelad/monz",
"Homepage": "https://monz.pawelad.dev/",
"Issues": "https://github.com/pawelad/monz/issues"
},
"split_keywords": [
"monzo",
" cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9f9075feaa351c44a0af3c43b731d1df3c00f143f1765c1b30cac1c7d05d58e0",
"md5": "b7ae0aa897e9ce31473ab8bd04277155",
"sha256": "bc05cfc1591d80d9568041f1cc2e5c3a7cd437cb26a3b8ed9104e217ca5972f1"
},
"downloads": -1,
"filename": "monz-1.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b7ae0aa897e9ce31473ab8bd04277155",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 12073,
"upload_time": "2024-09-11T14:07:33",
"upload_time_iso_8601": "2024-09-11T14:07:33.229293Z",
"url": "https://files.pythonhosted.org/packages/9f/90/75feaa351c44a0af3c43b731d1df3c00f143f1765c1b30cac1c7d05d58e0/monz-1.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "10b59dfac615f8b5b669a9a18937f9721748c4831a5c604da7646b16717c5ab6",
"md5": "bea44570967545729d91aa88efafb93d",
"sha256": "4e87aca8f68d41dbeab9c71a98a19d29637bd489695c158a54696be926820dca"
},
"downloads": -1,
"filename": "monz-1.1.1.tar.gz",
"has_sig": false,
"md5_digest": "bea44570967545729d91aa88efafb93d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 11262,
"upload_time": "2024-09-11T14:07:34",
"upload_time_iso_8601": "2024-09-11T14:07:34.268626Z",
"url": "https://files.pythonhosted.org/packages/10/b5/9dfac615f8b5b669a9a18937f9721748c4831a5c604da7646b16717c5ab6/monz-1.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-11 14:07:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pawelad",
"github_project": "monz",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "monz"
}
