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: https://docs.fomo.com

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:

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

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@fomo.com' # used to fetch Gravatar for notification image
event.title = 'Test event'
event.city = 'San Francisco'
event.url = 'https://www.fomo.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.fomo.com'

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

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

Fetch an event:

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

Get events:

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

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'])

Delete an event:

client.delete_event('<event ID>')

Update an event:

event['first_name'] = 'Donny'
event['custom_event_fields_attributes'] = { 'amount': 19.99 }

updated_event = client.update_event(event)
print(updated_event)

Support

If you have questions, email us at hello@fomo.com.

Project details


Download files

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

Files for fomo, version 1.2.2
Filename, size File type Python version Upload date Hashes
Filename, size fomo-1.2.2-py2.py3-none-any.whl (6.2 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size fomo-1.2.2.tar.gz (5.3 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page