A Python client for the New York Times Campaign Finance API
Project description
A very basic Python client for the New York Times [Campaign Finance API](http://developer.nytimes.com/docs/campaign_finance_api). You’ll need an API key, which should be set as an environment variable to run the tests. The client returns JSON only, not full Python objects.
Install
$ pip install nytcampfin
Or download and run
$ python setup.py install
Requirements
Nytcampfin uses the [Kenneth Reitz’s Requests library](https://github.com/kennethreitz/requests) for retrieving API endpoints and [Roman Haritonov’s requests-cache library](https://github.com/reclosedev/requests-cache) for local caching. The cache is preconfigured to use a local sqlite database and set to expire after 5 minutes.
Tests
To run the tests, do the following:
$ python test.py
The use of caching is disabled in the tests.
Usage
>>> from nytcampfin import NytCampfin >>> finance = NytCampfin(YOUR_NYT_CAMPAIGN_FINANCE_API_KEY)# retrieve today’s filings >>> today = finance.filings.today() >>> today[0][‘filing_id’] 793150
# retrieve a committee’s details >>> cmte = finance.committees.get(‘C00490219’,2012) >>> cmte[‘id’] u’C00490219’
