Metadata-Version: 2.1
Name: giftbit
Version: 0.1
Summary: A Python SDK for GiftBit's API
Home-page: https://github.com/jaydenwindle/giftbit-python
Author: Jayden Windle
Author-email: jaydenwindle@gmail.com
License: UNKNOWN
Download-URL: https://github.com/jaydenwindle/giftbit-python/archive/0.1.tar.gz
Platform: UNKNOWN
Description-Content-Type: text/markdown

# giftbit-python

A Python SDK for GiftBit's API.

## Installation
```bash
$ pip install giftbit
```

## Getting Started 

### API Credentials
The `GiftbitClient` needs your Giftbit credentials. You can pass them into the constructor
or use the environment variable `GIFTBIT_API_KEY`.
```python
from giftbit import GiftbitClient

client = GiftbitClient(api_key="<your api key here>")

# or using the environment variable
client = GiftbitClient()
```

By default, the `GiftbitClient` uses Giftbit's testbed API. To use the production API server, do the following: 
```python
from giftbit import GiftbitClient, 

client = GiftbitClient(testbed=False)
```

You can check to see if the client is configured correctly by using the ping method
```python
from giftbit import GiftbitClient, 

client = GiftbitClient(testbed=False)

result = client.ping()

print(result)
```

## Brands 

### List Brands 

```python
from giftbit import GiftbitClient, 

client = GiftbitClient()

result = client.list_brands()

for brand in result['brands']:
    print(brand['name'])
```

### Get Individual Brand

```python
from giftbit import GiftbitClient, 

client = GiftbitClient()

result = client.get_brand('amazonus')

print(result['brand'])
```

## Regions 
Not implemented yet

## Campaigns 
Not implemented yet

## Funds 
Not implemented yet

## Gifts 
Not implemented yet

## Links 
Not implemented yet


