Metadata-Version: 2.0
Name: monz
Version: 0.2.0
Summary: Simple (and awesome) command line interface for quickly accessing your (equally awesome) Monzo account info, its current balance, latest transactions, etc.
Home-page: https://github.com/pawelad/monz
Author: Paweł Adamczak
Author-email: pawel.ad@gmail.com
License: MIT License
Download-URL: https://github.com/pawelad/monz/releases/latest
Keywords: monzo cli
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: End Users/Desktop
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Utilities
Requires-Dist: Babel (>=2.3.4)
Requires-Dist: click (>=6.6)
Requires-Dist: click-default-group (>=1.2)
Requires-Dist: pymonzo (>=0.2.1)
Provides-Extra: testing
Requires-Dist: pytest; extra == 'testing'

Monz
====

|Build status| |Test coverage| |PyPI version| |Python versions|
|License|

Simple (and awesome) command line interface for quickly accessing your
(equally awesome) Monzo account info, its current balance, latest
transactions, etc.

It uses `pymonzo <https://github.com/pawelad/pymonzo>`__ and its
authentication system in the background so you should to read the `auth
section <https://github.com/pawelad/pymonzo#authentication>`__ there
first.

Installation
------------

>From PyPI:

::

    $ pip install monz

Usage
-----

First, you need to authenticate either via an `access
token <https://github.com/pawelad/pymonzo#access-token>`__ or `OAuth
2 <https://github.com/pawelad/pymonzo#oauth-2>`__.

Everything else should be pretty straightforward:

::

    $ monz --help 
    Usage: monz [OPTIONS] COMMAND [ARGS]...

      Simple command line interface for quickly accessing your Monzo account
      info, current balance, latest transactions, etc.

      See https://github.com/pawelad/monz for more info.

    Options:
      -t, --access-token TEXT  Monzo API access token.
      --help                   Show this message and exit.

    Commands:
      accounts      Show connected Monzo accounts
      balance       Show Monzo account balance
      transactions  Show Monzo account transactions

Examples
--------

You can view your linked accounts:

::

    $ monz accounts    
    Account #1, Bender Rodríguez
    ID:          acc_2716057
    Created:     Dec 31, 2999 11:59 PM

If you have only one then it will become the default one, but if you
have more then you have to pass its ID explicitly to other subcommands.

You can view your current balance, which is also the default subcommand:

::

    $ monz balance
    Balance:     £17.29
    Spent today: £0.00

    $ monz       
    Balance:     £17.29
    Spent today: £0.00

Lastly, you can see your latest transactions:

::

    $ monz transactions -n 2
    -£50.00 | Robot Arms Apartments (New New York)
    Category:    Bills
    Date:        Nov 18, 3016 11:09 PM

    -£9.20 | Fronty's Meat Market (New New York)
    Category:    Grocieries
    Date:        Nov 17, 3016 8:31 AM

Tests
-----

Package was tested with the help of ``py.test`` and ``tox`` on Python
2.7, 3.4, 3.5 and 3.6 (see ``tox.ini``).

Code coverage is available at
`Coveralls <https://coveralls.io/github/pawelad/monz>`__.

To run tests yourself you need to set environment variables with access
token before running ``tox`` inside the repository:

.. code:: shell

    $ pip install requirements/dev.txt
    $ export MONZO_ACCESS_TOKEN='...'
    $ tox

Contributions
-------------

Package source code is available at
`GitHub <https://github.com/pawelad/monz>`__.

Feel free to use, ask, fork, star, report bugs, fix them, suggest
enhancements, add functionality and point out any mistakes.

Authors
-------

Developed and maintained by `Paweł
Adamczak <https://github.com/pawelad>`__.

Released under `MIT
License <https://github.com/pawelad/monz/blob/master/LICENSE>`__.

.. |Build status| image:: https://img.shields.io/travis/pawelad/monz.svg
   :target: https://travis-ci.org/pawelad/monz
.. |Test coverage| image:: https://img.shields.io/coveralls/pawelad/monz.svg
   :target: https://coveralls.io/github/pawelad/monz
.. |PyPI version| image:: https://img.shields.io/pypi/v/monz.svg
   :target: https://pypi.python.org/pypi/monz
.. |Python versions| image:: https://img.shields.io/pypi/pyversions/monz.svg
   :target: https://pypi.python.org/pypi/monz
.. |License| image:: https://img.shields.io/github/license/pawelad/monz.svg
   :target: https://github.com/pawelad/monz/blob/master/LICENSE


