Skip to main content

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

Project description

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 = 'ryan.kulp@usefomo.com' # 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 hello@usefomo.com.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

fomo-1.0.5.tar.gz (5.9 kB view hashes)

Uploaded Source

Built Distribution

fomo-1.0.5-py2.py3-none-any.whl (6.8 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page