{ "info": { "author": "Dennis Whitney", "author_email": "dennis@irunasroot.com", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: GNU General Public License v3 (GPLv3)", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Build Tools" ], "description": "# pynab-client\nPython API module for interfacing with You Need a Budget's (YNAB) v1 API\n\nOnly runs on python >3.6 .....#sorrynotsorry\n\n## installation\nEasy way\n```bash\npip install pynab-client\n```\n\nLess easy way\n```bash\ngit clone https://github.com/irunasroot/pynab-client.git\ncd pynab-client\npython setup.py install\n```\n\n## Usage\n```python\nfrom pynabapi import YnabClient\n\nclient = YnabClient(\"my-api-token\")\n\nmy_budgets = client.get_budget()\n```\n\n## API\n\nYnabClient.get_budget()\n```text\nThe mother load. By default you'll get a summary list of all Budgets you have on your account. If you're looking\nfor a single budget you can specify the budget_id or by default it will pull data for the last opened budget.\n\n:param summary: Set summary to False if you want an entire payload of a single budget\n :default: True\n:param budget_id: The budget id of the budget you want to view data from.\n :default: last-used which is your last opened budget.\n:return: Returns Budgets object as a list of Budget objects or a single Budget object\n```\n\nYnabClient.get_account() \n```text\n:param account_id: Provide account_id to retrieve a single known account. \n :default: None\n:param budget_id: The budget id of the budget you want to view data from. \n :default: last-used which is your last opened budget. \n:return: Returns Accounts object as a list of Account objects or a single Account object \n```\n\nYnabClient.get_budgetmonth()\n```text\nGet budget month or months. If specifying the month then a list of categories are also provided.\n\n:param month: Provide month to retrieve a single known month.\n :default: None\n:param budget_id: The budget id of the budget you want to view data from.\n :default: last-used which is your last opened budget.\n:return: Returns BudgetMonths object as a list of BudgetMonth objects or a single BudgetMonth object\n```\n\nYnabClient.get_category()\n```text\nGet budget category or categories. If specifying the month then you also need to specify a category_id\n\n:param category_id: The category ID of the specific category you want to retrieve\n :default: None\n:param month: The month of the category you want to retrieve format: yyyy-MM-dd\n :default: None\n:param budget_id: The budget id of the budget you want to view data from.\n :default: last-used which is your last opened budget.\n:return: Returns BudgetCategories object as a list of BudgetCategory objects or a single BudgetCategory object\n```\n\nYnabClient.get_payee()\n```text\nGet budget payee or payees.\n\n:param payee_id: Provide payee_id to retrieve a single known payee.\n:param budget_id: The budget id of the budget you want to view data from.\n :default: last-used which is your last opened budget.\n:return: Returns Payees object as a list of Payee objects or a single Payee object\n```\n\nYnabClient.get_transaction()\n```text\nGet budget transaction or transactions.\n\n:param transaction_id: Provide transaction_id to retrieve a single known transaction.\n :default: None\n:param budget_id: The budget id of the budget you want to view data from.\n :default: last-used which is your last opened budget.\n:return: Returns Transactions object as a list of Transaction objects or a single Transaction object\n```\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "https://github.com/irunasroot/pynab-client/archive/v0.2.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/irunasroot/pynab-client", "keywords": "ynab,pynab,budgeting,budgets,youneedabudget", "license": "GNU GPLv3", "maintainer": "", "maintainer_email": "", "name": "pynab-client", "package_url": "https://pypi.org/project/pynab-client/", "platform": "", "project_url": "https://pypi.org/project/pynab-client/", "project_urls": { "Download": "https://github.com/irunasroot/pynab-client/archive/v0.2.tar.gz", "Homepage": "https://github.com/irunasroot/pynab-client" }, "release_url": "https://pypi.org/project/pynab-client/0.2/", "requires_dist": [ "requests" ], "requires_python": "", "summary": "Python API to access YNAB v1 API", "version": "0.2" }, "last_serial": 5637443, "releases": { "0.1": [ { "comment_text": "", "digests": { "md5": "1ac0099c6fe7863a67fbcdfac019bb85", "sha256": "98755cc5b47fd89c5aeb114ec29fe9f0e33e9c21340442b8dc112d3dfefd2cfb" }, "downloads": -1, "filename": "pynab-client-0.1.tar.gz", "has_sig": false, "md5_digest": "1ac0099c6fe7863a67fbcdfac019bb85", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3000, "upload_time": "2019-07-17T23:27:36", "url": "https://files.pythonhosted.org/packages/6b/e5/98ad77f0b99b03ba7f7114e1d618841fa49a9d7a0a10e1b96dd2cd1ac0d9/pynab-client-0.1.tar.gz" } ], "0.2": [ { "comment_text": "", "digests": { "md5": "10c9397a9c392460a368e3c28d72b9d9", "sha256": "107544b9189f2abb4595253d1059fe53d02e8e6313f8254897e66c956b063ce3" }, "downloads": -1, "filename": "pynab_client-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "10c9397a9c392460a368e3c28d72b9d9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22706, "upload_time": "2019-08-06T03:31:17", "url": "https://files.pythonhosted.org/packages/87/f4/ee259fe5d00c76d9ac6d85c84ecde83a9ad485c6843c56453939155500ab/pynab_client-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "866bde497f7c86c0aa52d106be45be7e", "sha256": "97b3bf4649da85d6cb002f8dbfe1f35550eab212ebc908819cffab49fa8f0094" }, "downloads": -1, "filename": "pynab-client-0.2.tar.gz", "has_sig": false, "md5_digest": "866bde497f7c86c0aa52d106be45be7e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6840, "upload_time": "2019-08-06T03:31:20", "url": "https://files.pythonhosted.org/packages/36/9a/2820782f3b33e473a953374b68fe104e74f7655ff06baaeae46fa89c64a8/pynab-client-0.2.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "10c9397a9c392460a368e3c28d72b9d9", "sha256": "107544b9189f2abb4595253d1059fe53d02e8e6313f8254897e66c956b063ce3" }, "downloads": -1, "filename": "pynab_client-0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "10c9397a9c392460a368e3c28d72b9d9", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 22706, "upload_time": "2019-08-06T03:31:17", "url": "https://files.pythonhosted.org/packages/87/f4/ee259fe5d00c76d9ac6d85c84ecde83a9ad485c6843c56453939155500ab/pynab_client-0.2-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "866bde497f7c86c0aa52d106be45be7e", "sha256": "97b3bf4649da85d6cb002f8dbfe1f35550eab212ebc908819cffab49fa8f0094" }, "downloads": -1, "filename": "pynab-client-0.2.tar.gz", "has_sig": false, "md5_digest": "866bde497f7c86c0aa52d106be45be7e", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 6840, "upload_time": "2019-08-06T03:31:20", "url": "https://files.pythonhosted.org/packages/36/9a/2820782f3b33e473a953374b68fe104e74f7655ff06baaeae46fa89c64a8/pynab-client-0.2.tar.gz" } ] }