Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/quillfires/aioBML
Its an asynchronous Bank of Maldives (BML) API wrapper. Currently you can use this library to: • Listen to an automated event 'new_transaction' • Get the history of all your Bank of Maldives accounts. • Get details of all you BML accounts & contacts. • Add or Remove contacts. If you want to be alerted for new transactions; save the transactions to a db, check if the transaction is in the db, alert and save to db if it's not.
https://github.com/quillfires/aioBML
Last synced: 26 days ago
JSON representation
Its an asynchronous Bank of Maldives (BML) API wrapper. Currently you can use this library to: • Listen to an automated event 'new_transaction' • Get the history of all your Bank of Maldives accounts. • Get details of all you BML accounts & contacts. • Add or Remove contacts. If you want to be alerted for new transactions; save the transactions to a db, check if the transaction is in the db, alert and save to db if it's not.
- Host: GitHub
- URL: https://github.com/quillfires/aioBML
- Owner: quillfires
- License: mit
- Created: 2021-03-27T22:12:00.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-01-27T15:49:21.000Z (almost 3 years ago)
- Last Synced: 2024-11-13T11:57:54.770Z (29 days ago)
- Language: Python
- Homepage:
- Size: 258 KB
- Stars: 16
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-maldives - aioBML - Asynchronous BML Client written in AioHTTP (Table of Contents / PYTHON Projects)
README
This is an asynchronous Python wrapper around the Bank of Maldives API.
# How it works
Its a simple asynchronous Python wrapper around the BML API. Currently you can use this library to get the transaction history of all your Bank of Maldives accounts, details of all you BML accounts & contacts and add & remove contacts. If you want to check for new transactions; save the transactions to a db, check, alert and add any transactions that's not currently saved to the db *check the basic example below*.
# Async BML API
[](https://www.python.org) [](https://pypi.python.org/pypi/aiobml/) [](https://pypi.python.org/pypi/aiobml/) [](https://pypi.python.org/pypi/aiobml/) [](LICENSE)
[](https://views.whatilearened.today/views/github/quillfires/aioBML.svg) [](https://github.com/quillfires/aioBML/network) [](https://github.com/quillfires/aioBML/stargazers) [](https://pypi.python.org/pypi/aiobml/) [](https://github.com/quillfires/aioBML/issues) [](https://github.com/quillfires/aioBML/issues)
This library is not fully completed yet. As of now it can be used to get the transactions done within the last 24 - 48 hours, get all the information about your Accounts and your contacts and add & remove contacts. *scroll to the end to see the to do list of this library*
# setup
You must have python 3 installed
### using PIP
```$ pip install -U aiobml```
### From Source
```$ git clone https://github.com/quillfires/aioBML.git```
```$ cd aioBML```
```$ python setup.py install```
# Basic Example
```python
import asyncio
from aiobml import asyncBML
loop = asyncio.get_event_loop()
bank = asyncBML(username="your_user_name",password="your_password")
async def main():
await bank.start()
@bank.event('new_transaction')
async def on_new_transaction(transaction):
print(transaction)
# on app reboot, event will trigger for all the transactions within 24 hours
# Use a db to avoid being notified of the same transaction.
# check if transaction is in your db
# if not, save to db and alert about the transaction
async def contacts():
data = await bank.get_contacts()
print(data)
# show all the contacts you have saved
async def accounts():
data = await bank.get_accounts()
print(data)
# show all the accounts you have in Bank of Maldives
async def add_cont(account, name):
added_acc = await bank.add_contact(account, name)
print(added_acc)
# adds the account your contact list
# throws DuplicateContent error if it is already in the contact list
async def delete_cont(account):
await bank.delete_contact(account)
# deletes the first match from your contact list
# account can be the account number or the saved name
if __name__ == '__main__':
try:
loop.run_until_complete(main())
except (KeyboardInterrupt, SystemExit):
pass
finally:
loop.run_until_complete(bank.close())
```
# Changlog
[See the change log here](https://github.com/quillfires/aioBML/blob/development/CHANGELOG.md)
## Todo
- [x] Get todays history
- [x] Get Account details
- [x] Get contacts
- [x] Add contacts
- [x] Delete contacts
- [ ] Get history from a date range
- [ ] Make Transfer to a given account number
- [ ] Make transfers to contacts.