Skip to main content

Fully-functional Python wrapper for the New York Times Article Search API

Project description

===========
nytimesarticle
===========

nytimesarticle is a fully-functional Python wrapper for the New York Times Article Search API.


Installation
=========

With pip::

$ pip install nytimesarticle

or easy_install::

$ easy_install nytimesarticle


Dependencies
=========

nytimesarticle requires the `requests <https://pypi.python.org/pypi/requests>`_ package.


Usage
=========

Simply import and initialize the API with your developer key::

$ from nytimesarticle import articleAPI
$ api = articleAPI('*Your Key*')

And call the 'search' function with your desired search parameters/values::

$ articles = api.search( q = 'Obama', fq = {'headline':'Obama', 'source':['Reuters','AP', 'The New York Times']}, begin_date = 20111231, facet_field = ['source','day_of_week'], facet_filter = True )

The search function returns a dictionary of the search results.

You can specify multiple filters by using a dictionary::
fq = {'headline':'Obama', 'source':['Reuters','AP', 'The New York Times']}

And multiple values by using a list::
facet_field = ['source','day_of_week']

More examples::

$ articles = api.search( q = 'Obama' )

$ articles = api.search( q = 'Obama', begin_date = 20111231, page=2 )


For a complete overview of the available search parameters, please refer to the NYTimes Article Search API `Documentation <http://developer.nytimes.com/docs/read/article_search_api_v2>`_.

Project details


Release history Release notifications

This version
History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
nytimesarticle-0.1.0.tar.gz (3.2 kB) Copy SHA256 hash SHA256 Source None Jan 4, 2014

Supported by

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