@@ -1,7 +1,7 @@ BSD-style license ================= -Copyright (c) 2008, Sunlight Labs +Copyright (c) 2009, Sunlight Labs All rights reserved. LICENSE @@ -60,7 +60,7 @@ The legislators namespace is comprised of several functions: * legislators.getList - get zero or more legislators * legislators.search - fuzzy search for legislators by name * legislators.allForZip - get all legislators representing a zipcode - + get and getList --------------- @@ -81,6 +81,7 @@ The available parameters are: * district * in_office * gender + * birthdate * phone * fax * website @@ -93,9 +94,10 @@ The available parameters are: * govtrack_id * crp_id * eventful_id - * sunlight_old_id * congresspedia_url * twitter_id + * official_rss + * youtube_url To get the representative that represents NC-4: @@ -111,7 +113,6 @@ possible to do a more complex query, for instance ... print leg Rep. Pete King (R-NY) Rep. Christopher Lee (R-NY) - Rep. John McHugh (R-NY) **It is preferred that you do not call getList without parameters as it will @@ -146,10 +147,11 @@ An example usage of search is as follows: It is also possible to get multiple results: - >>> for r in sunlight.legislators.search('Kennedy'): + >>> for r in sunlight.legislators.search('Frank'): ... print r - 1.0 Sen. Ted Kennedy (D-MA) - 1.0 Rep. Patrick Kennedy (D-RI) + 1.0 Rep. Barney Frank (D-MA) + 0.972222222222 Rep. Trent Franks (R-AZ) + 0.952380952381 Sen. Al Franken (D-MN) allForZip @@ -333,114 +335,12 @@ Showing all of a legislators committees and subcommittees: Subcommittee on Financial Institutions Subcommittee on Housing, Transportation, and Community Development ------------------ -lobbyists methods ------------------ - -The lobbyists namespace contains: - * lobbyists.getFiling - * lobbyists.getFilingList - * lobbyists.search - - -getFiling ---------- - -To get all details on a single filing by id: - - >>> filing = sunlight.lobbyists.getFiling('29D4D19E-CB7D-46D2-99F0-27FF15901A4C') - - >>> print filing - 29D4D19E-CB7D-46D2-99F0-27FF15901A4C - Sunlight Foundation for SUNLIGHT FOUNDATION - - >>> for lobbyist in filing.lobbyists: - ... print lobbyist - MICHAEL KLEIN - ZEPHYR TEACHOUT - ELLEN MILLER - NISHA THOMPSON - - >>> for issue in filing.issues: - ... print issue - GOVERNMENT ISSUES (unspecified) - - -getFilingList -------------- - -To get all filings of a particular client or registrant: - - >>> for filing in sunlight.lobbyists.getFilingList(client_name='SUNLIGHT FOUNDATION'): - ... print filing - 79DAF5B3-3444-4966-A5F1-844A647EB200 - Bernstein Strategy Group for SUNLIGHT FOUNDATION - 04693B31-E97E-4A42-A157-12B4639A4319 - Sunlight Foundation for SUNLIGHT FOUNDATION - 29D4D19E-CB7D-46D2-99F0-27FF15901A4C - Sunlight Foundation for SUNLIGHT FOUNDATION - 03404F3C-3084-4B2E-949F-0788E86E547F - Bernstein Strategy Group for SUNLIGHT FOUNDATION - 713046BC-0EA7-4547-843F-FFD4716BD0EB - Bernstein Strategy Group for SUNLIGHT FOUNDATION - 17E43624-A38F-4E42-9CA3-0BC8737A169A - Sunlight Foundation for SUNLIGHT FOUNDATION - 9BB3FF43-34FF-454C-B796-45DB5CA10EFC - Bernstein Strategy Group for SUNLIGHT FOUNDATION - 4209EEC2-E946-45B7-8B9C-87DF85BD15C2 - Sunlight Foundation for SUNLIGHT FOUNDATION - C4438A23-7036-4FF0-860B-5EB2FE842AA7 - Bernstein Strategy Group for SUNLIGHT FOUNDATION - 1BB3B0FA-220C-464E-A7D1-F609010ABC0C - Sunlight Foundation for SUNLIGHT FOUNDATION - -search ------- - -To use a fuzzy name-matching search to find lobbyists filings: - - >>> for r in sunlight.lobbyists.search('Nosha Thrompson', year=2008): - ... print r - 0.945396825397 NISHA THOMPSON (Sunlight Foundation) - - ----------------- -wordlist methods ----------------- - -The wordlist namespace is used for maintaining and using lists of words primarily to be used for stopword filtering. - -It contains the methods: -* get -* update -* filter_stopwords - -get ---- - -wordlist.get(list_name) gets a stopword list by name. - -To get a python list of stopwords: - - >>> sunlight.wordlist.get('test_articles') - ['a', 'an', 'the'] - - -update ------- - -wordlist.update(list_name, words) creates or updates a stopword list. - -An example would look something like: - - >>> try: - ... sunlight.wordlist.update('test_articles', ['a', 'an', 'the']) - ... except SunlightApiError, e: - ... print e - Attempt to modify wordlist that belongs to another user - -**Note that you can only update a wordlist that you created, attempting to -modify someone elses wordlist will result in a 403 - Access Denied error** - - -filter_stopwords ----------------- - -Once a wordlist exists the primary use is to remove all stopwords from a block of text using the filter_stopwords method. - -An example of using ``filter_stopwords`` for just that: - - >>> sunlight.wordlist.filter_stopwords('test_articles', 'The boy named Frank ate a banana and an apple') - 'boy named frank ate banana and apple' +Deprecated Methods +================== -You'll notice that punctuation has been stripped and capitalized words are no longer capitalized. This is a side effect of the filtering process that comes in handy when creating word frequency visualizations (the intended purpose of the stopword API) +As of the 0.5 release of this library all lobbyists and wordlist namespace +methods are deprecated pending removal in a future version. These methods are +no longer supported by the Sunlight Labs API. +See http://sunlightlabs.com/blog/2009/sunlight-labs-api-one-year-later/ for +further details. README.rst @@ -14,7 +14,7 @@ setup(name="python-sunlightapi", url="http://github.com/sunlightlabs/python-sunlightapi/", long_description=long_description, platforms=["any"], - classifiers=["Development Status :: 3 - Alpha", + classifiers=["Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: BSD License", "Natural Language :: English", setup.py @@ -5,11 +5,12 @@ """ __author__ = "James Turk (jturk@sunlightfoundation.com)" -__version__ = "0.4.0" +__version__ = "0.5.0" __copyright__ = "Copyright (c) 2009 Sunlight Labs" __license__ = "BSD" import urllib, urllib2 +import warnings try: import json except ImportError: @@ -163,16 +164,19 @@ class sunlight(object): class lobbyists(object): @staticmethod def getFiling(id): + warnings.warn('lobbyist methods deprecated as of September 2009', DeprecationWarning) result = sunlight._apicall('lobbyists.getFiling', {'id':id}) return Filing(result['filing']) @staticmethod def getFilingList(**kwargs): + warnings.warn('lobbyist methods deprecated as of September 2009', DeprecationWarning) results = sunlight._apicall('lobbyists.getFilingList', kwargs) return [Filing(f['filing']) for f in results['filings']] @staticmethod def search(name, year=None, threshold=0.9): + warnings.warn('lobbyist methods deprecated as of September 2009', DeprecationWarning) if year == None: import time year = time.strftime('%Y') @@ -184,6 +188,7 @@ class sunlight(object): @staticmethod def _apicall(call, body=None): + warnings.warn('wordlist methods deprecated as of September 2009', DeprecationWarning) base_url = 'http://services.sunlightlabs.com/api/wordlist' url = '%s/%s/?apikey=%s' % (base_url, call, sunlight.apikey) try: @@ -197,14 +202,17 @@ class sunlight(object): @staticmethod def get(list_name): + warnings.warn('wordlist methods deprecated as of September 2009', DeprecationWarning) words = sunlight.wordlist._apicall(list_name) return words.split('~') @staticmethod def update(list_name, words): + warnings.warn('wordlist methods deprecated as of September 2009', DeprecationWarning) sunlight.wordlist._apicall(list_name, {'words': '\n'.join(words)}) @staticmethod def filter_stopwords(list_name, text): + warnings.warn('wordlist methods deprecated as of September 2009', DeprecationWarning) call = '%s/filter_stopwords' % list_name return sunlight.wordlist._apicall(call, {'text': text}) sunlightapi.py 7555c79f913d1cd35b1285c50289b619fe900df0 James Turk james.p.turk@gmail.com http://github.com/sunlightlabs/python-sunlightapi/commit/10fff5d661f2f19babbb2273cdf9621cc9edc9c0 10fff5d661f2f19babbb2273cdf9621cc9edc9c0 2009-10-06T10:58:41-07:00 2009-10-06T10:58:41-07:00 deprecation of wordlist/lobbyists 622233494623c1f524a3503b80ae4f42430a9b9a James Turk james.p.turk@gmail.com