ynab-sdk


Nameynab-sdk JSON
Version 0.2.0 PyPI version JSON
download
home_pagehttps://github.com/andreroggeri/ynab-sdk-python
SummaryYNAB API Endpoints
upload_time2020-08-02 00:09:32
maintainer
docs_urlNone
author
requires_python
license
keywords ynab ynab api endpoints
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # ynab-sdk-python
[![PyPI version](https://badge.fury.io/py/ynab-sdk.svg)](https://badge.fury.io/py/ynab-sdk)
[![Maintainability](https://api.codeclimate.com/v1/badges/b6042768d805939000c2/maintainability)](https://codeclimate.com/github/andreroggeri/ynab-sdk-python/maintainability)
[![codecov](https://codecov.io/gh/andreroggeri/ynab-sdk-python/branch/master/graph/badge.svg)](https://codecov.io/gh/andreroggeri/ynab-sdk-python)

Python implementation of the YNAB API ([https://api.youneedabudget.com/](https://api.youneedabudget.com/))

## Warning
This is pretty much a work in progress, the basic stuff is working, but nothing is guaranteed.
See below whats implemented and whats not

## Installation

Use the package manager [pip](https://pip.pypa.io/en/stable/) to install `ynab-sdk-python`

```bash
pip install ynab-sdk
```

## Usage

```python
from ynab_sdk import YNAB

ynab = YNAB('some-key')
print(ynab.budgets.get_budgets())
```

## Endpoints
See below whats implemented (Not fully updated yet)


| Endpoint | Verb|Description |Working|Obs|
|---|---|---|---|---|
|/user|GET|Returns authenticated user information|NO||
|/budgets|GET|Returns budgets list with summary information|YES|
|/budgets/{budget_id}|GET|Returns a single budget with all related entities.  This resource is effectively a full budget export.|YES|
|/budgets/{budget_id}/settings|GET|Returns settings for a budget|YES|
|/budgets/{budget_id}/accounts|GET|Returns all accounts|YES|
|/budgets/{budget_id}/accounts/{account_id}|GET|Returns a single account|YES|
|/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).||
|/budgets/{budget_id}/categories/{category_id}|GET|Returns a single category.  Amounts (budgeted, activity, balance, etc.) are specific to the current budget month (UTC).||
|/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).||
|/budgets/{budget_id}/months/{month}/categories/{category_id}|PATCH|Update a category for a specific month||
|/budgets/{budget_id}/payees|GET|Returns all payees|YES|
|/budgets/{budget_id}/payees/{payee_id}|GET|Returns single payee|YES|
|/budgets/{budget_id}/payee_locations|GET|Returns all payee locations|NO|
|/budgets/{budget_id}/payee_locations/{payee_location_id}|GET|Returns a single payee location|NO|
|/budgets/{budget_id}/payees/{payee_id}/payee_locations|GET|Returns all payee locations for the specified payee|NO|
|/budgets/{budget_id}/months|GET|Returns all budget months|NO|
|/budgets/{budget_id}/months/{month}|GET|Returns a single budget month|NO|
|/budgets/{budget_id}/transactions|GET|Returns budget transactions|YES|
|/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|
|/budgets/{budget_id}/transactions|PATCH|Updates multiple transactions, by 'id' or 'import_id'.|NO|
|/budgets/{budget_id}/transactions/{transaction_id}|GET|Returns a single transaction|YES|
|/budgets/{budget_id}/transactions/{transaction_id}|PUT|Updates a transaction|YES|
|/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|
|/budgets/{budget_id}/accounts/{account_id}/transactions|GET|Returns all transactions for a specified account|YES|
|/budgets/{budget_id}/categories/{category_id}/transactions|GET|Returns all transactions for a specified category|NO|
|/budgets/{budget_id}/payees/{payee_id}/transactions|GET|Returns all transactions for a specified payee|NO|
|/budgets/{budget_id}/scheduled_transactions|GET|Returns all scheduled transactions|NO|
|/budgets/{budget_id}/scheduled_transactions/{scheduled_transaction_id}|GET|Returns a single scheduled transaction|NO|



## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

## License
[Apache License 2.0](https://choosealicense.com/licenses/apache-2.0/)
            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/andreroggeri/ynab-sdk-python",
    "name": "ynab-sdk",
    "maintainer": "",
    "docs_url": null,
    "requires_python": "",
    "maintainer_email": "",
    "keywords": "YNAB,YNAB API Endpoints,",
    "author": "",
    "author_email": "a.roggeri.c@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/b2/36/d19f783dc6f9d5d20252d4a9254c72a8d15d5ea74e2cef52782dedfa9fae/ynab-sdk-0.2.0.tar.gz",
    "platform": "",
    "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|YES|\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|YES|\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/)",
    "bugtrack_url": null,
    "license": "",
    "summary": "YNAB API Endpoints",
    "version": "0.2.0",
    "split_keywords": [
        "ynab",
        "ynab api endpoints",
        ""
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "db43134bc569a32ac4738a6854c930a9",
                "sha256": "c9be3f207679b707b7e5c3e8178de80a3303fdec920a999731de4a9263581fac"
            },
            "downloads": -1,
            "filename": "ynab-sdk-0.2.0.tar.gz",
            "has_sig": false,
            "md5_digest": "db43134bc569a32ac4738a6854c930a9",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 14334,
            "upload_time": "2020-08-02T00:09:32",
            "upload_time_iso_8601": "2020-08-02T00:09:32.574324Z",
            "url": "https://files.pythonhosted.org/packages/b2/36/d19f783dc6f9d5d20252d4a9254c72a8d15d5ea74e2cef52782dedfa9fae/ynab-sdk-0.2.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2020-08-02 00:09:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "andreroggeri",
    "error": "Could not fetch GitHub repository",
    "lcname": "ynab-sdk"
}
        
Elapsed time: 0.14886s