eventbrite 3.3.5
Official Eventbrite SDK for Python
License: Apache
Keywords: eventbrite

===============================
eventbrite-sdk-python
===============================

.. image:: https://badge.fury.io/py/eventbrite.png
    :target: http://badge.fury.io/py/eventbrite

.. image:: https://travis-ci.org/eventbrite/eventbrite-sdk-python.svg?branch=master
        :target: https://travis-ci.org/eventbrite/eventbrite-sdk-python


* Official Eventbrite_ SDK for Python
* Full Documentation: http://eventbrite-sdk-python.readthedocs.org/
* API Reference: https://developer.eventbrite.com/docs/

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:

.. code-block:: python

    >>> 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:

.. code-block:: python

    >>> 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:

.. code-block:: python

    >>> 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

.. _Expansions: http://www.eventbrite.com/developer/v3/reference/expansions/

Usage with Frameworks
----------------------

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

.. code-block:: python

    @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 compatibility (small, new features, enhancements, bugfixes)

.. _requests: https://pypi.python.org/pypi/requests
.. _Eventbrite: https://www.eventbrite.com

Contributing
------------

Bug reports and pull requests are welcome on GitHub at https://github.com/eventbrite/eventbrite-sdk-python.


License
-------

The library is available as Open Source under the terms of the `Apache License, Version 2.0 <http://www.apache.org/licenses/LICENSE-2.0>`_.





History
-------

3.3.5 (2020-03-16)
------------------

* Added testing and support for Python versions up to 3.8, along with PyPy 3.
* Remove support for deprecated Python versions 2.6, 3.3, and 3.4.
* Fixed ``get_format()`` and ``get_formats()`` methods, to use the right endpoint.

3.3.4 (2016-05-05)
------------------

* Added new organizers endpoint (thanks tp @mgrdcm)
    * GET /organizers/:id/events/

3.3.3 (2015-08-24)
------------------

* Added 3 new user endpoints, thanks to @jon-ga (#29)

  * GET /users/:id/events/
  * GET /users/:id/venues/
  * GET /users/:id/organizers/

3.3.2  (2015-08-17)
-------------------

* Removed type mapping as it added unnecessary complexity preventing easy management of paginated responses.

3.2.1 (2015-08-10)
------------------

* Enabled webhooks
* Fixed ticket definitions in Event creation test
* Set input variable using input argument thanks to Bill So (#27).

3.2.0 (2015-07-07)
-------------------

* Added new publish and unpublish methods thanks to Ryan Bagwell.
* Eventbrite client now accepts an ``eventbrite_api_url`` argument.

3.1.0 (2015-05-11)
------------------

* Added control over expansion of response. Documentation at http://www.eventbrite.com/developer/v3/reference/expansions/

3.0.5 (2015-04-24)
------------------

* Removed 'content-type' header from all GET requests. Thank you @xxv for identifying the problem and contributing code.

3.0.4 (2015-03-12)
------------------

* Resolved the search result response problem where filtering did not work.


3.0.3 (2015-03-02)
------------------

* Fixed import issue with ``__version__``. Thank you @meshy  and @longjos for identifying the problem.

3.0.2 (2015-01-30)
------------------

* Event creation now working.
* Added feature allowing the use of Eventbrite API url at test servers. Should expedite development of tricky post actions.


3.0.1 (2015-01-30)
------------------

* Added reverse mapping for ``get_event_ticket_class()`` method.
* Added ``events`` mapping to provide GET access to the Event endpoint.
* Removed several deprecated JSON mappings.

3.0.0 (2015-01-28)
------------------

* Initial release of 3.0.0 client

3.0.0-alpha (2014-12-05)
------------------------


* Inception