Metadata-Version: 2.1
Name: Monzo-API
Version: 1.1.0
Summary: Package to interact with the API provided by Monzo bank
Home-page: https://github.com/petermcd/monzo-api
Author: Peter McDonald
Author-email: git@petermcdonald.co.uk
Project-URL: Bug Tracker, https://github.com/petermcd/monzo-api/issues
Project-URL: Documentation, https://monzo-api.readthedocs.io
Project-URL: Source, https://github.com/petermcd/monzo-api
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Intended Audience :: Developers
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Provides-Extra: build
Requires-Dist: wheel ; extra == 'build'
Requires-Dist: build ; extra == 'build'
Provides-Extra: docs
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme ; extra == 'docs'
Provides-Extra: test
Requires-Dist: flake8 ; extra == 'test'
Requires-Dist: isort ; extra == 'test'
Requires-Dist: mypy ; extra == 'test'
Requires-Dist: pytest ; extra == 'test'
Requires-Dist: pytest-mock ; extra == 'test'

Monzo API
=====================================

The Monzo API package allows you to interact with the API provided by Monzo
bank.

DISCLAIMER
-------------------------------------

Before using this package it is important to understand that the Monzo API should only be
used for non-public projects hosted securely. Please do not use this on a public server
and do not use it for accessing other users accounts.

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

The package can be installed as a standard pip project:


.. code-block:: bash

    pip install monzo-api

Basic Usage
-------------------------------------

Prior to using the API you need to obtain a few details from Monzo. Please
read `this <https://monzo-api.readthedocs.io/en/latest/monzo_setup.html>`_
document.

Please see the examples in the example directory.

Documentation
-------------------------------------

Full documentation can be found on
`Read The Docs <https://monzo-api.readthedocs.io>`_

Implemented End Points
-------------------------------------

.. list-table:: Monzo Endpoints
    :widths: 45 30 25 25
    :header-rows: 1

    * - End Point
      - Implemented
      - Version
      - Tests Written
    * - Authentication
      - yes
      - 0.0.1
      - No
    * - Refresh Access
      - yes
      - 0.0.1
      - No
    * - Whoami
      - yes
      - 0.0.1
      - Yes
    * - Logout
      - yes
      - 0.0.1
      - Yes
    * - List Accounts
      - yes
      - 0.0.2
      - Yes
    * - Read Balance
      - yes
      - 0.0.2
      - Yes
    * - List Pots
      - yes
      - 0.0.3
      - No
    * - Deposit Into Pot
      - yes
      - 0.0.3
      - No
    * - Withdraw From Pot
      - yes
      - 0.0.3
      - No
    * - Get Transaction
      - yes
      - 0.0.4
      - No (Testing Fails)
    * - Get Transaction List
      - yes
      -  0.0.4
      - Yes
    * - Annotate Transaction
      - yes
      - 0.1.1 \*
      - Yes
    * - Create Feed Item
      - yes
      - 0.0.2
      - Yes
    * - Upload Attachment
      -
      -
      - No
    * - Register Attachment
      -
      -
      - No
    * - Deregister Attachment
      -
      -
      - No
    * - Fetch Receipt
      - yes
      - 0.1.2
      - Yes
    * - Create Receipt
      - yes
      - 0.1.2
      - Yes
    * - Delete Receipt
      - yes
      - 0.1.2
      - No, Functionality currently broken
    * - Register Webhook
      - yes
      - 0.0.3
      - Yes
    * - List Webhooks
      - yes
      - 0.0.3
      - Yes
    * - Delete Webhooks
      - yes
      - 0.0.3
      - Yes
    * - Open Banking API
      - No
      - \*\*
      -

* \* Annotations only appear to work for existing keys such as Notes `view on the forum <https://community.monzo.com/t/annotate-transaction-endpoint-not-working-for-custom-key/121203>`_.
* \*\* It is unlikely that this package will implement usage of the Open Banking API due to restrictions accessing it.
