fomo 1.0.5

Fomo Python SDK is the official SDK wrapper for the Fomo API service

Fomo Python SDK is the official SDK wrapper for the Fomo API service

API docs: http://docs.usefomo.com/reference

Requirements

• Python version [2.7+, 3.x+]

• pyOpenSSL / OpenSSL with SNI support

• Python module requests

Installation

Install the latest version with

$ pip install fomo

Manual User Installation

Download Fomo/fomo.py and include the file in your Python project.

Check out our examples in tests/test.py, quick usage examples:

Basic Usage

Initialize Fomo client via:

import Fomo
client = Fomo.FomoClient('<token>')  # Auth token can be found Fomo application admin dashboard (App -> API Access)

To create a new event with template name:

event = Fomo.FomoEventBasic()
event.event_type_tag = 'new_order'  # Event type tag is found on Fomo dashboard (Templates -> Template name)
event.email_address = '[e-mail]' # used to fetch Gravatar for notification image
event.title = 'Test event'
event.city = 'San Francisco'
event.url = 'https://www.usefomo.com'

# Add event custom attribute value
event.add_custom_event_field('variable_name', 'value')

created_event = client.create_event(event)
print(created_event)

or with template ID:

event = Fomo.FomoEventBasic()
event.event_type_id = '183'  # Event type ID is found on Fomo dashboard (Templates -> Template ID)
event.title = 'Test event'
event.city = 'San Francisco'
event.url = 'https://www.usefomo.com'

# Add event custom attribute value
event.add_custom_event_field('variable_name', 'value')

created_event = client.create_event(event)
print(created_event)

To get an event:

event = client.get_event('<event ID>')
print(event)

To get events:

events = client.get_events(30, 1)
print(events)

To get events with meta data:

data = client.get_events_with_meta(30, 1)
print(data.events)
print(data.meta.per_page)
print(data.meta.page)
print(data.meta.total_count)
print(data.meta.total_pages)

To delete an event:

client.delete_event('<event ID>')

To update an event:

event = client.get_event('<event ID>')
event.first_name = 'John'
updated_event = client.update_event(event)
print(updated_event)

Support

If you have questions, email us at [e-mail].