Python package for easily accessing data via Blackbaud’s ON API and SKY API.
Project description
____ ____ _ ____ ___ _____ _ _ _ _
| __ )| __ ) / \ | _ \_ _| |_ _|__ ___ | | | _(_) |_
| _ \| _ \ / _ \ | |_) | | | |/ _ \ / _ \| | |/ / | __|
| |_) | |_) / ___ \| __/| |______| | (_) | (_) | | <| | |_
|____/|____/_/ \_\_| |___|_____|_|\___/ \___/|_|_|\_\_|\__|
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
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:
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:
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bbapi_toolkit-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 28ad968b1366d47fd02851ea70046c64296471d47cd4e493cbda5fdbfd850b2b |
|
MD5 | b4159715520a3ddeae2d5bea87873890 |
|
BLAKE2b-256 | e397407af5e0d009c9bb4cbec34868f238da4db55eb0414c66ec6f8df499f62b |