https://github.com/boralyl/aioynab
YNAB API client implemented using python 3 asyncio.
https://github.com/boralyl/aioynab
asyncio python3 ynab
Last synced: 12 months ago
JSON representation
YNAB API client implemented using python 3 asyncio.
- Host: GitHub
- URL: https://github.com/boralyl/aioynab
- Owner: boralyl
- License: mit
- Created: 2019-03-17T20:16:02.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2019-03-30T02:02:57.000Z (almost 7 years ago)
- Last Synced: 2024-10-19T11:30:17.807Z (over 1 year ago)
- Topics: asyncio, python3, ynab
- Language: Python
- Size: 42 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.rst
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
aioynab
=======
|pypi| |pythonversions| |docs| |build| |codecov|
YNAB_ API client implemented using python 3 asyncio.
Install
-------
aioynab can easily be installed using pip and python >= 3.5.3:
.. code-block:: bash
$ pip install aioynab
Quick Start
-----------
First create a personal access token in your `YNAB account `_.
Create a client with that value like the example below.
.. code-block:: python
import asyncio
from aioynab.client import Client
loop = asyncio.get_event_loop()
client = Client('ynab-personal-access-token')
budgets = loop.run_until_complete(client.budgets()))
budget_id = budgets['budgets'][0]['budget_id']
accounts = loop.run_until_complete(client.accounts(budget_id))
account_id = accounts['accounts'][0]['account_id']
transactions = loop.run_until_complete(client.account_transactions(budget_id, account_id))
Documentation
-------------
Consult the docs_ for further information.
.. _ynab: https://api.youneedabudget.com/
.. _docs: https://aioynab.readthedocs.io/en/latest/?badge=latest
.. |build| image:: https://api.travis-ci.com/boralyl/aioynab.svg?branch=master
:alt: Build Status
:scale: 100%
:target: https://travis-ci.org/boralyl/aioynab
.. |docs| image:: https://readthedocs.org/projects/aioynab/badge/?version=latest
:alt: Documentation Status
:scale: 100%
:target: https://aioynab.readthedocs.io/en/latest/?badge=latest
.. |codecov| image:: https://codecov.io/gh/boralyl/aioynab/branch/master/graph/badge.svg
:alt: Code Coverage
:scale: 100%
:target: https://codecov.io/gh/boralyl/aioynab
.. |pypi| image:: https://badge.fury.io/py/aioynab.svg
:alt: Pypi
:scale: 100%
:target: https://pypi.org/project/aioynab/
.. |pythonversions| image:: https://img.shields.io/pypi/pyversions/aioynab.svg
:alt: Python Versions
:scale: 100%
:target: https://pypi.org/project/aioynab/