Python Congress Documentation

Transcription

1 Python Congress Documentation Release Chris Amico Mar 04, 2018

2

3 Contents: 1 Install 3 2 Usage API Indices and tables 9 Python Module Index 11 i

4 ii

5 Python Congress Documentation, Release A Python client for the ProPublica Congress API Contents: 1

6 Python Congress Documentation, Release Contents:

7 CHAPTER 1 Install From PyPI: pip install python-congress Download and run the install script: git clone && cd propublica-congress python setup.py install 3

8 Python Congress Documentation, Release Chapter 1. Install

9 CHAPTER 2 Usage The main entrypoint for the API is the Congress class, which is instantiated with your API key. (Request an API key at ProPublica s data store.) Endpoints are organized into subclients attached to the main Congress instance. For example: >>> from congress import Congress >>> congress = Congress(API_KEY) # get member by bioguide ID >>> pelosi = congress.members.get('p000197') >>> pelosi['twitter_id'] 'NancyPelosi' # get recent House bills # recent bills come in two types: 'introduced' and 'updated' >>> introd = congress.bills.recent(... chamber='house',... congress=115,... type='introduced') >>> len(introd['bills']) 20 >>> introd['chamber'] 'House' # or use a convenience function >>> introd = congress.bills.introduced('house') >>> introd['chamber'] 'House' >>> len(introd['bills']) 20 5

10 Python Congress Documentation, Release API Congress A Python client for the ProPublica Congress API API docs: class congress.congress(apikey=none, cache=.cache, http=none) Implements the public interface for the ProPublica Congress API Methods are namespaced by topic (though some have multiple access points). Everything returns decoded JSON, with fat trimmed. In addition, the top-level namespace is itself a client, which can be used to fetch generic resources, using the API URIs included in responses. This is here so you don t have to write separate functions that add on your API key and trim fat off responses. Create a new instance with your API key, or set an environment variable called PROPUBLICA_API_KEY. Congress uses httplib2, and caching is pluggable. By default, it uses httplib2.filecache, in a directory called.cache, but it should also work with memcache or anything else that exposes the same interface as FileCache (per httplib2 docs). Example: Using a custom cache object Redis is a good option for a cache that can be shared between processes. >>> from redis import StrictRedis >>> from congress import Congress >>> db = StrictRedis() >>> congress = Congress(API_KEY, cache=db) >>> senate = congress.members.filter('senate') # hits the API, caching the result >>> senate = congress.members.filter('senate') # uses the cache Members class congress.members.membersclient(apikey=none, cache=.cache, http=none) bills(member_id, type= introduced ) Same as BillsClient.by_member compare(first, second, chamber, type= votes, congress=115) See how often two members voted together in a given Congress. Takes two member IDs, a chamber and a Congress number. departing(chamber, congress=115) Takes a chamber and congress and returns a list of departing members filter(chamber, congress=115, **kwargs) Takes a chamber and Congress, OR state and district, returning a list of members get(member_id) Takes a bioguide_id, returns a legislator new(**kwargs) Returns a list of new members 6 Chapter 2. Usage

11 Python Congress Documentation, Release party() Get state party counts for the current Congress Bills class congress.bills.billsclient(apikey=none, cache=.cache, http=none) by_member(member_id, type= introduced ) Takes a bioguide ID and a type: (introduced updated cosponsored withdrawn) Returns recent bills introduced(chamber, congress=115) Shortcut for getting introduced bills major(chamber, congress=115) Shortcut for major bills passed(chamber, congress=115) Shortcut for passed bills recent(chamber, congress=115, type= introduced ) Takes a chamber, Congress, and type: (introduced updated) Returns a list of recent bills upcoming(chamber, congress=115) Shortcut for upcoming bills updated(chamber, congress=115) Shortcut for getting updated bills Votes class congress.votes.votesclient(apikey=none, cache=.cache, http=none) by_date(chamber, date) Return votes cast in a chamber on a single day by_month(chamber, year=none, month=none) Return votes for a single month, defaulting to the current month. by_range(chamber, start, end) Return votes cast in a chamber between two dates, up to one month apart. by_type(chamber, type, congress=115) Return votes by type: missed, party, lone no, perfect get(chamber, rollcall_num, session, congress=115) Return a specific roll-call vote, including a complete list of member positions loneno(chamber, congress=115) How often is each member the lone no vote? missed(chamber, congress=115) Missed votes by member nominations(congress=115) Return votes on nominations from a given Congress party(chamber, congress=115) How often does each member vote with their party? 2.1. API 7

12 Python Congress Documentation, Release perfect(chamber, congress=115) Who never misses a vote? today(chamber) Return today s votes in a given chamber Committees class congress.committees.committeesclient(apikey=none, cache=.cache, http=none) Nominations class congress.nominations.nominationsclient(apikey=none, cache=.cache, http=none) 8 Chapter 2. Usage

13 CHAPTER 3 Indices and tables genindex modindex search 9

14 Python Congress Documentation, Release Chapter 3. Indices and tables

15 Python Module Index c congress, 6 congress.bills, 7 congress.committees, 8 congress.members, 6 congress.nominations, 8 congress.votes, 7 11

16 Python Congress Documentation, Release Python Module Index

17 Index B bills() (congress.members.membersclient method), 6 BillsClient (class in congress.bills), 7 by_date() (congress.votes.votesclient method), 7 by_member() (congress.bills.billsclient method), 7 by_month() (congress.votes.votesclient method), 7 by_range() (congress.votes.votesclient method), 7 by_type() (congress.votes.votesclient method), 7 C CommitteesClient (class in congress.committees), 8 compare() (congress.members.membersclient method), 6 Congress (class in congress), 6 congress (module), 6 congress.bills (module), 7 congress.committees (module), 8 congress.members (module), 6 congress.nominations (module), 8 congress.votes (module), 7 D departing() (congress.members.membersclient method), 6 F filter() (congress.members.membersclient method), 6 G get() (congress.members.membersclient method), 6 get() (congress.votes.votesclient method), 7 I introduced() (congress.bills.billsclient method), 7 L loneno() (congress.votes.votesclient method), 7 M major() (congress.bills.billsclient method), 7 MembersClient (class in congress.members), 6 missed() (congress.votes.votesclient method), 7 N new() (congress.members.membersclient method), 6 nominations() (congress.votes.votesclient method), 7 NominationsClient (class in congress.nominations), 8 P party() (congress.members.membersclient method), 6 party() (congress.votes.votesclient method), 7 passed() (congress.bills.billsclient method), 7 perfect() (congress.votes.votesclient method), 7 R recent() (congress.bills.billsclient method), 7 T today() (congress.votes.votesclient method), 8 U upcoming() (congress.bills.billsclient method), 7 updated() (congress.bills.billsclient method), 7 V VotesClient (class in congress.votes), 7 13