|
4 | 4 | sunlight.congress
|
5 | 5 | =================
|
6 | 6 |
|
7 |
| -The `Sunlight Labs Congress API |
8 |
| -<http://services.sunlightlabs.com/docs/Sunlight_Congress_API/>`_ |
9 |
| -provides methods for obtaining basic information on Members of Congress, |
10 |
| -legislator IDs used by various websites, and geographical lookups between |
11 |
| -places and the politicians that represent them. The primary purpose of |
12 |
| -the API is to facilitate mashups involving politicians and the various |
13 |
| -other APIs that are out there. |
| 7 | +The `Sunlight Congress API |
| 8 | +<http://sunlightlabs.github.io/congress/>`_ |
| 9 | +provides methods for obtaining information for the people and work of |
| 10 | +Congress. Information on legislators, districts, committees, bills, |
| 11 | +votes, as well as real-time notice of hearings, floor activity and |
| 12 | +upcoming bills. |
14 | 13 |
|
| 14 | +Congress |
| 15 | +======== |
| 16 | + |
| 17 | +.. autoclass:: sunlight.services.congress.Congress |
| 18 | + |
| 19 | + Class methods that do not specify positional arguments accept `filtering <http://sunlightlabs.github.io/congress/index.html#filtering>`_, `pagination <http://sunlightlabs.github.io/congress/index.html#pagination>`_, and `sorting <http://sunlightlabs.github.io/congress/index.html#sorting>`_ parameters as keyword arguments. See each method's API page for specfic filtering arguments. |
15 | 20 |
|
16 | 21 | Legislators
|
17 |
| -=========== |
| 22 | +----------- |
18 | 23 |
|
19 | 24 | This set of Congress API methods deal with federal legislators.
|
20 | 25 | For detailed documentaion on the return value of these methods see
|
21 |
| -`legislator fields <http://services.sunlightlabs.com/docs/congressapi/legislators.get(List)/>`_. |
| 26 | +`legislator fields <http://sunlightlabs.github.io/congress/legislators.html#fields>`_. |
| 27 | + |
| 28 | +.. automethod:: sunlight.services.congress.Congress.legislators |
| 29 | +.. automethod:: sunlight.services.congress.Congress.legislator |
| 30 | +.. automethod:: sunlight.services.congress.Congress.all_legislators_in_office |
| 31 | +.. automethod:: sunlight.services.congress.Congress.locate_legislators_by_lat_lon |
| 32 | +.. automethod:: sunlight.services.congress.Congress.locate_legislators_by_zip |
| 33 | + |
| 34 | +Bills |
| 35 | +===== |
| 36 | + |
| 37 | +This set of Congress API methods deal with Congressional bills. |
| 38 | +For detailed documentaion on the return value of these methods see |
| 39 | +`bill fields <http://sunlightlabs.github.io/congress/bills.html#fields>`_. |
22 | 40 |
|
23 |
| -.. automethod:: sunlight.services.congress.congress.legislators |
24 |
| -.. automethod:: sunlight.services.congress.congress.legislator_search |
25 |
| -.. automethod:: sunlight.services.congress.congress.legislators_for_zip |
26 |
| -.. automethod:: sunlight.services.congress.congress.legislators_for_lat_lon |
| 41 | +.. automethod:: sunlight.services.congress.Congress.bills |
| 42 | +.. automethod:: sunlight.services.congress.Congress.bill |
| 43 | +.. automethod:: sunlight.services.congress.Congress.search_bills |
| 44 | +.. automethod:: sunlight.services.congress.Congress.upcoming_bills |
27 | 45 |
|
28 | 46 | Districts
|
29 | 47 | =========
|
30 | 48 |
|
31 |
| -Pair of methods for retrieving districts. District dictionaries have a `'state'` and `'number'` key |
32 |
| -(ex. `{'state': 'NC', 'number': '3'}`) |
| 49 | +Pair of methods for retrieving districts. District dictionaries have a `'state'` and `'district'` key |
| 50 | +(ex. `{'state': 'NC', 'district': '4'}`). |
33 | 51 |
|
34 | 52 |
|
35 |
| -.. automethod:: sunlight.services.congress.congress.districts_for_zip |
36 |
| -.. automethod:: sunlight.services.congress.congress.districts_for_lat_lon |
| 53 | +.. automethod:: sunlight.services.congress.Congress.locate_districts_by_lat_lon |
| 54 | +.. automethod:: sunlight.services.congress.Congress.locate_districts_by_zip |
37 | 55 |
|
38 | 56 | Committees
|
39 | 57 | ==========
|
40 | 58 |
|
41 |
| -Methods for dealing with committees. |
| 59 | +This set of Congress API methods deal with legislative committees. |
| 60 | +For detailed documentaion on the return value of these methods see |
| 61 | +`committee fields <http://sunlightlabs.github.io/congress/committees.html#fields>`_. |
| 62 | + |
| 63 | +.. automethod:: sunlight.services.congress.Congress.committees |
| 64 | + |
| 65 | +Amendments |
| 66 | +========== |
| 67 | + |
| 68 | +This set of Congress API methods deal with amendments. |
| 69 | +For detailed documentaion on the return value of these methods see |
| 70 | +`committee fields <http://sunlightlabs.github.io/congress/amendments.html#fields>`_. |
| 71 | + |
| 72 | +.. automethod:: sunlight.services.congress.Congress.amendments |
| 73 | + |
| 74 | +Votes |
| 75 | +===== |
| 76 | + |
| 77 | +This set of Congress API methods deal with votes. |
| 78 | +For detailed documentaion on the return value of these methods see |
| 79 | +`vote fields <http://sunlightlabs.github.io/congress/votes.html#fields>`_. |
| 80 | + |
| 81 | +.. automethod:: sunlight.services.congress.Congress.votes |
| 82 | + |
| 83 | +Floor Updates |
| 84 | +============= |
| 85 | + |
| 86 | +This set of Congress API methods deal with floor updates. |
| 87 | +For detailed documentaion on the return value of these methods see |
| 88 | +`floor update fields <http://sunlightlabs.github.io/congress/floor_updates.html#fields>`_. |
| 89 | + |
| 90 | +.. automethod:: sunlight.services.congress.Congress.floor_updates |
| 91 | + |
| 92 | +Hearings |
| 93 | +======== |
| 94 | + |
| 95 | +This set of Congress API methods deal with committee hearings. |
| 96 | +For detailed documentaion on the return value of these methods see |
| 97 | +`hearing fields <http://sunlightlabs.github.io/congress/hearings.html#fields>`_. |
| 98 | + |
| 99 | +.. automethod:: sunlight.services.congress.Congress.hearings |
| 100 | + |
| 101 | +Nominations |
| 102 | +=========== |
| 103 | + |
| 104 | +This set of Congress API methods deal with nominations made by the President of the United States. |
| 105 | +For detailed documentaion on the return value of these methods see |
| 106 | +`nominations fields <http://sunlightlabs.github.io/congress/nominations.html#fields>`_. |
42 | 107 |
|
43 |
| -.. automethod:: sunlight.services.congress.congress.committees |
44 |
| -.. automethod:: sunlight.services.congress.congress.committee_detail |
45 |
| -.. automethod:: sunlight.services.congress.congress.committees_for_legislator |
| 108 | +.. automethod:: sunlight.services.congress.Congress.nominations |
0 commit comments