# QuickbooksOnlineSDK
Python SDK for accessing QBO APIs.
## Installation
This project requires [Python 3+](https://www.python.org/downloads/) and [Requests](https://pypi.org/project/requests/) library (pip install requests).
1. Download this project and use it (copy it in your project, etc).
2. Install it from [pip](https://pypi.org).
$ pip install qbosdk
## Usage
To use this SDK you'll need these QBO credentials used for OAuth2 authentication: **client ID**, **client secret** and **refresh token**.
This SDK is very easy to use.
1. First you'll need to create a connection using the main class QuickbooksOnlineSDK.
```python
from qbosdk import QuickbooksOnlineSDK
connection = QuickbooksOnlineSDK(
client_id='<YOUR CLIENT ID>',
client_secret='<YOUR CLIENT SECRET>',
refresh_token='<YOUR REFRESH TOKEN>',
realm_id='<REALM / COMPANY ID>',
environment='<sandbox / production>'
)
```
2. After that you'll be able to access any of the API classes
```python
"""
USAGE: <QuickbooksOnlineSDK INSTANCE>.<API_NAME>.<API_METHOD>(<PARAMETERS>)
"""
# Get a list of all Employees (with all available details for Employee)
response = connection.employees.get()
# Get a list of all Accounts
response = connection.accounts.get()
```
See more details about the usage into the wiki pages of this project.
## Integration Tests
To run integration tests, you will need a mechanism to connect to a real qbo account. Save this info in a test_credentials.json file in your root directory:
```json
{
"client_id": "<client_id>",
"client_secret": "<client_secret>",
"realm_id": "<realm_id>",
"refresh_token": "<refresh_token>",
"environment": "<environment sandbox / production>"
}
```
```bash
$ pip install pytest
$ python -m pytest test/integration
```
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
Raw data
{
"_id": null,
"home_page": "https://github.com/fylein/qbo-sdk-py",
"name": "qbosdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "quickbooks-online, quickbooks, fyle, api, python, sdk",
"author": "Shwetabh Kumar",
"author_email": "shwetabh.kumar@fyle.in",
"download_url": "https://files.pythonhosted.org/packages/6c/74/bdf3a942d2ed8e3bb30dee837486e8a805e5b8daa32308771e243856d504/qbosdk-0.19.0.tar.gz",
"platform": null,
"description": "# QuickbooksOnlineSDK\n\nPython SDK for accessing QBO APIs.\n\n## Installation\n\nThis project requires [Python 3+](https://www.python.org/downloads/) and [Requests](https://pypi.org/project/requests/) library (pip install requests).\n\n1. Download this project and use it (copy it in your project, etc).\n2. Install it from [pip](https://pypi.org).\n \n $ pip install qbosdk\n\n## Usage\n\nTo use this SDK you'll need these QBO credentials used for OAuth2 authentication: **client ID**, **client secret** and **refresh token**.\n\nThis SDK is very easy to use.\n1. First you'll need to create a connection using the main class QuickbooksOnlineSDK.\n```python\nfrom qbosdk import QuickbooksOnlineSDK\n\nconnection = QuickbooksOnlineSDK(\n client_id='<YOUR CLIENT ID>',\n client_secret='<YOUR CLIENT SECRET>',\n refresh_token='<YOUR REFRESH TOKEN>',\n realm_id='<REALM / COMPANY ID>',\n environment='<sandbox / production>'\n)\n```\n2. After that you'll be able to access any of the API classes\n```python\n\"\"\"\nUSAGE: <QuickbooksOnlineSDK INSTANCE>.<API_NAME>.<API_METHOD>(<PARAMETERS>)\n\"\"\"\n\n# Get a list of all Employees (with all available details for Employee)\nresponse = connection.employees.get()\n\n# Get a list of all Accounts\nresponse = connection.accounts.get()\n```\n\nSee more details about the usage into the wiki pages of this project.\n\n## Integration Tests\n\nTo run integration tests, you will need a mechanism to connect to a real qbo account. Save this info in a test_credentials.json file in your root directory:\n\n```json\n{\n \"client_id\": \"<client_id>\",\n \"client_secret\": \"<client_secret>\",\n \"realm_id\": \"<realm_id>\",\n \"refresh_token\": \"<refresh_token>\",\n \"environment\": \"<environment sandbox / production>\"\n}\n```\n\n```bash\n$ pip install pytest\n\n$ python -m pytest test/integration\n```\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python SDK for accessing Quickbooks Online APIs",
"version": "0.19.0",
"project_urls": {
"Homepage": "https://github.com/fylein/qbo-sdk-py"
},
"split_keywords": [
"quickbooks-online",
" quickbooks",
" fyle",
" api",
" python",
" sdk"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "fb0bfa67ae37d21bdab833b3bd303fe40c8e9a7f293f154e8a38fa62ad661b37",
"md5": "1c26ab23f50dd385190db684f1cb1a51",
"sha256": "a906d7f709aceab452b48b7b6dc06122b4b70d9f5f25e2ad5fb753d2b1cc6dc4"
},
"downloads": -1,
"filename": "qbosdk-0.19.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1c26ab23f50dd385190db684f1cb1a51",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 22555,
"upload_time": "2024-11-15T07:30:15",
"upload_time_iso_8601": "2024-11-15T07:30:15.676269Z",
"url": "https://files.pythonhosted.org/packages/fb/0b/fa67ae37d21bdab833b3bd303fe40c8e9a7f293f154e8a38fa62ad661b37/qbosdk-0.19.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6c74bdf3a942d2ed8e3bb30dee837486e8a805e5b8daa32308771e243856d504",
"md5": "0ffb131ccc9346dc4ed1f3a4444d84c7",
"sha256": "6f7d4f52069faca8796ed3ffa00112219736466dd903b2063479ff21d9b0dfd4"
},
"downloads": -1,
"filename": "qbosdk-0.19.0.tar.gz",
"has_sig": false,
"md5_digest": "0ffb131ccc9346dc4ed1f3a4444d84c7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 14278,
"upload_time": "2024-11-15T07:30:17",
"upload_time_iso_8601": "2024-11-15T07:30:17.310270Z",
"url": "https://files.pythonhosted.org/packages/6c/74/bdf3a942d2ed8e3bb30dee837486e8a805e5b8daa32308771e243856d504/qbosdk-0.19.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 07:30:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fylein",
"github_project": "qbo-sdk-py",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "qbosdk"
}
JSON
