Metadata-Version: 2.0
Name: wespe
Version: 0.2.1
Summary: Batching ad tech providers’ operations for humans
Home-page: https://github.com/kayak/wespe
Author: Lucas Lira Gomes
Author-email: llira@kayak.com
License: UNKNOWN
Keywords: wespe adtech marketing facebook google bing yandex facebook
Platform: UNKNOWN
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Description-Content-Type: text/x-rst
Requires-Dist: facebook-business (==5.0.4)
Requires-Dist: requests (==2.22.0)
Requires-Dist: tenacity (==5.0.2)
Requires-Dist: typing (==3.7.4.1)

Wespe - Batching ad tech providers’ operations for humans
=========================================================

.. _intro_start:

|BuildStatus|  |CoverageStatus|  |Codacy|  |Docs|  |PyPi|  |License|

Abstract
--------

What is |Brand|?

|Brand| is a Python API for batching requests when interfacing AdTech providers (e.g. adwords, facebook business).
The motivation behind |Brand| is to provide a simple and consistent interface for batching requests. Currently it
only supports Facebook Business. Other providers will be added in the future.

.. _intro_end:

Read the docs: http://wespe.readthedocs.io/en/latest/

Installation
------------

.. _installation_start:

|Brand| supports python ``3.6+``.  It may also work on pypy, cython, and jython, but is not being tested for
these versions.

To install |Brand| run the following command:

.. code-block:: bash

    pip install wespe


.. _installation_end:


Usage - Facebook Business
-------------------------


All steps from now on will assume you've already set the default api connection using facebook_busines. It's also
possible to set one on the fly by providing the api kwarg in FacebookBatchUploader's constructor.


.. code-block:: python

    from wespe.batch_uploaders import FacebookBatchUploader

    # There is no request limit. If necessary Wespe will coordinate the execution of multiple FacebookAdsApiBatch
    # instances.
    batch_uploader = FacebookBatchUploader(requests)

    try:
        batch_uploader.execute()
    except BatchExecutionError:
        for error in batch_uploader.errors:
            # See FacebookBatchRequestError for more info on what you can do
            pass

    for response in batch_uploader.responses:
        # See FacebookBatchResponse for more info on what you can do
        pass


License
-------

Copyright 2016 KAYAK Germany, GmbH

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.


Crafted with ♥ in Berlin.

.. _license_end:


.. _appendix_start:

.. |Brand| replace:: *Wespe*

.. _appendix_end:

.. _available_badges_start:

.. |BuildStatus| image:: https://travis-ci.org/kayak/wespe.svg?branch=master
   :target: https://travis-ci.org/kayak/wespe
.. |CoverageStatus| image:: https://coveralls.io/repos/kayak/wespe/badge.svg?branch=master&service=github
   :target: https://coveralls.io/github/kayak/wespe?branch=master
.. |Codacy| image:: https://api.codacy.com/project/badge/Grade/addef22ded664dac9c41a74e6bf79134
   :target: https://www.codacy.com/app/x8lucas8x/wespe
.. |Docs| image:: https://readthedocs.org/projects/wespe/badge/?version=latest
   :target: http://wespe.readthedocs.io/en/latest/
.. |PyPi| image:: https://img.shields.io/pypi/v/wespe.svg?style=flat
   :target: https://pypi.python.org/pypi/wespe
.. |License| image:: https://img.shields.io/hexpm/l/plug.svg?maxAge=2592000
   :target: http://www.apache.org/licenses/LICENSE-2.0

.. _available_badges_end:


