Skip to main content

PredictHQ Event Intelligence

Project description

Note

For the latest source, discussions, bug reports, etc., please visit the GitHub repository

PredictHQ API Client for Python

https://badge.fury.io/gh/predicthq%2Fsdk-py.svg https://badge.fury.io/py/predicthq.svg https://travis-ci.org/predicthq/sdk-py.svg?branch=master https://coveralls.io/repos/github/predicthq/sdk-py/badge.svg?branch=master

PredictHQ is the demand intelligence company combining real-world events into one global source of truth to help businesses better understand demand and plan for the future.

Installation

pip install predicthq

Usage

from predicthq import Client

phq = Client(access_token="$ACCESS_TOKEN")

# the search() method returns an EventResultSet which allows you to iterate over the 1st page of items
for event in phq.events.search(q="Foo Fighters", rank_level=[4, 5], place={"scope": ["5391959", "5368361"]}):
    print(event.rank, event.category, event.title, event.start.strftime('%Y-%m-%d'))

# if you want to iterate over all the results for your query, you can chain the iter_all() generator
for event in phq.events.search(q="matisse", country="FR").iter_all():
    print(event.rank, event.category, event.title, event.start.strftime('%Y-%m-%d'))

# you can skip results with the offset parameter and limit the number of results with the limit parameter
# the following skips the first 10 results and limits the results to 5 items
for event in phq.events.search(q="matisse", country="FR", offset=10, limit=5):
    print(event.rank, event.category, event.title, event.start.strftime('%Y-%m-%d'))

Endpoints

  • Client.oauth2
  • Client.accounts
  • Client.events
  • Client.signals
  • Client.places

For a description of all available endpoints, refer to our API Documentation.

Running Tests

pip install tox
tox

Found a Bug?

Please log an issue.

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 predicthq, version 0.2.0
Filename, size & hash File type Python version Upload date
predicthq-0.2.0-py2.py3-none-any.whl (19.5 kB) View hashes Wheel py2.py3

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page