finnear 0.1.0

Official Python SDK for Finnear - Push notification platform for founders & developers

Finnear Python SDK

Official Python SDK for Finnear - Push notification platform for founders & developers.

Installation

pip install finnear

Quick Start

from finnear import Finnear, EventPayload

client = Finnear(api_key="your-api-key")

result = client.track(EventPayload(
    channel="signups",
    title="New user signed up",
    description="[e-mail]",
    emoji="🙋",
    metadata={"plan": "pro"},
))

print(result.event_id)

API

Finnear(api_key, base_url?)

Option	Type	Required	Description
api_key	str	Yes	Your Finnear API key
base_url	str	No	Custom API base URL

client.track(event)

Send an event to Finnear. Returns an EventResponse with event_id.

Field	Type	Required	Description
channel	str	Yes	Event channel
title	str	Yes	Event title
description	str	No	Event description
emoji	str	No	Event emoji icon
user_id	str	No	Associated user ID
metadata	dict[str, str]	No	Key-value metadata

Error Handling

from finnear import Finnear, EventPayload, AuthenticationError, ValidationError, ApiError

try:
    client.track(EventPayload(channel="signups", title="New user"))
except AuthenticationError:
    # Invalid API key (401)
    pass
except ValidationError:
    # Invalid payload (400)
    pass
except ApiError as e:
    # Other HTTP error
    print(e.status, str(e))

Requirements

• Python 3.10+
• No external dependencies

License

MIT