Metadata-Version: 2.1
Name: buzzapi
Version: 0.1.0
Summary: 
Author: Zach Grammon
Author-email: zachgrammon@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: python-dotenv (>=1.0.0,<2.0.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Description-Content-Type: text/markdown

# buzzapi

An API client for the Agilix/Buzz LMS API

## Overview

The Agilix Buzz API is RESTful API for the Buzz LMS that accepts XML by default,
but can also accept and serve JSON. It consists of both paginated un-paginated
data, and requires a login token cookie for most endpoints.

The `buzzapi` package handles storing the login token as a cookie to be passed
with each request, as well as pagination on the relevant endpoints.

## Setup

```
from buzzapi import Client

# Creating a new client
client = Client("school/myusername", "mypassword")
```

## Examples

### Get resources from the GetUserActivityStream endpoint
```
client.get_user_activity_stream(12345, 54321) 
# => List of Activities
```

### Start IDLE with initialized client for testing
- Note that you will need to set the environment variables according to the .env_example
```
python -i buzzapi/client.py
```

