The Give Hub Python SDK Documentation

pip install givehub-sdk

poetry add givehub-sdk

import asyncio
from givehub import GiveHubSDK

async def main():
    # Initialize the SDK
    givehub = GiveHubSDK({
        'base_url': 'https://api.thegivehub.com',
        'version': 'v1',
        'api_key': 'your-api-key'
    })
    
    # Use the SDK
    try:
        campaigns = await givehub.campaigns.list()
        print('Active campaigns:', campaigns)
    except GiveHubException as e:
        print('Error:', str(e))

if __name__ == "__main__":
    asyncio.run(main())

try:
    result = await givehub.auth.login('user@example.com', 'password123')
    print(f"Logged in as: {result['user']['username']}")
except GiveHubException as e:
    print(f"Login failed: {str(e)}")

try:
    user_data = {
        'email': 'newuser@example.com',
        'password': 'secure123',
        'firstName': 'John',
        'lastName': 'Doe'
    }
    result = await givehub.auth.register(user_data)
    print(f"Registration successful. User ID: {result['userId']}")
except GiveHubException as e:
    print(f"Registration failed: {str(e)}")

try:
    await givehub.auth.verify_email('user@example.com', '123456')
    print("Email verified successfully")
except GiveHubException as e:
    print(f"Verification failed: {str(e)}")

try:
    campaign = await givehub.campaigns.create({
        'title': 'Clean Water Project',
        'description': 'Providing clean water access',
        'targetAmount': 50000,
        'category': 'water',
        'milestones': [{
            'description': 'Phase 1: Survey',
            'amount': 10000
        }]
    })
    print(f"Campaign created with ID: {campaign['id']}")
except GiveHubException as e:
    print(f"Failed to create campaign: {str(e)}")

try:
    campaign = await givehub.campaigns.get('campaign-id')
    print(f"Campaign title: {campaign['title']}")
except GiveHubException as e:
    print(f"Failed to get campaign: {str(e)}")

try:
    campaigns = await givehub.campaigns.list(
        category='water',
        status='active',
        page=1,
        limit=10
    )
    for campaign in campaigns['data']:
        print(campaign['title'])
except GiveHubException as e:
    print(f"Failed to list campaigns: {str(e)}")

try:
    result = await givehub.campaigns.upload_media(
        'campaign-id',
        '/path/to/image.jpg'
    )
    print("Media uploaded successfully")
except GiveHubException as e:
    print(f"Upload failed: {str(e)}")

try:
    donation = await givehub.donations.create({
        'campaignId': 'campaign-id',
        'amount': {
            'value': 100,
            'currency': 'USD'
        },
        'type': 'one-time'
    })
    print("Donation processed successfully")
except GiveHubException as e:
    print(f"Donation failed: {str(e)}")

try:
    recurring = await givehub.donations.create_recurring({
        'campaignId': 'campaign-id',
        'amount': {
            'value': 50,
            'currency': 'USD'
        },
        'frequency': 'monthly'
    })
    print("Recurring donation set up successfully")
except GiveHubException as e:
    print(f"Failed to set up recurring donation: {str(e)}")

try:
    metrics = await givehub.impact.create_metrics('campaign-id', {
        'metrics': [{
            'name': 'People Helped',
            'value': 500,
            'unit': 'individuals'
        }, {
            'name': 'Water Access',
            'value': 1000,
            'unit': 'liters/day'
        }]
    })
    print("Impact metrics created successfully")
except GiveHubException as e:
    print(f"Failed to create metrics: {str(e)}")

async with givehub.notifications as notifications:
    # Register handlers
    @notifications.on('donation_received')
    async def handle_donation(notification):
        print(f"New donation: {notification['amount']}")

    @notifications.on('milestone_completed')
    async def handle_milestone(notification):
        print(f"Milestone completed: {notification['milestone']}")

    # Keep connection alive
    await asyncio.sleep(3600)  # 1 hour

try:
    # Connect to notifications
    await givehub.notifications.connect()

    # Register handlers
    async def handle_donation(notification):
        print(f"New donation: {notification['amount']}")

    givehub.notifications.on('donation_received', handle_donation)

    # Keep connection alive
    await asyncio.sleep(3600)  # 1 hour

finally:
    # Clean up
    await givehub.notifications.disconnect()

class CampaignManager:
    def __init__(self, givehub: GiveHubSDK):
        self.givehub = givehub

    async def create_campaign_with_milestones(self, data: dict, milestones: list):
        try:
            # Create campaign
            campaign = await self.givehub.campaigns.create({
                'title': data['title'],
                'description': data['description'],
                'targetAmount': data['targetAmount'],
                'category': data['category'],
                'milestones': milestones
            })

            # Upload media if provided
            if 'mediaPath' in data:
                await self.givehub.campaigns.upload_media(
                    campaign['id'],
                    data['mediaPath']
                )

            return campaign

        except GiveHubException as e:
            logging.error(f"Campaign creation failed: {str(e)}")
            raise

class ImpactTracker:
    def __init__(self, givehub: GiveHubSDK):
        self.givehub = givehub

    async def track_progress(self, campaign_id: str, metrics: list):
        try:
            # Update metrics
            result = await self.givehub.impact.update_metrics(
                campaign_id,
                {'metrics': metrics}
            )

            # Create update
            await self._create_impact_update(campaign_id, metrics)

            return result

        except GiveHubException as e:
            logging.error(f"Impact tracking failed: {str(e)}")
            raise

    async def _create_impact_update(self, campaign_id: str, metrics: list):
        content = "Impact Update:\n\n"
        for metric in metrics:
            content += f"- {metric['name']}: {metric['value']} {metric['unit']}\n"

        return await self.givehub.updates.create({
            'campaignId': campaign_id,
            'title': 'Impact Metrics Updated',
            'content': content,
            'type': 'impact'
        })

from givehub.types import (
    Campaign,
    Donation,
    ImpactMetric,
    Update,
    Notification
)

async def process_campaign(campaign: Campaign) -> None:
    pass

async def handle_donation(donation: Donation) -> None:
    pass

try:
    result = await givehub.campaigns.create(campaign_data)
except GiveHubException as e:
    if e.status_code == 401:
        # Handle authentication error
        pass
    elif e.status_code == 400:
        # Handle validation error
        pass
    else:
        # Handle other errors
        pass
    
    logging.error(f"API Error: {str(e)}")

config = {
    'base_url': 'https://api.thegivehub.com',  # API base URL
    'version': 'v1',                           # API version
    'api_key': 'your-api-key',                # Your API key
    'timeout': 30,                            # Request timeout in seconds
    'verify_ssl': True,                       # Verify SSL certificates
    'debug': False                            # Enable debug mode
}

import logging

logging.basicConfig(level=logging.DEBUG)

givehub = GiveHubSDK({
    'debug': True,
    # other config...
})