edx_salesforce package¶

Subpackages¶

Submodules¶

edx_salesforce.apps module¶

edx_salesforce Django application initialization.

class edx_salesforce.apps.EdxSalesforceConfig(app_name, app_module)¶

Bases: django.apps.config.AppConfig

Configuration for the edx_salesforce Django application.

name = u'edx_salesforce'¶

edx_salesforce.choices module¶

Choices for model fields.

edx_salesforce.edx_data module¶

Provides functions for retrieving EdX data.

edx_salesforce.edx_data.fetch_user_data(site_domain, orgs)¶

Return user data associated with the given site and organizations.

Parameters:

site_domain (string) – The domain of the site which user data will be fetched for. orgs (list of strings) – The list of organization names which will be used to find course purchases and the associated user data.

Returns:

list of dicts, containing the user data. Example [{ ‘full_name’: ‘Test User’, ‘email’: 'test@example.com‘, ‘country’: ‘US’, ‘year_of_birth’: ‘1977’, ‘username’: ‘TestUser’, ‘language’: ‘en’, ‘level_of_education’: ‘b’, ‘goals’: ‘Learn about foo’, ‘gender’: ‘f’, ‘registration_date’: datetime.datetime(2016, 2, 14, 0, 0, 0), ‘tracking’: { ‘utm_source’: ‘test’, ‘utm_medium’: ‘test’, ‘utm_campaign’: ‘test’, ‘utm_term’: ‘test’, ‘utm_content’: ‘test’ }, ‘courses’: [{ ‘coupon_codes’: [u’TESTCODE’], ‘course_id’: u’course-v1:TestOrgX+TestCourse+1T2017’, ‘purchase_date’: datetime.datetime(2017, 2, 14, 0, 0, 0), ‘list_price’: Decimal(‘100.00’), ‘order_id’: 10000000L, ‘quantity’: 1L, ‘unit_price’: Decimal(‘90.00’), ‘username’: u’TestUser’ }] }]

edx_salesforce.models module¶

edx_salesforce.urls module¶

URLs for edx_salesforce.

edx_salesforce.utils module¶

Utilities used by the edx_salesforce Django app.

edx_salesforce.utils.parse_user_full_name(full_name)¶

Parses user full name into first and last name strings.

Module contents¶

Django application used to integrate Open EdX with Salesforce..