Installation from PyPI¶

$ pip install eventbrite

If you need to, you can also use easy_install:

$ easy_install eventbrite

Usage¶

The Eventbrite Python SDK makes it trivial to interact with the Eventbrite API:

>>> from eventbrite import Eventbrite
>>> eventbrite = Eventbrite('my-oauth-token')
>>> user = eventbrite.get_user()  # Not passing an argument returns yourself
>>> user['id']
1234567890
>>> user['name']
Daniel Roy Greenfeld

You can also specify API endpoints manually:

>>> user = eventbrite.get('/users/me')
>>> user['id']
1234567890
>>> user['name']
Daniel Roy Greenfeld

Expansions can be included in a returned GET resource by simply adding the expand keyword to the calling method:

>>> event = eventbrite.get_event('my-event-id')
>>> 'ticket_classes' in evbobject
False
>>> event = eventbrite.get_event('my-event-id', expand='ticket_classes')
>>> 'ticket_classes' in evbobject
True

Usage with Frameworks¶

When using Flask, you can convert incoming webhook requests into Eventbrite API objects using the webhook_to_object() method:

@app.route('/webhook', methods=['POST'])
def webhook():


    # Use the API client to convert from a webhook to an API object
    api_object = eventbrite.webhook_to_object(request)

    # Process the API object
    if api_object.type == 'User':
        do_user_process(api_object)

    if api_object.type == 'Event':
        do_event_process(api_object)

    return ""

Versioning¶

Because this client interacts with Eventbrite’s third API (a.k.a. APIv3), we are tying our release numbers against it in a modified-semantic system:

• 3.x.x where ‘3’ matches the API version. This will not change until Eventbrite releases a new API version.
• x.0.x where ‘0’ is increased any time there is a significant change to the API that possibly breaks backwards compatibility
• x.x.1 where ‘1’ is increased on any release that does not break backwards comptability (small, new features, enhancements, bugfixes)

Example: Get User Info¶

The following code gets our user object and prints our id and name.

user = eventbrite.get_user()  # Not passing an argument returns yourself
print(user['id'])
print(user['name'])

This is what gets printed out:

1234567890
Daniel Roy Greenfeld

Example: Pretty print an object¶

Eventbrite objects are dictionaries with extra attributes. Our favorite is pretty, which formats their data more legibly:

>>> user = eventbrite.get_user()  # Not passing an argument returns yourself
>>> print(user.pretty)
{u'emails': [{u'email': u'danny@eventbrite.com',
              u'primary': True,
              u'verified': True}],
 u'first_name': u'Daniel',
 u'id': u'1234567890',
 u'last_name': u'Greenfeld',
 u'name': u'Daniel Greenfeld'}

Get a List of My Draft/Unpublished Events¶

from eventbrite import Eventbrite
eventbrite = Eventbrite(MY_OAUTH_TOKEN)

# Get my own User ID
my_id = eventbrite.get_user()['id']

# Get a raw list of events (includes pagination details)
events = eventbrite.event_search(**{'user.id': my_id})

# List the events in draft status
[x for x in events['events'] if x['status'] == 'draft']

Types of Contributions¶

Get Started!¶

Ready to contribute? Here’s how to set up eventbrite for local development.

1. Fork the eventbrite repo on GitHub.

2. Clone your fork locally:

   $ git clone git@github.com:your_name_here/eventbrite.git
   

3. Install your local copy into a virtualenv. Assuming you have virtualenvwrapper installed, this is how you set up your fork for local development:

   $ mkvirtualenv eventbrite
   $ cd eventbrite/
   $ python setup.py develop
   $ pip install -r requirements.txt
   

4. Create a branch for local development:

   $ git checkout -b name-of-your-bugfix-or-feature
   

   Now you can make your changes locally.

5. When you’re done making changes, check that your changes pass flake8 and the tests, including testing other Python versions with tox:

   $ flake8 eventbrite tests
   $ py.test tests
   $ tox
   

   To get flake8 and tox, just pip install them into your virtualenv.

6. Commit your changes and push your branch to GitHub:

   $ git add .
   $ git commit -m "Your detailed description of your changes."
   $ git push origin name-of-your-bugfix-or-feature
   

7. Submit a pull request through the GitHub website.

Adding Environment Variables¶

In order to run the full test suite, you will need your USER_ID and OAUTH token from Eventbrite added as environment variables.

In your .bash_profile add:

# Eventbrite envariables variables
EVENTBRITE_USER_ID=XXXXXXXX
EVENTBRITE_OAUTH_TOKEN=XXXXXXXX

Pull Request Guidelines¶

Before you submit a pull request, check that it meets these guidelines:

1. The pull request should include tests.
2. If the pull request adds functionality, the docs should be updated. Put your new functionality into a function with a docstring, and add the feature to the list in README.rst.
3. The pull request should work for Python 2.6, 2.7, 3.3, and 3.4, and for PyPy. Check https://travis-ci.org/eventbrite/eventbrite-sdk-python/pull_requests and make sure that the tests pass for all supported Python versions.

Tips¶

$ python -m unittest tests.test_eventbrite

$ make coverage

$ export EVENTBRITE_EVENT_ID=XXXXXXXXX
$ export EVENTBRITE_OAUTH_TOKEN=XXXXXXXXXX

Development Leads¶

• Daniel Greenfeld <danny@eventbrite.com>
• Bartek Ogryczak <bartek@eventbrite.com>

Contributors¶

• Piotr Banaszkiewicz <piotr@banaszkiewicz.org>
• Ryan Bagwell <ryan@ryanbagwell.com>
• Bill So <bill@eventbrite.com>
• Jon Kaczynski <jon@generalassemb.ly>
• Dan Moore <dan@moore.cx>