{ "info": { "author": "", "author_email": "a.roggeri.c@gmail.com", "bugtrack_url": null, "classifiers": [], "description": "# ynab-sdk-python\n[![PyPI version](https://badge.fury.io/py/ynab-sdk.svg)](https://badge.fury.io/py/ynab-sdk)\n[![Maintainability](https://api.codeclimate.com/v1/badges/b6042768d805939000c2/maintainability)](https://codeclimate.com/github/andreroggeri/ynab-sdk-python/maintainability)\n[![codecov](https://codecov.io/gh/andreroggeri/ynab-sdk-python/branch/master/graph/badge.svg)](https://codecov.io/gh/andreroggeri/ynab-sdk-python)\n\nPython implementation of the YNAB API ([https://api.youneedabudget.com/](https://api.youneedabudget.com/))\n\n## Warning\nThis is pretty much a work in progress, the basic stuff is working, but nothing is guaranteed.\nSee below whats implemented and whats not\n\n## Installation\n\nUse the package manager [pip](https://pip.pypa.io/en/stable/) to install `ynab-sdk-python`\n\n```bash\npip install ynab-sdk\n```\n\n## Usage\n\n```python\nfrom ynab_sdk import YNAB\n\nynab = YNAB('some-key')\nprint(ynab.budgets.get_budgets())\n```\n\n## Endpoints\nSee below whats implemented (Not fully updated yet)\n\n\n| Endpoint | Verb|Description |Working|Obs|\n|---|---|---|---|---|\n|/user|GET|Returns authenticated user information|NO||\n|/budgets|GET|Returns budgets list with summary information|YES|\n|/budgets/{budget_id}|GET|Returns a single budget with all related entities. This resource is effectively a full budget export.|YES|\n|/budgets/{budget_id}/settings|GET|Returns settings for a budget|YES|\n|/budgets/{budget_id}/accounts|GET|Returns all accounts|YES|\n|/budgets/{budget_id}/accounts/{account_id}|GET|Returns a single account|YES|\n|/budgets/{budget_id}/categories|GET|Returns all categories grouped by category group. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).||\n|/budgets/{budget_id}/categories/{category_id}|GET|Returns a single category. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).||\n|/budgets/{budget_id}/months/{month}/categories/{category_id}|GET|Returns a single category for a specific budget month. Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).||\n|/budgets/{budget_id}/months/{month}/categories/{category_id}|PATCH|Update a category for a specific month||\n|/budgets/{budget_id}/payees|GET|Returns all payees|YES|\n|/budgets/{budget_id}/payees/{payee_id}|GET|Returns single payee|YES|\n|/budgets/{budget_id}/payee_locations|GET|Returns all payee locations|NO|\n|/budgets/{budget_id}/payee_locations/{payee_location_id}|GET|Returns a single payee location|NO|\n|/budgets/{budget_id}/payees/{payee_id}/payee_locations|GET|Returns all payee locations for the specified payee|NO|\n|/budgets/{budget_id}/months|GET|Returns all budget months|NO|\n|/budgets/{budget_id}/months/{month}|GET|Returns a single budget month|NO|\n|/budgets/{budget_id}/transactions|GET|Returns budget transactions|YES|\n|/budgets/{budget_id}/transactions|POST|Creates a single transaction or multiple transactions. If you provide a body containing a 'transaction' object, a single transaction will be created and if you provide a body containing a 'transactions' array, multiple transactions will be created.|YES|\n|/budgets/{budget_id}/transactions|PATCH|Updates multiple transactions, by 'id' or 'import_id'.|NO|\n|/budgets/{budget_id}/transactions/{transaction_id}|GET|Returns a single transaction|YES|\n|/budgets/{budget_id}/transactions/{transaction_id}|PUT|Updates a transaction|NO|\n|/budgets/{budget_id}/transactions/bulk|POST|Creates multiple transactions. Although this endpoint is still supported, it is recommended to use 'POST /budgets/{budget_id}/transactions' to create multiple transactions.|NO|\n|/budgets/{budget_id}/accounts/{account_id}/transactions|GET|Returns all transactions for a specified account|NO|\n|/budgets/{budget_id}/categories/{category_id}/transactions|GET|Returns all transactions for a specified category|NO|\n|/budgets/{budget_id}/payees/{payee_id}/transactions|GET|Returns all transactions for a specified payee|NO|\n|/budgets/{budget_id}/scheduled_transactions|GET|Returns all scheduled transactions|NO|\n|/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}|GET|Returns a single scheduled transaction|NO|\n\n\n\n## Contributing\nPull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.\n\nPlease make sure to update tests as appropriate.\n\n## License\n[Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/)", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/andreroggeri/ynab-sdk-python", "keywords": "YNAB,YNAB API Endpoints,", "license": "", "maintainer": "", "maintainer_email": "", "name": "ynab-sdk", "package_url": "https://pypi.org/project/ynab-sdk/", "platform": "", "project_url": "https://pypi.org/project/ynab-sdk/", "project_urls": { "Homepage": "https://github.com/andreroggeri/ynab-sdk-python" }, "release_url": "https://pypi.org/project/ynab-sdk/0.0.3/", "requires_dist": null, "requires_python": "", "summary": "YNAB API Endpoints", "version": "0.0.3" }, "last_serial": 5235743, "releases": { "0.0.1": [ { "comment_text": "", "digests": { "md5": "1c2236a48632e93adeabd06c3123d72b", "sha256": "ddbac599bec66db5390d94ae1d7502779a04a683e61a924b35ebdd3482776977" }, "downloads": -1, "filename": "ynab-sdk-0.0.1.tar.gz", "has_sig": false, "md5_digest": "1c2236a48632e93adeabd06c3123d72b", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13970, "upload_time": "2019-05-07T01:07:20", "url": "https://files.pythonhosted.org/packages/c6/b7/b2611c4d3139a08ec4846831ffc7480cfa01dc10a686629a19832a6614c8/ynab-sdk-0.0.1.tar.gz" } ], "0.0.2": [ { "comment_text": "", "digests": { "md5": "cecd5243f23376c5d6f926e1624ebf56", "sha256": "6c93417c411579f8480e216df384ab575390c4967850ecb5384bb9b39499d363" }, "downloads": -1, "filename": "ynab-sdk-0.0.2.tar.gz", "has_sig": false, "md5_digest": "cecd5243f23376c5d6f926e1624ebf56", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13658, "upload_time": "2019-05-07T02:08:50", "url": "https://files.pythonhosted.org/packages/91/e5/1231345d9e26b28bc3f9a2d1b4a71b258e17d51ad7a53c19d12e3f8d9922/ynab-sdk-0.0.2.tar.gz" } ], "0.0.3": [ { "comment_text": "", "digests": { "md5": "f6692e32c8dd0f4c5ef1921720ab8d5f", "sha256": "5b5e295e6abf7d2f971a479eddb1769a4017cef338615d17c66cde03aa9af290" }, "downloads": -1, "filename": "ynab-sdk-0.0.3.tar.gz", "has_sig": false, "md5_digest": "f6692e32c8dd0f4c5ef1921720ab8d5f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13912, "upload_time": "2019-05-07T02:30:28", "url": "https://files.pythonhosted.org/packages/43/fe/26a0d170ec359dddd94d735436ed0835e7d182e3e76494d293991ed6c0e8/ynab-sdk-0.0.3.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f6692e32c8dd0f4c5ef1921720ab8d5f", "sha256": "5b5e295e6abf7d2f971a479eddb1769a4017cef338615d17c66cde03aa9af290" }, "downloads": -1, "filename": "ynab-sdk-0.0.3.tar.gz", "has_sig": false, "md5_digest": "f6692e32c8dd0f4c5ef1921720ab8d5f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 13912, "upload_time": "2019-05-07T02:30:28", "url": "https://files.pythonhosted.org/packages/43/fe/26a0d170ec359dddd94d735436ed0835e7d182e3e76494d293991ed6c0e8/ynab-sdk-0.0.3.tar.gz" } ] }