| Name | bbapi-toolkit JSON |
| Version |
1.0.0
JSON |
| download |
| home_page | |
| Summary | Python package for easily accessing data via Blackbaud’s ON API and SKY API. |
| upload_time | 2022-12-23 19:31:11 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | MIT License Copyright (c) 2019 Lugal-PCZ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
blackbaud
api
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
```
____ ____ _ ____ ___ _____ _ _ _ _
| __ )| __ ) / \ | _ \_ _| |_ _|__ ___ | | | _(_) |_
| _ \| _ \ / _ \ | |_) | | | |/ _ \ / _ \| | |/ / | __|
| |_) | |_) / ___ \| __/| |______| | (_) | (_) | | <| | |_
|____/|____/_/ \_\_| |___|_____|_|\___/ \___/|_|_|\_\_|\__|
```
---
## Description
BBAPI_Toolkit is a Python package for easily accessing data via Blackbaud’s ON API and SKY API.
## Requirements
This package is written for Python 3.8 and later. Prior versions of Python may work, but have not been tested.
## Installation
```bash
pip3 install bbapi_toolkit
```
## Configuration
Duplicate the _config.ini.example_ file into your project directory (or a config subdirectory, if desired), rename it something sensible (like _config.ini_), and modify the settings to match the needs of your current project. Each config file can contain connection settings for ON API and/or SKY API. You can, however, make multiple config files, each with its own settings, if you intend to connect to the API applications with multiple accounts concurrently.
## Usage
Create an instance of the _Client_ class, with the name of your config file as its only parameter, to create a client connection to Blackbaud’s APIs. Once created, pre-built functions provide a consistent interface to the API. The modules and functions in this package mirror the organization of Blackbaud’s API documentation: ```category/group/function``` _or_ ```category/function```.
The following code snippet provides an example of how to use the onapi module to issue two API calls, one to get a list of Blackbaud roles, and the other to retrieve the results of a pre-built list:
```python
from bbapi_toolkit import onapi
client = onapi.Client('config.ini')
roles = onapi.constituents.role.get_roles(client)
listresults = onapi.list.get_list(client, 12345) # Change this id to that of a list which you can access.
```
The following code snippet provides an example of the same behavior using the SKY API:
```python
from bbapi_toolkit import skyapi
client = skyapi.Client('config.ini')
roles = skyapi.school.core_roles.get(client)
listresults = skyapi.school.legacy_list.get(client, 12345) # Change this id to that of a list which you can access.
```
Raw data
{
"_id": null,
"home_page": "",
"name": "bbapi-toolkit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "blackbaud,api",
"author": "",
"author_email": "\"Paul C. Zimmerman\" <paul@lugal.com>",
"download_url": "https://files.pythonhosted.org/packages/94/81/79e3060e5a4ab69d0280931c4896c039f7d19c2274b76f165c327fd43aab/bbapi_toolkit-1.0.0.tar.gz",
"platform": null,
"description": "```\n ____ ____ _ ____ ___ _____ _ _ _ _ \n | __ )| __ ) / \\ | _ \\_ _| |_ _|__ ___ | | | _(_) |_ \n | _ \\| _ \\ / _ \\ | |_) | | | |/ _ \\ / _ \\| | |/ / | __|\n | |_) | |_) / ___ \\| __/| |______| | (_) | (_) | | <| | |_ \n |____/|____/_/ \\_\\_| |___|_____|_|\\___/ \\___/|_|_|\\_\\_|\\__|\n```\n---\n## Description\nBBAPI_Toolkit is a Python package for easily accessing data via Blackbaud\u2019s ON API and SKY API.\n\n\n## Requirements\nThis package is written for Python 3.8 and later. Prior versions of Python may work, but have not been tested.\n\n\n## Installation\n```bash\npip3 install bbapi_toolkit\n```\n\n## Configuration\nDuplicate the _config.ini.example_ file into your project directory (or a config subdirectory, if desired), rename it something sensible (like _config.ini_), and modify the settings to match the needs of your current project. Each config file can contain connection settings for ON API and/or SKY API. You can, however, make multiple config files, each with its own settings, if you intend to connect to the API applications with multiple accounts concurrently.\n\n\n## Usage\nCreate an instance of the _Client_ class, with the name of your config file as its only parameter, to create a client connection to Blackbaud\u2019s APIs. Once created, pre-built functions provide a consistent interface to the API. The modules and functions in this package mirror the organization of Blackbaud\u2019s API documentation: ```category/group/function``` _or_ ```category/function```.\n\nThe following code snippet provides an example of how to use the onapi module to issue two API calls, one to get a list of Blackbaud roles, and the other to retrieve the results of a pre-built list:\n```python\nfrom bbapi_toolkit import onapi\n\nclient = onapi.Client('config.ini')\nroles = onapi.constituents.role.get_roles(client)\nlistresults = onapi.list.get_list(client, 12345) # Change this id to that of a list which you can access.\n```\n\nThe following code snippet provides an example of the same behavior using the SKY API:\n```python\nfrom bbapi_toolkit import skyapi\n\nclient = skyapi.Client('config.ini')\nroles = skyapi.school.core_roles.get(client)\nlistresults = skyapi.school.legacy_list.get(client, 12345) # Change this id to that of a list which you can access.\n```\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2019 Lugal-PCZ Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
"summary": "Python package for easily accessing data via Blackbaud\u2019s ON API and SKY API.",
"version": "1.0.0",
"split_keywords": [
"blackbaud",
"api"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "b4159715520a3ddeae2d5bea87873890",
"sha256": "28ad968b1366d47fd02851ea70046c64296471d47cd4e493cbda5fdbfd850b2b"
},
"downloads": -1,
"filename": "bbapi_toolkit-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b4159715520a3ddeae2d5bea87873890",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 29707,
"upload_time": "2022-12-23T19:31:10",
"upload_time_iso_8601": "2022-12-23T19:31:10.126549Z",
"url": "https://files.pythonhosted.org/packages/e3/97/407af5e0d009c9bb4cbec34868f238da4db55eb0414c66ec6f8df499f62b/bbapi_toolkit-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "3242c60be8e9d3f2b7955abd1d19fcb4",
"sha256": "803714e710b47aa3ed1ebc3afe77ceb2e088f9b05ff9206dd83bf7fc66d8296a"
},
"downloads": -1,
"filename": "bbapi_toolkit-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "3242c60be8e9d3f2b7955abd1d19fcb4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 16369,
"upload_time": "2022-12-23T19:31:11",
"upload_time_iso_8601": "2022-12-23T19:31:11.709858Z",
"url": "https://files.pythonhosted.org/packages/94/81/79e3060e5a4ab69d0280931c4896c039f7d19c2274b76f165c327fd43aab/bbapi_toolkit-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-23 19:31:11",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "bbapi-toolkit"
}
