├── .gitignore ├── LICENSE ├── MANIFEST.in ├── README.rst ├── docs ├── Makefile ├── _build │ ├── doctrees │ │ ├── environment.pickle │ │ ├── index.doctree │ │ ├── influenceexplorer.doctree │ │ └── transparencydata.doctree │ └── html │ │ ├── .buildinfo │ │ ├── _modules │ │ ├── index.html │ │ └── influenceexplorer.html │ │ ├── _sources │ │ ├── index.txt │ │ ├── influenceexplorer.txt │ │ └── transparencydata.txt │ │ ├── _static │ │ ├── basic.css │ │ ├── default.css │ │ ├── doctools.js │ │ ├── file.png │ │ ├── jquery.js │ │ ├── minus.png │ │ ├── plus.png │ │ ├── pygments.css │ │ ├── searchtools.js │ │ ├── sidebar.js │ │ └── underscore.js │ │ ├── genindex.html │ │ ├── index.html │ │ ├── influenceexplorer.html │ │ ├── objects.inv │ │ ├── py-modindex.html │ │ ├── search.html │ │ ├── searchindex.js │ │ └── transparencydata.html ├── conf.py ├── index.rst ├── influenceexplorer.rst └── transparencydata.rst ├── influenceexplorer.py ├── setup.py └── transparencydata.py /.gitignore: -------------------------------------------------------------------------------- 1 | *.pyc 2 | ignored.py 3 | .project 4 | .pydevproject 5 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | BSD-style license 2 | ================= 3 | 4 | Copyright (c) 2010, Sunlight Labs 5 | 6 | All rights reserved. 7 | 8 | Redistribution and use in source and binary forms, with or without modification, 9 | are permitted provided that the following conditions are met: 10 | 11 | * Redistributions of source code must retain the above copyright notice, 12 | this list of conditions and the following disclaimer. 13 | * Redistributions in binary form must reproduce the above copyright notice, 14 | this list of conditions and the following disclaimer in the documentation 15 | and/or other materials provided with the distribution. 16 | * Neither the name of Sunlight Labs nor the names of its contributors may be 17 | used to endorse or promote products derived from this software without 18 | specific prior written permission. 19 | 20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 21 | "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 | LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 23 | A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR 24 | CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 25 | EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 26 | PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 27 | PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF 28 | LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 29 | NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS 30 | SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -------------------------------------------------------------------------------- /MANIFEST.in: -------------------------------------------------------------------------------- 1 | include LICENSE *.rst *.py 2 | -------------------------------------------------------------------------------- /README.rst: -------------------------------------------------------------------------------- 1 | ======================= 2 | python-transparencydata 3 | ======================= 4 | 5 | Python library for interacting with the TransparencyData.com API. 6 | 7 | The TransparencyData.com API provides campaign contribution and lobbying data. 8 | 9 | http://transparencydata.com/api/ 10 | 11 | python-transparencydata is a project of Sunlight Labs (c) 2010 12 | Written by Jeremy Carbaugh 13 | 14 | All code is under a BSD-style license, see LICENSE for details. 15 | 16 | Source: http://github.com/sunlightlabs/python-transparencydata/ 17 | 18 | Requirements 19 | ============ 20 | 21 | python >= 2.4 22 | 23 | simplejson >= 1.8 (not required with Python 2.6, will use built-in ``json`` module) 24 | 25 | -------------------------------------------------------------------------------- /docs/Makefile: -------------------------------------------------------------------------------- 1 | # Makefile for Sphinx documentation 2 | # 3 | 4 | # You can set these variables from the command line. 5 | SPHINXOPTS = 6 | SPHINXBUILD = sphinx-build 7 | PAPER = 8 | BUILDDIR = _build 9 | 10 | # Internal variables. 11 | PAPEROPT_a4 = -D latex_paper_size=a4 12 | PAPEROPT_letter = -D latex_paper_size=letter 13 | ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) . 14 | 15 | .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest 16 | 17 | help: 18 | @echo "Please use \`make ' where is one of" 19 | @echo " html to make standalone HTML files" 20 | @echo " dirhtml to make HTML files named index.html in directories" 21 | @echo " singlehtml to make a single large HTML file" 22 | @echo " pickle to make pickle files" 23 | @echo " json to make JSON files" 24 | @echo " htmlhelp to make HTML files and a HTML help project" 25 | @echo " qthelp to make HTML files and a qthelp project" 26 | @echo " devhelp to make HTML files and a Devhelp project" 27 | @echo " epub to make an epub" 28 | @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter" 29 | @echo " latexpdf to make LaTeX files and run them through pdflatex" 30 | @echo " text to make text files" 31 | @echo " man to make manual pages" 32 | @echo " changes to make an overview of all changed/added/deprecated items" 33 | @echo " linkcheck to check all external links for integrity" 34 | @echo " doctest to run all doctests embedded in the documentation (if enabled)" 35 | 36 | clean: 37 | -rm -rf $(BUILDDIR)/* 38 | 39 | html: 40 | $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html 41 | @echo 42 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." 43 | 44 | dirhtml: 45 | $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml 46 | @echo 47 | @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml." 48 | 49 | singlehtml: 50 | $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml 51 | @echo 52 | @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml." 53 | 54 | pickle: 55 | $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle 56 | @echo 57 | @echo "Build finished; now you can process the pickle files." 58 | 59 | json: 60 | $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json 61 | @echo 62 | @echo "Build finished; now you can process the JSON files." 63 | 64 | htmlhelp: 65 | $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp 66 | @echo 67 | @echo "Build finished; now you can run HTML Help Workshop with the" \ 68 | ".hhp project file in $(BUILDDIR)/htmlhelp." 69 | 70 | qthelp: 71 | $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp 72 | @echo 73 | @echo "Build finished; now you can run "qcollectiongenerator" with the" \ 74 | ".qhcp project file in $(BUILDDIR)/qthelp, like this:" 75 | @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/python-transparencydata.qhcp" 76 | @echo "To view the help file:" 77 | @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/python-transparencydata.qhc" 78 | 79 | devhelp: 80 | $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp 81 | @echo 82 | @echo "Build finished." 83 | @echo "To view the help file:" 84 | @echo "# mkdir -p $$HOME/.local/share/devhelp/python-transparencydata" 85 | @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/python-transparencydata" 86 | @echo "# devhelp" 87 | 88 | epub: 89 | $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub 90 | @echo 91 | @echo "Build finished. The epub file is in $(BUILDDIR)/epub." 92 | 93 | latex: 94 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 95 | @echo 96 | @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex." 97 | @echo "Run \`make' in that directory to run these through (pdf)latex" \ 98 | "(use \`make latexpdf' here to do that automatically)." 99 | 100 | latexpdf: 101 | $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex 102 | @echo "Running LaTeX files through pdflatex..." 103 | make -C $(BUILDDIR)/latex all-pdf 104 | @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex." 105 | 106 | text: 107 | $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text 108 | @echo 109 | @echo "Build finished. The text files are in $(BUILDDIR)/text." 110 | 111 | man: 112 | $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man 113 | @echo 114 | @echo "Build finished. The manual pages are in $(BUILDDIR)/man." 115 | 116 | changes: 117 | $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes 118 | @echo 119 | @echo "The overview file is in $(BUILDDIR)/changes." 120 | 121 | linkcheck: 122 | $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck 123 | @echo 124 | @echo "Link check complete; look for any errors in the above output " \ 125 | "or in $(BUILDDIR)/linkcheck/output.txt." 126 | 127 | doctest: 128 | $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest 129 | @echo "Testing of doctests in the sources finished, look at the " \ 130 | "results in $(BUILDDIR)/doctest/output.txt." 131 | -------------------------------------------------------------------------------- /docs/_build/doctrees/environment.pickle: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sunlightlabs/python-transparencydata/f843f7c54b4aa742f55f6a8ea5b4f7f12788c9f8/docs/_build/doctrees/environment.pickle -------------------------------------------------------------------------------- /docs/_build/doctrees/index.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sunlightlabs/python-transparencydata/f843f7c54b4aa742f55f6a8ea5b4f7f12788c9f8/docs/_build/doctrees/index.doctree -------------------------------------------------------------------------------- /docs/_build/doctrees/influenceexplorer.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sunlightlabs/python-transparencydata/f843f7c54b4aa742f55f6a8ea5b4f7f12788c9f8/docs/_build/doctrees/influenceexplorer.doctree -------------------------------------------------------------------------------- /docs/_build/doctrees/transparencydata.doctree: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sunlightlabs/python-transparencydata/f843f7c54b4aa742f55f6a8ea5b4f7f12788c9f8/docs/_build/doctrees/transparencydata.doctree -------------------------------------------------------------------------------- /docs/_build/html/.buildinfo: -------------------------------------------------------------------------------- 1 | # Sphinx build info version 1 2 | # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. 3 | config: be6005d333f3d05869027222eb47f79e 4 | tags: fbb0d17656682115ca4d033fb2f83ba1 5 | -------------------------------------------------------------------------------- /docs/_build/html/_modules/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | Overview: module code — python-transparencydata v1.0 documentation 11 | 12 | 13 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
29 |

Navigation

30 | 39 |
40 | 41 |
42 |
43 |
44 |
45 | 46 |

All modules for which code is available

47 | 49 | 50 |
51 |
52 |
53 |
54 |
55 | 67 | 68 |
69 |
70 |
71 |
72 |
73 |

Navigation

74 | 83 |
84 |
85 | © Copyright 2011, Sunlight Foundation. 86 | Created using Sphinx 1.0.7. 87 |
88 | 89 | -------------------------------------------------------------------------------- /docs/_build/html/_sources/index.txt: -------------------------------------------------------------------------------- 1 | .. python-transparencydata documentation master file, created by 2 | sphinx-quickstart on Fri Mar 18 11:16:10 2011. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | python-transparencydata's documentation 7 | ======================================= 8 | 9 | Python API wrappers for TransparencyData.com and InfluenceExplorer.com data. 10 | Both APIs provide a variety of political influence data. 11 | Influence Explorer provides easy to use summary information for politicians, 12 | organizations, industries and prominent individuals. 13 | Transparency Data provides extensive search capabilities over raw transactional 14 | records. It is useful for retrieving data sets for your own analysis. 15 | 16 | Both sites currently include data on campaign finance (federal- and 17 | state-level), federal lobbying, earmarks, and federal grants and contracts. 18 | More data sets will be added over time. 19 | 20 | .. toctree:: 21 | :maxdepth: 2 22 | 23 | transparencydata 24 | influenceexplorer 25 | 26 | 27 | Indices and tables 28 | ================== 29 | 30 | * :ref:`genindex` 31 | * :ref:`modindex` 32 | * :ref:`search` 33 | 34 | -------------------------------------------------------------------------------- /docs/_build/html/_sources/influenceexplorer.txt: -------------------------------------------------------------------------------- 1 | Influence Explorer API 2 | ====================== 3 | 4 | 5 | .. automodule:: influenceexplorer 6 | 7 | .. autoclass:: influenceexplorer.InfluenceExplorer 8 | 9 | ---------------------- 10 | General Entity Methods 11 | ---------------------- 12 | 13 | .. autoclass:: influenceexplorer.Entities() 14 | :members: 15 | 16 | ------------------ 17 | Politician Methods 18 | ------------------ 19 | 20 | .. autoclass:: influenceexplorer.Politician() 21 | :members: 22 | 23 | -------------------- 24 | Organization Methods 25 | -------------------- 26 | 27 | .. autoclass:: influenceexplorer.Organization() 28 | :members: 29 | 30 | ------------------ 31 | Individual Methods 32 | ------------------ 33 | 34 | .. autoclass:: influenceexplorer.Individual() 35 | :members: -------------------------------------------------------------------------------- /docs/_build/html/_sources/transparencydata.txt: -------------------------------------------------------------------------------- 1 | Transparency Data API 2 | ===================== 3 | 4 | ----- 5 | Usage 6 | ----- 7 | 8 | The TransparencyData class is constructed with your API key as an initialization parameter: 9 | 10 | >>> from transparencydata import TransparencyData 11 | >>> td = TransparencyData() 12 | 13 | If you do not have an API key visit http://services.sunlightlabs.com/api/ to 14 | register for one. 15 | 16 | ------------------- 17 | Parameter Operators 18 | ------------------- 19 | 20 | Some parameters allow multiple values or greater than, less than, or between operations. We allow operators to be added similar to the method used by the Django ORM. The operator is appended to the end of the parameter name using double underscore. 21 | 22 | >>> td.contributions(amount=100) # contributions equal to 100 dollars 23 | >>> td.contributions(amount__lt=100) # contributions less than 100 dollars 24 | 25 | >>> td.contributions(cycle=1990) # contributions from the 1990 election cycle 26 | >>> td.contributions(cycle__in=(1990,2008)) # contributions from the 1990 and 2008 election cycles 27 | 28 | gt 29 | Greater than specified value. 30 | 31 | lt 32 | Less than specified value. 33 | 34 | between 35 | Between the lesser value and greater value. Parameters must be passed as a two-value tuple or list. 36 | 37 | >>> td.contributions(date__between=(start_date, end_date)) 38 | 39 | in 40 | Matches any in a range of values. Parameter must be a tuple or list. 41 | 42 | 43 | See the parameter documentation (http://transparencydata.com/api/) to find out which operators are valid for each parameter. 44 | 45 | ---------------------- 46 | Campaign Contributions 47 | ---------------------- 48 | 49 | To find all contributions to Chris Van Hollen from the state of CA during the 2008 election cycle: 50 | 51 | >>> td.contributions(cycle=2008, contributor_state='CA', recipient_ft='van hollen') 52 | 53 | A list of valid contributions parameters can be accessed programmatically: 54 | 55 | >>> print td.contributions.parameters 56 | 57 | Parameter documentation: http://transparencydata.com/api/contributions 58 | 59 | Response documentation: http://transparencydata.com/docs/contributions 60 | 61 | -------- 62 | Lobbying 63 | -------- 64 | 65 | To find all lobbying conducted by John Wonderlich: 66 | 67 | >>> td.lobbying(lobbyist_ft='john wonderlich') 68 | 69 | A list of valid lobbying parameters can be accessed programmatically: 70 | 71 | >>> print td.lobbying.parameters 72 | 73 | Parameter documentation: http://transparencydata.com/api/lobbying 74 | 75 | Response documentation: http://transparencydata.com/docs/lobbying 76 | 77 | 78 | -------- 79 | Earmarks 80 | -------- 81 | 82 | To find all earmarks directed towards Seattle, WA: 83 | 84 | >>> td.earmarks(city='Seattle', state='WA') 85 | 86 | A list of valid earmark parameters can be accessed programmatically: 87 | 88 | >>> print td.earmarks.parameters 89 | 90 | Parameter documentation: http://transparencydata.com/api/earmarks 91 | 92 | Response documentation: http://transparencydata.com/docs/earmarks 93 | 94 | 95 | -------------- 96 | Federal Grants 97 | -------------- 98 | 99 | To find all grants made by the NEA in 2010: 100 | 101 | >>> td.grants(agency_ft='national endowment for the arts', fiscal_year='2010') 102 | 103 | A list of valid grant parameters can be accessed programmatically: 104 | 105 | >>> td.grants.parameters 106 | 107 | Parameter documentation: http://transparencydata.com/api/grants/ 108 | 109 | Response documentation: http://transparencydata.com/docs/grants/ 110 | 111 | 112 | ----------------- 113 | Federal Contracts 114 | ----------------- 115 | 116 | To find all federal contracts issued to Bank of America: 117 | 118 | >>> td.contracts(vendor_name='bank of america') 119 | 120 | A list of valid contract parameters can be accessed programmatically: 121 | 122 | >>> td.contracts.parameters 123 | 124 | Parameter documentation: http://transparencydata.com/api/contracts 125 | 126 | Response documentation: http://transparencydata.com/docs/contracts 127 | 128 | 129 | -------------------------------------------------------------------------------- /docs/_build/html/_static/basic.css: -------------------------------------------------------------------------------- 1 | /* 2 | * basic.css 3 | * ~~~~~~~~~ 4 | * 5 | * Sphinx stylesheet -- basic theme. 6 | * 7 | * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /* -- main layout ----------------------------------------------------------- */ 13 | 14 | div.clearer { 15 | clear: both; 16 | } 17 | 18 | /* -- relbar ---------------------------------------------------------------- */ 19 | 20 | div.related { 21 | width: 100%; 22 | font-size: 90%; 23 | } 24 | 25 | div.related h3 { 26 | display: none; 27 | } 28 | 29 | div.related ul { 30 | margin: 0; 31 | padding: 0 0 0 10px; 32 | list-style: none; 33 | } 34 | 35 | div.related li { 36 | display: inline; 37 | } 38 | 39 | div.related li.right { 40 | float: right; 41 | margin-right: 5px; 42 | } 43 | 44 | /* -- sidebar --------------------------------------------------------------- */ 45 | 46 | div.sphinxsidebarwrapper { 47 | padding: 10px 5px 0 10px; 48 | } 49 | 50 | div.sphinxsidebar { 51 | float: left; 52 | width: 230px; 53 | margin-left: -100%; 54 | font-size: 90%; 55 | } 56 | 57 | div.sphinxsidebar ul { 58 | list-style: none; 59 | } 60 | 61 | div.sphinxsidebar ul ul, 62 | div.sphinxsidebar ul.want-points { 63 | margin-left: 20px; 64 | list-style: square; 65 | } 66 | 67 | div.sphinxsidebar ul ul { 68 | margin-top: 0; 69 | margin-bottom: 0; 70 | } 71 | 72 | div.sphinxsidebar form { 73 | margin-top: 10px; 74 | } 75 | 76 | div.sphinxsidebar input { 77 | border: 1px solid #98dbcc; 78 | font-family: sans-serif; 79 | font-size: 1em; 80 | } 81 | 82 | img { 83 | border: 0; 84 | } 85 | 86 | /* -- search page ----------------------------------------------------------- */ 87 | 88 | ul.search { 89 | margin: 10px 0 0 20px; 90 | padding: 0; 91 | } 92 | 93 | ul.search li { 94 | padding: 5px 0 5px 20px; 95 | background-image: url(file.png); 96 | background-repeat: no-repeat; 97 | background-position: 0 7px; 98 | } 99 | 100 | ul.search li a { 101 | font-weight: bold; 102 | } 103 | 104 | ul.search li div.context { 105 | color: #888; 106 | margin: 2px 0 0 30px; 107 | text-align: left; 108 | } 109 | 110 | ul.keywordmatches li.goodmatch a { 111 | font-weight: bold; 112 | } 113 | 114 | /* -- index page ------------------------------------------------------------ */ 115 | 116 | table.contentstable { 117 | width: 90%; 118 | } 119 | 120 | table.contentstable p.biglink { 121 | line-height: 150%; 122 | } 123 | 124 | a.biglink { 125 | font-size: 1.3em; 126 | } 127 | 128 | span.linkdescr { 129 | font-style: italic; 130 | padding-top: 5px; 131 | font-size: 90%; 132 | } 133 | 134 | /* -- general index --------------------------------------------------------- */ 135 | 136 | table.indextable { 137 | width: 100%; 138 | } 139 | 140 | table.indextable td { 141 | text-align: left; 142 | vertical-align: top; 143 | } 144 | 145 | table.indextable dl, table.indextable dd { 146 | margin-top: 0; 147 | margin-bottom: 0; 148 | } 149 | 150 | table.indextable tr.pcap { 151 | height: 10px; 152 | } 153 | 154 | table.indextable tr.cap { 155 | margin-top: 10px; 156 | background-color: #f2f2f2; 157 | } 158 | 159 | img.toggler { 160 | margin-right: 3px; 161 | margin-top: 3px; 162 | cursor: pointer; 163 | } 164 | 165 | div.modindex-jumpbox { 166 | border-top: 1px solid #ddd; 167 | border-bottom: 1px solid #ddd; 168 | margin: 1em 0 1em 0; 169 | padding: 0.4em; 170 | } 171 | 172 | div.genindex-jumpbox { 173 | border-top: 1px solid #ddd; 174 | border-bottom: 1px solid #ddd; 175 | margin: 1em 0 1em 0; 176 | padding: 0.4em; 177 | } 178 | 179 | /* -- general body styles --------------------------------------------------- */ 180 | 181 | a.headerlink { 182 | visibility: hidden; 183 | } 184 | 185 | h1:hover > a.headerlink, 186 | h2:hover > a.headerlink, 187 | h3:hover > a.headerlink, 188 | h4:hover > a.headerlink, 189 | h5:hover > a.headerlink, 190 | h6:hover > a.headerlink, 191 | dt:hover > a.headerlink { 192 | visibility: visible; 193 | } 194 | 195 | div.body p.caption { 196 | text-align: inherit; 197 | } 198 | 199 | div.body td { 200 | text-align: left; 201 | } 202 | 203 | .field-list ul { 204 | padding-left: 1em; 205 | } 206 | 207 | .first { 208 | margin-top: 0 !important; 209 | } 210 | 211 | p.rubric { 212 | margin-top: 30px; 213 | font-weight: bold; 214 | } 215 | 216 | img.align-left, .figure.align-left, object.align-left { 217 | clear: left; 218 | float: left; 219 | margin-right: 1em; 220 | } 221 | 222 | img.align-right, .figure.align-right, object.align-right { 223 | clear: right; 224 | float: right; 225 | margin-left: 1em; 226 | } 227 | 228 | img.align-center, .figure.align-center, object.align-center { 229 | display: block; 230 | margin-left: auto; 231 | margin-right: auto; 232 | } 233 | 234 | .align-left { 235 | text-align: left; 236 | } 237 | 238 | .align-center { 239 | clear: both; 240 | text-align: center; 241 | } 242 | 243 | .align-right { 244 | text-align: right; 245 | } 246 | 247 | /* -- sidebars -------------------------------------------------------------- */ 248 | 249 | div.sidebar { 250 | margin: 0 0 0.5em 1em; 251 | border: 1px solid #ddb; 252 | padding: 7px 7px 0 7px; 253 | background-color: #ffe; 254 | width: 40%; 255 | float: right; 256 | } 257 | 258 | p.sidebar-title { 259 | font-weight: bold; 260 | } 261 | 262 | /* -- topics ---------------------------------------------------------------- */ 263 | 264 | div.topic { 265 | border: 1px solid #ccc; 266 | padding: 7px 7px 0 7px; 267 | margin: 10px 0 10px 0; 268 | } 269 | 270 | p.topic-title { 271 | font-size: 1.1em; 272 | font-weight: bold; 273 | margin-top: 10px; 274 | } 275 | 276 | /* -- admonitions ----------------------------------------------------------- */ 277 | 278 | div.admonition { 279 | margin-top: 10px; 280 | margin-bottom: 10px; 281 | padding: 7px; 282 | } 283 | 284 | div.admonition dt { 285 | font-weight: bold; 286 | } 287 | 288 | div.admonition dl { 289 | margin-bottom: 0; 290 | } 291 | 292 | p.admonition-title { 293 | margin: 0px 10px 5px 0px; 294 | font-weight: bold; 295 | } 296 | 297 | div.body p.centered { 298 | text-align: center; 299 | margin-top: 25px; 300 | } 301 | 302 | /* -- tables ---------------------------------------------------------------- */ 303 | 304 | table.docutils { 305 | border: 0; 306 | border-collapse: collapse; 307 | } 308 | 309 | table.docutils td, table.docutils th { 310 | padding: 1px 8px 1px 5px; 311 | border-top: 0; 312 | border-left: 0; 313 | border-right: 0; 314 | border-bottom: 1px solid #aaa; 315 | } 316 | 317 | table.field-list td, table.field-list th { 318 | border: 0 !important; 319 | } 320 | 321 | table.footnote td, table.footnote th { 322 | border: 0 !important; 323 | } 324 | 325 | th { 326 | text-align: left; 327 | padding-right: 5px; 328 | } 329 | 330 | table.citation { 331 | border-left: solid 1px gray; 332 | margin-left: 1px; 333 | } 334 | 335 | table.citation td { 336 | border-bottom: none; 337 | } 338 | 339 | /* -- other body styles ----------------------------------------------------- */ 340 | 341 | ol.arabic { 342 | list-style: decimal; 343 | } 344 | 345 | ol.loweralpha { 346 | list-style: lower-alpha; 347 | } 348 | 349 | ol.upperalpha { 350 | list-style: upper-alpha; 351 | } 352 | 353 | ol.lowerroman { 354 | list-style: lower-roman; 355 | } 356 | 357 | ol.upperroman { 358 | list-style: upper-roman; 359 | } 360 | 361 | dl { 362 | margin-bottom: 15px; 363 | } 364 | 365 | dd p { 366 | margin-top: 0px; 367 | } 368 | 369 | dd ul, dd table { 370 | margin-bottom: 10px; 371 | } 372 | 373 | dd { 374 | margin-top: 3px; 375 | margin-bottom: 10px; 376 | margin-left: 30px; 377 | } 378 | 379 | dt:target, .highlighted { 380 | background-color: #fbe54e; 381 | } 382 | 383 | dl.glossary dt { 384 | font-weight: bold; 385 | font-size: 1.1em; 386 | } 387 | 388 | .field-list ul { 389 | margin: 0; 390 | padding-left: 1em; 391 | } 392 | 393 | .field-list p { 394 | margin: 0; 395 | } 396 | 397 | .refcount { 398 | color: #060; 399 | } 400 | 401 | .optional { 402 | font-size: 1.3em; 403 | } 404 | 405 | .versionmodified { 406 | font-style: italic; 407 | } 408 | 409 | .system-message { 410 | background-color: #fda; 411 | padding: 5px; 412 | border: 3px solid red; 413 | } 414 | 415 | .footnote:target { 416 | background-color: #ffa; 417 | } 418 | 419 | .line-block { 420 | display: block; 421 | margin-top: 1em; 422 | margin-bottom: 1em; 423 | } 424 | 425 | .line-block .line-block { 426 | margin-top: 0; 427 | margin-bottom: 0; 428 | margin-left: 1.5em; 429 | } 430 | 431 | .guilabel, .menuselection { 432 | font-family: sans-serif; 433 | } 434 | 435 | .accelerator { 436 | text-decoration: underline; 437 | } 438 | 439 | .classifier { 440 | font-style: oblique; 441 | } 442 | 443 | /* -- code displays --------------------------------------------------------- */ 444 | 445 | pre { 446 | overflow: auto; 447 | overflow-y: hidden; /* fixes display issues on Chrome browsers */ 448 | } 449 | 450 | td.linenos pre { 451 | padding: 5px 0px; 452 | border: 0; 453 | background-color: transparent; 454 | color: #aaa; 455 | } 456 | 457 | table.highlighttable { 458 | margin-left: 0.5em; 459 | } 460 | 461 | table.highlighttable td { 462 | padding: 0 0.5em 0 0.5em; 463 | } 464 | 465 | tt.descname { 466 | background-color: transparent; 467 | font-weight: bold; 468 | font-size: 1.2em; 469 | } 470 | 471 | tt.descclassname { 472 | background-color: transparent; 473 | } 474 | 475 | tt.xref, a tt { 476 | background-color: transparent; 477 | font-weight: bold; 478 | } 479 | 480 | h1 tt, h2 tt, h3 tt, h4 tt, h5 tt, h6 tt { 481 | background-color: transparent; 482 | } 483 | 484 | .viewcode-link { 485 | float: right; 486 | } 487 | 488 | .viewcode-back { 489 | float: right; 490 | font-family: sans-serif; 491 | } 492 | 493 | div.viewcode-block:target { 494 | margin: -1px -10px; 495 | padding: 0 10px; 496 | } 497 | 498 | /* -- math display ---------------------------------------------------------- */ 499 | 500 | img.math { 501 | vertical-align: middle; 502 | } 503 | 504 | div.body div.math p { 505 | text-align: center; 506 | } 507 | 508 | span.eqno { 509 | float: right; 510 | } 511 | 512 | /* -- printout stylesheet --------------------------------------------------- */ 513 | 514 | @media print { 515 | div.document, 516 | div.documentwrapper, 517 | div.bodywrapper { 518 | margin: 0 !important; 519 | width: 100%; 520 | } 521 | 522 | div.sphinxsidebar, 523 | div.related, 524 | div.footer, 525 | #top-link { 526 | display: none; 527 | } 528 | } 529 | -------------------------------------------------------------------------------- /docs/_build/html/_static/default.css: -------------------------------------------------------------------------------- 1 | /* 2 | * default.css_t 3 | * ~~~~~~~~~~~~~ 4 | * 5 | * Sphinx stylesheet -- default theme. 6 | * 7 | * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | @import url("basic.css"); 13 | 14 | /* -- page layout ----------------------------------------------------------- */ 15 | 16 | body { 17 | font-family: sans-serif; 18 | font-size: 100%; 19 | background-color: #11303d; 20 | color: #000; 21 | margin: 0; 22 | padding: 0; 23 | } 24 | 25 | div.document { 26 | background-color: #1c4e63; 27 | } 28 | 29 | div.documentwrapper { 30 | float: left; 31 | width: 100%; 32 | } 33 | 34 | div.bodywrapper { 35 | margin: 0 0 0 230px; 36 | } 37 | 38 | div.body { 39 | background-color: #ffffff; 40 | color: #000000; 41 | padding: 0 20px 30px 20px; 42 | } 43 | 44 | div.footer { 45 | color: #ffffff; 46 | width: 100%; 47 | padding: 9px 0 9px 0; 48 | text-align: center; 49 | font-size: 75%; 50 | } 51 | 52 | div.footer a { 53 | color: #ffffff; 54 | text-decoration: underline; 55 | } 56 | 57 | div.related { 58 | background-color: #133f52; 59 | line-height: 30px; 60 | color: #ffffff; 61 | } 62 | 63 | div.related a { 64 | color: #ffffff; 65 | } 66 | 67 | div.sphinxsidebar { 68 | } 69 | 70 | div.sphinxsidebar h3 { 71 | font-family: 'Trebuchet MS', sans-serif; 72 | color: #ffffff; 73 | font-size: 1.4em; 74 | font-weight: normal; 75 | margin: 0; 76 | padding: 0; 77 | } 78 | 79 | div.sphinxsidebar h3 a { 80 | color: #ffffff; 81 | } 82 | 83 | div.sphinxsidebar h4 { 84 | font-family: 'Trebuchet MS', sans-serif; 85 | color: #ffffff; 86 | font-size: 1.3em; 87 | font-weight: normal; 88 | margin: 5px 0 0 0; 89 | padding: 0; 90 | } 91 | 92 | div.sphinxsidebar p { 93 | color: #ffffff; 94 | } 95 | 96 | div.sphinxsidebar p.topless { 97 | margin: 5px 10px 10px 10px; 98 | } 99 | 100 | div.sphinxsidebar ul { 101 | margin: 10px; 102 | padding: 0; 103 | color: #ffffff; 104 | } 105 | 106 | div.sphinxsidebar a { 107 | color: #98dbcc; 108 | } 109 | 110 | div.sphinxsidebar input { 111 | border: 1px solid #98dbcc; 112 | font-family: sans-serif; 113 | font-size: 1em; 114 | } 115 | 116 | 117 | 118 | /* -- hyperlink styles ------------------------------------------------------ */ 119 | 120 | a { 121 | color: #355f7c; 122 | text-decoration: none; 123 | } 124 | 125 | a:visited { 126 | color: #355f7c; 127 | text-decoration: none; 128 | } 129 | 130 | a:hover { 131 | text-decoration: underline; 132 | } 133 | 134 | 135 | 136 | /* -- body styles ----------------------------------------------------------- */ 137 | 138 | div.body h1, 139 | div.body h2, 140 | div.body h3, 141 | div.body h4, 142 | div.body h5, 143 | div.body h6 { 144 | font-family: 'Trebuchet MS', sans-serif; 145 | background-color: #f2f2f2; 146 | font-weight: normal; 147 | color: #20435c; 148 | border-bottom: 1px solid #ccc; 149 | margin: 20px -20px 10px -20px; 150 | padding: 3px 0 3px 10px; 151 | } 152 | 153 | div.body h1 { margin-top: 0; font-size: 200%; } 154 | div.body h2 { font-size: 160%; } 155 | div.body h3 { font-size: 140%; } 156 | div.body h4 { font-size: 120%; } 157 | div.body h5 { font-size: 110%; } 158 | div.body h6 { font-size: 100%; } 159 | 160 | a.headerlink { 161 | color: #c60f0f; 162 | font-size: 0.8em; 163 | padding: 0 4px 0 4px; 164 | text-decoration: none; 165 | } 166 | 167 | a.headerlink:hover { 168 | background-color: #c60f0f; 169 | color: white; 170 | } 171 | 172 | div.body p, div.body dd, div.body li { 173 | text-align: justify; 174 | line-height: 130%; 175 | } 176 | 177 | div.admonition p.admonition-title + p { 178 | display: inline; 179 | } 180 | 181 | div.admonition p { 182 | margin-bottom: 5px; 183 | } 184 | 185 | div.admonition pre { 186 | margin-bottom: 5px; 187 | } 188 | 189 | div.admonition ul, div.admonition ol { 190 | margin-bottom: 5px; 191 | } 192 | 193 | div.note { 194 | background-color: #eee; 195 | border: 1px solid #ccc; 196 | } 197 | 198 | div.seealso { 199 | background-color: #ffc; 200 | border: 1px solid #ff6; 201 | } 202 | 203 | div.topic { 204 | background-color: #eee; 205 | } 206 | 207 | div.warning { 208 | background-color: #ffe4e4; 209 | border: 1px solid #f66; 210 | } 211 | 212 | p.admonition-title { 213 | display: inline; 214 | } 215 | 216 | p.admonition-title:after { 217 | content: ":"; 218 | } 219 | 220 | pre { 221 | padding: 5px; 222 | background-color: #eeffcc; 223 | color: #333333; 224 | line-height: 120%; 225 | border: 1px solid #ac9; 226 | border-left: none; 227 | border-right: none; 228 | } 229 | 230 | tt { 231 | background-color: #ecf0f3; 232 | padding: 0 1px 0 1px; 233 | font-size: 0.95em; 234 | } 235 | 236 | th { 237 | background-color: #ede; 238 | } 239 | 240 | .warning tt { 241 | background: #efc2c2; 242 | } 243 | 244 | .note tt { 245 | background: #d6d6d6; 246 | } 247 | 248 | .viewcode-back { 249 | font-family: sans-serif; 250 | } 251 | 252 | div.viewcode-block:target { 253 | background-color: #f4debf; 254 | border-top: 1px solid #ac9; 255 | border-bottom: 1px solid #ac9; 256 | } -------------------------------------------------------------------------------- /docs/_build/html/_static/doctools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * doctools.js 3 | * ~~~~~~~~~~~ 4 | * 5 | * Sphinx JavaScript utilties for all documentation. 6 | * 7 | * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /** 13 | * select a different prefix for underscore 14 | */ 15 | $u = _.noConflict(); 16 | 17 | /** 18 | * make the code below compatible with browsers without 19 | * an installed firebug like debugger 20 | if (!window.console || !console.firebug) { 21 | var names = ["log", "debug", "info", "warn", "error", "assert", "dir", 22 | "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", 23 | "profile", "profileEnd"]; 24 | window.console = {}; 25 | for (var i = 0; i < names.length; ++i) 26 | window.console[names[i]] = function() {}; 27 | } 28 | */ 29 | 30 | /** 31 | * small helper function to urldecode strings 32 | */ 33 | jQuery.urldecode = function(x) { 34 | return decodeURIComponent(x).replace(/\+/g, ' '); 35 | } 36 | 37 | /** 38 | * small helper function to urlencode strings 39 | */ 40 | jQuery.urlencode = encodeURIComponent; 41 | 42 | /** 43 | * This function returns the parsed url parameters of the 44 | * current request. Multiple values per key are supported, 45 | * it will always return arrays of strings for the value parts. 46 | */ 47 | jQuery.getQueryParameters = function(s) { 48 | if (typeof s == 'undefined') 49 | s = document.location.search; 50 | var parts = s.substr(s.indexOf('?') + 1).split('&'); 51 | var result = {}; 52 | for (var i = 0; i < parts.length; i++) { 53 | var tmp = parts[i].split('=', 2); 54 | var key = jQuery.urldecode(tmp[0]); 55 | var value = jQuery.urldecode(tmp[1]); 56 | if (key in result) 57 | result[key].push(value); 58 | else 59 | result[key] = [value]; 60 | } 61 | return result; 62 | }; 63 | 64 | /** 65 | * small function to check if an array contains 66 | * a given item. 67 | */ 68 | jQuery.contains = function(arr, item) { 69 | for (var i = 0; i < arr.length; i++) { 70 | if (arr[i] == item) 71 | return true; 72 | } 73 | return false; 74 | }; 75 | 76 | /** 77 | * highlight a given string on a jquery object by wrapping it in 78 | * span elements with the given class name. 79 | */ 80 | jQuery.fn.highlightText = function(text, className) { 81 | function highlight(node) { 82 | if (node.nodeType == 3) { 83 | var val = node.nodeValue; 84 | var pos = val.toLowerCase().indexOf(text); 85 | if (pos >= 0 && !jQuery(node.parentNode).hasClass(className)) { 86 | var span = document.createElement("span"); 87 | span.className = className; 88 | span.appendChild(document.createTextNode(val.substr(pos, text.length))); 89 | node.parentNode.insertBefore(span, node.parentNode.insertBefore( 90 | document.createTextNode(val.substr(pos + text.length)), 91 | node.nextSibling)); 92 | node.nodeValue = val.substr(0, pos); 93 | } 94 | } 95 | else if (!jQuery(node).is("button, select, textarea")) { 96 | jQuery.each(node.childNodes, function() { 97 | highlight(this); 98 | }); 99 | } 100 | } 101 | return this.each(function() { 102 | highlight(this); 103 | }); 104 | }; 105 | 106 | /** 107 | * Small JavaScript module for the documentation. 108 | */ 109 | var Documentation = { 110 | 111 | init : function() { 112 | this.fixFirefoxAnchorBug(); 113 | this.highlightSearchWords(); 114 | this.initIndexTable(); 115 | }, 116 | 117 | /** 118 | * i18n support 119 | */ 120 | TRANSLATIONS : {}, 121 | PLURAL_EXPR : function(n) { return n == 1 ? 0 : 1; }, 122 | LOCALE : 'unknown', 123 | 124 | // gettext and ngettext don't access this so that the functions 125 | // can safely bound to a different name (_ = Documentation.gettext) 126 | gettext : function(string) { 127 | var translated = Documentation.TRANSLATIONS[string]; 128 | if (typeof translated == 'undefined') 129 | return string; 130 | return (typeof translated == 'string') ? translated : translated[0]; 131 | }, 132 | 133 | ngettext : function(singular, plural, n) { 134 | var translated = Documentation.TRANSLATIONS[singular]; 135 | if (typeof translated == 'undefined') 136 | return (n == 1) ? singular : plural; 137 | return translated[Documentation.PLURALEXPR(n)]; 138 | }, 139 | 140 | addTranslations : function(catalog) { 141 | for (var key in catalog.messages) 142 | this.TRANSLATIONS[key] = catalog.messages[key]; 143 | this.PLURAL_EXPR = new Function('n', 'return +(' + catalog.plural_expr + ')'); 144 | this.LOCALE = catalog.locale; 145 | }, 146 | 147 | /** 148 | * add context elements like header anchor links 149 | */ 150 | addContextElements : function() { 151 | $('div[id] > :header:first').each(function() { 152 | $('\u00B6'). 153 | attr('href', '#' + this.id). 154 | attr('title', _('Permalink to this headline')). 155 | appendTo(this); 156 | }); 157 | $('dt[id]').each(function() { 158 | $('\u00B6'). 159 | attr('href', '#' + this.id). 160 | attr('title', _('Permalink to this definition')). 161 | appendTo(this); 162 | }); 163 | }, 164 | 165 | /** 166 | * workaround a firefox stupidity 167 | */ 168 | fixFirefoxAnchorBug : function() { 169 | if (document.location.hash && $.browser.mozilla) 170 | window.setTimeout(function() { 171 | document.location.href += ''; 172 | }, 10); 173 | }, 174 | 175 | /** 176 | * highlight the search words provided in the url in the text 177 | */ 178 | highlightSearchWords : function() { 179 | var params = $.getQueryParameters(); 180 | var terms = (params.highlight) ? params.highlight[0].split(/\s+/) : []; 181 | if (terms.length) { 182 | var body = $('div.body'); 183 | window.setTimeout(function() { 184 | $.each(terms, function() { 185 | body.highlightText(this.toLowerCase(), 'highlighted'); 186 | }); 187 | }, 10); 188 | $('
  • ' + _('Hide Search Matches') + '
    • ') 190 | .appendTo($('.sidebar .this-page-menu')); 191 | } 192 | }, 193 | 194 | /** 195 | * init the domain index toggle buttons 196 | */ 197 | initIndexTable : function() { 198 | var togglers = $('img.toggler').click(function() { 199 | var src = $(this).attr('src'); 200 | var idnum = $(this).attr('id').substr(7); 201 | $('tr.cg-' + idnum).toggle(); 202 | if (src.substr(-9) == 'minus.png') 203 | $(this).attr('src', src.substr(0, src.length-9) + 'plus.png'); 204 | else 205 | $(this).attr('src', src.substr(0, src.length-8) + 'minus.png'); 206 | }).css('display', ''); 207 | if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) { 208 | togglers.click(); 209 | } 210 | }, 211 | 212 | /** 213 | * helper function to hide the search marks again 214 | */ 215 | hideSearchWords : function() { 216 | $('.sidebar .this-page-menu li.highlight-link').fadeOut(300); 217 | $('span.highlighted').removeClass('highlighted'); 218 | }, 219 | 220 | /** 221 | * make the url absolute 222 | */ 223 | makeURL : function(relativeURL) { 224 | return DOCUMENTATION_OPTIONS.URL_ROOT + '/' + relativeURL; 225 | }, 226 | 227 | /** 228 | * get the current relative url 229 | */ 230 | getCurrentURL : function() { 231 | var path = document.location.pathname; 232 | var parts = path.split(/\//); 233 | $.each(DOCUMENTATION_OPTIONS.URL_ROOT.split(/\//), function() { 234 | if (this == '..') 235 | parts.pop(); 236 | }); 237 | var url = parts.join('/'); 238 | return path.substring(url.lastIndexOf('/') + 1, path.length - 1); 239 | } 240 | }; 241 | 242 | // quick alias for translations 243 | _ = Documentation.gettext; 244 | 245 | $(document).ready(function() { 246 | Documentation.init(); 247 | }); 248 | -------------------------------------------------------------------------------- /docs/_build/html/_static/file.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sunlightlabs/python-transparencydata/f843f7c54b4aa742f55f6a8ea5b4f7f12788c9f8/docs/_build/html/_static/file.png -------------------------------------------------------------------------------- /docs/_build/html/_static/minus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sunlightlabs/python-transparencydata/f843f7c54b4aa742f55f6a8ea5b4f7f12788c9f8/docs/_build/html/_static/minus.png -------------------------------------------------------------------------------- /docs/_build/html/_static/plus.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sunlightlabs/python-transparencydata/f843f7c54b4aa742f55f6a8ea5b4f7f12788c9f8/docs/_build/html/_static/plus.png -------------------------------------------------------------------------------- /docs/_build/html/_static/pygments.css: -------------------------------------------------------------------------------- 1 | .highlight .hll { background-color: #ffffcc } 2 | .highlight { background: #eeffcc; } 3 | .highlight .c { color: #408090; font-style: italic } /* Comment */ 4 | .highlight .err { border: 1px solid #FF0000 } /* Error */ 5 | .highlight .k { color: #007020; font-weight: bold } /* Keyword */ 6 | .highlight .o { color: #666666 } /* Operator */ 7 | .highlight .cm { color: #408090; font-style: italic } /* Comment.Multiline */ 8 | .highlight .cp { color: #007020 } /* Comment.Preproc */ 9 | .highlight .c1 { color: #408090; font-style: italic } /* Comment.Single */ 10 | .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ 11 | .highlight .gd { color: #A00000 } /* Generic.Deleted */ 12 | .highlight .ge { font-style: italic } /* Generic.Emph */ 13 | .highlight .gr { color: #FF0000 } /* Generic.Error */ 14 | .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ 15 | .highlight .gi { color: #00A000 } /* Generic.Inserted */ 16 | .highlight .go { color: #303030 } /* Generic.Output */ 17 | .highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */ 18 | .highlight .gs { font-weight: bold } /* Generic.Strong */ 19 | .highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */ 20 | .highlight .gt { color: #0040D0 } /* Generic.Traceback */ 21 | .highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */ 22 | .highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */ 23 | .highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */ 24 | .highlight .kp { color: #007020 } /* Keyword.Pseudo */ 25 | .highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */ 26 | .highlight .kt { color: #902000 } /* Keyword.Type */ 27 | .highlight .m { color: #208050 } /* Literal.Number */ 28 | .highlight .s { color: #4070a0 } /* Literal.String */ 29 | .highlight .na { color: #4070a0 } /* Name.Attribute */ 30 | .highlight .nb { color: #007020 } /* Name.Builtin */ 31 | .highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */ 32 | .highlight .no { color: #60add5 } /* Name.Constant */ 33 | .highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */ 34 | .highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */ 35 | .highlight .ne { color: #007020 } /* Name.Exception */ 36 | .highlight .nf { color: #06287e } /* Name.Function */ 37 | .highlight .nl { color: #002070; font-weight: bold } /* Name.Label */ 38 | .highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */ 39 | .highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */ 40 | .highlight .nv { color: #bb60d5 } /* Name.Variable */ 41 | .highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */ 42 | .highlight .w { color: #bbbbbb } /* Text.Whitespace */ 43 | .highlight .mf { color: #208050 } /* Literal.Number.Float */ 44 | .highlight .mh { color: #208050 } /* Literal.Number.Hex */ 45 | .highlight .mi { color: #208050 } /* Literal.Number.Integer */ 46 | .highlight .mo { color: #208050 } /* Literal.Number.Oct */ 47 | .highlight .sb { color: #4070a0 } /* Literal.String.Backtick */ 48 | .highlight .sc { color: #4070a0 } /* Literal.String.Char */ 49 | .highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */ 50 | .highlight .s2 { color: #4070a0 } /* Literal.String.Double */ 51 | .highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */ 52 | .highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */ 53 | .highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */ 54 | .highlight .sx { color: #c65d09 } /* Literal.String.Other */ 55 | .highlight .sr { color: #235388 } /* Literal.String.Regex */ 56 | .highlight .s1 { color: #4070a0 } /* Literal.String.Single */ 57 | .highlight .ss { color: #517918 } /* Literal.String.Symbol */ 58 | .highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */ 59 | .highlight .vc { color: #bb60d5 } /* Name.Variable.Class */ 60 | .highlight .vg { color: #bb60d5 } /* Name.Variable.Global */ 61 | .highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */ 62 | .highlight .il { color: #208050 } /* Literal.Number.Integer.Long */ -------------------------------------------------------------------------------- /docs/_build/html/_static/searchtools.js: -------------------------------------------------------------------------------- 1 | /* 2 | * searchtools.js 3 | * ~~~~~~~~~~~~~~ 4 | * 5 | * Sphinx JavaScript utilties for the full-text search. 6 | * 7 | * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. 8 | * :license: BSD, see LICENSE for details. 9 | * 10 | */ 11 | 12 | /** 13 | * helper function to return a node containing the 14 | * search summary for a given text. keywords is a list 15 | * of stemmed words, hlwords is the list of normal, unstemmed 16 | * words. the first one is used to find the occurance, the 17 | * latter for highlighting it. 18 | */ 19 | 20 | jQuery.makeSearchSummary = function(text, keywords, hlwords) { 21 | var textLower = text.toLowerCase(); 22 | var start = 0; 23 | $.each(keywords, function() { 24 | var i = textLower.indexOf(this.toLowerCase()); 25 | if (i > -1) 26 | start = i; 27 | }); 28 | start = Math.max(start - 120, 0); 29 | var excerpt = ((start > 0) ? '...' : '') + 30 | $.trim(text.substr(start, 240)) + 31 | ((start + 240 - text.length) ? '...' : ''); 32 | var rv = $('
    ').text(excerpt); 33 | $.each(hlwords, function() { 34 | rv = rv.highlightText(this, 'highlighted'); 35 | }); 36 | return rv; 37 | } 38 | 39 | /** 40 | * Porter Stemmer 41 | */ 42 | var PorterStemmer = function() { 43 | 44 | var step2list = { 45 | ational: 'ate', 46 | tional: 'tion', 47 | enci: 'ence', 48 | anci: 'ance', 49 | izer: 'ize', 50 | bli: 'ble', 51 | alli: 'al', 52 | entli: 'ent', 53 | eli: 'e', 54 | ousli: 'ous', 55 | ization: 'ize', 56 | ation: 'ate', 57 | ator: 'ate', 58 | alism: 'al', 59 | iveness: 'ive', 60 | fulness: 'ful', 61 | ousness: 'ous', 62 | aliti: 'al', 63 | iviti: 'ive', 64 | biliti: 'ble', 65 | logi: 'log' 66 | }; 67 | 68 | var step3list = { 69 | icate: 'ic', 70 | ative: '', 71 | alize: 'al', 72 | iciti: 'ic', 73 | ical: 'ic', 74 | ful: '', 75 | ness: '' 76 | }; 77 | 78 | var c = "[^aeiou]"; // consonant 79 | var v = "[aeiouy]"; // vowel 80 | var C = c + "[^aeiouy]*"; // consonant sequence 81 | var V = v + "[aeiou]*"; // vowel sequence 82 | 83 | var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0 84 | var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1 85 | var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1 86 | var s_v = "^(" + C + ")?" + v; // vowel in stem 87 | 88 | this.stemWord = function (w) { 89 | var stem; 90 | var suffix; 91 | var firstch; 92 | var origword = w; 93 | 94 | if (w.length < 3) 95 | return w; 96 | 97 | var re; 98 | var re2; 99 | var re3; 100 | var re4; 101 | 102 | firstch = w.substr(0,1); 103 | if (firstch == "y") 104 | w = firstch.toUpperCase() + w.substr(1); 105 | 106 | // Step 1a 107 | re = /^(.+?)(ss|i)es$/; 108 | re2 = /^(.+?)([^s])s$/; 109 | 110 | if (re.test(w)) 111 | w = w.replace(re,"$1$2"); 112 | else if (re2.test(w)) 113 | w = w.replace(re2,"$1$2"); 114 | 115 | // Step 1b 116 | re = /^(.+?)eed$/; 117 | re2 = /^(.+?)(ed|ing)$/; 118 | if (re.test(w)) { 119 | var fp = re.exec(w); 120 | re = new RegExp(mgr0); 121 | if (re.test(fp[1])) { 122 | re = /.$/; 123 | w = w.replace(re,""); 124 | } 125 | } 126 | else if (re2.test(w)) { 127 | var fp = re2.exec(w); 128 | stem = fp[1]; 129 | re2 = new RegExp(s_v); 130 | if (re2.test(stem)) { 131 | w = stem; 132 | re2 = /(at|bl|iz)$/; 133 | re3 = new RegExp("([^aeiouylsz])\\1$"); 134 | re4 = new RegExp("^" + C + v + "[^aeiouwxy]$"); 135 | if (re2.test(w)) 136 | w = w + "e"; 137 | else if (re3.test(w)) { 138 | re = /.$/; 139 | w = w.replace(re,""); 140 | } 141 | else if (re4.test(w)) 142 | w = w + "e"; 143 | } 144 | } 145 | 146 | // Step 1c 147 | re = /^(.+?)y$/; 148 | if (re.test(w)) { 149 | var fp = re.exec(w); 150 | stem = fp[1]; 151 | re = new RegExp(s_v); 152 | if (re.test(stem)) 153 | w = stem + "i"; 154 | } 155 | 156 | // Step 2 157 | re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/; 158 | if (re.test(w)) { 159 | var fp = re.exec(w); 160 | stem = fp[1]; 161 | suffix = fp[2]; 162 | re = new RegExp(mgr0); 163 | if (re.test(stem)) 164 | w = stem + step2list[suffix]; 165 | } 166 | 167 | // Step 3 168 | re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/; 169 | if (re.test(w)) { 170 | var fp = re.exec(w); 171 | stem = fp[1]; 172 | suffix = fp[2]; 173 | re = new RegExp(mgr0); 174 | if (re.test(stem)) 175 | w = stem + step3list[suffix]; 176 | } 177 | 178 | // Step 4 179 | re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/; 180 | re2 = /^(.+?)(s|t)(ion)$/; 181 | if (re.test(w)) { 182 | var fp = re.exec(w); 183 | stem = fp[1]; 184 | re = new RegExp(mgr1); 185 | if (re.test(stem)) 186 | w = stem; 187 | } 188 | else if (re2.test(w)) { 189 | var fp = re2.exec(w); 190 | stem = fp[1] + fp[2]; 191 | re2 = new RegExp(mgr1); 192 | if (re2.test(stem)) 193 | w = stem; 194 | } 195 | 196 | // Step 5 197 | re = /^(.+?)e$/; 198 | if (re.test(w)) { 199 | var fp = re.exec(w); 200 | stem = fp[1]; 201 | re = new RegExp(mgr1); 202 | re2 = new RegExp(meq1); 203 | re3 = new RegExp("^" + C + v + "[^aeiouwxy]$"); 204 | if (re.test(stem) || (re2.test(stem) && !(re3.test(stem)))) 205 | w = stem; 206 | } 207 | re = /ll$/; 208 | re2 = new RegExp(mgr1); 209 | if (re.test(w) && re2.test(w)) { 210 | re = /.$/; 211 | w = w.replace(re,""); 212 | } 213 | 214 | // and turn initial Y back to y 215 | if (firstch == "y") 216 | w = firstch.toLowerCase() + w.substr(1); 217 | return w; 218 | } 219 | } 220 | 221 | 222 | /** 223 | * Search Module 224 | */ 225 | var Search = { 226 | 227 | _index : null, 228 | _queued_query : null, 229 | _pulse_status : -1, 230 | 231 | init : function() { 232 | var params = $.getQueryParameters(); 233 | if (params.q) { 234 | var query = params.q[0]; 235 | $('input[name="q"]')[0].value = query; 236 | this.performSearch(query); 237 | } 238 | }, 239 | 240 | loadIndex : function(url) { 241 | $.ajax({type: "GET", url: url, data: null, success: null, 242 | dataType: "script", cache: true}); 243 | }, 244 | 245 | setIndex : function(index) { 246 | var q; 247 | this._index = index; 248 | if ((q = this._queued_query) !== null) { 249 | this._queued_query = null; 250 | Search.query(q); 251 | } 252 | }, 253 | 254 | hasIndex : function() { 255 | return this._index !== null; 256 | }, 257 | 258 | deferQuery : function(query) { 259 | this._queued_query = query; 260 | }, 261 | 262 | stopPulse : function() { 263 | this._pulse_status = 0; 264 | }, 265 | 266 | startPulse : function() { 267 | if (this._pulse_status >= 0) 268 | return; 269 | function pulse() { 270 | Search._pulse_status = (Search._pulse_status + 1) % 4; 271 | var dotString = ''; 272 | for (var i = 0; i < Search._pulse_status; i++) 273 | dotString += '.'; 274 | Search.dots.text(dotString); 275 | if (Search._pulse_status > -1) 276 | window.setTimeout(pulse, 500); 277 | }; 278 | pulse(); 279 | }, 280 | 281 | /** 282 | * perform a search for something 283 | */ 284 | performSearch : function(query) { 285 | // create the required interface elements 286 | this.out = $('#search-results'); 287 | this.title = $('

    ' + _('Searching') + '

    ').appendTo(this.out); 288 | this.dots = $('').appendTo(this.title); 289 | this.status = $('

    ').appendTo(this.out); 290 | this.output = $('
      ').appendTo(this.out); 291 | 292 | $('#search-progress').text(_('Preparing search...')); 293 | this.startPulse(); 294 | 295 | // index already loaded, the browser was quick! 296 | if (this.hasIndex()) 297 | this.query(query); 298 | else 299 | this.deferQuery(query); 300 | }, 301 | 302 | query : function(query) { 303 | var stopwords = ['and', 'then', 'into', 'it', 'as', 'are', 'in', 304 | 'if', 'for', 'no', 'there', 'their', 'was', 'is', 305 | 'be', 'to', 'that', 'but', 'they', 'not', 'such', 306 | 'with', 'by', 'a', 'on', 'these', 'of', 'will', 307 | 'this', 'near', 'the', 'or', 'at']; 308 | 309 | // stem the searchterms and add them to the correct list 310 | var stemmer = new PorterStemmer(); 311 | var searchterms = []; 312 | var excluded = []; 313 | var hlterms = []; 314 | var tmp = query.split(/\s+/); 315 | var object = (tmp.length == 1) ? tmp[0].toLowerCase() : null; 316 | for (var i = 0; i < tmp.length; i++) { 317 | if ($u.indexOf(stopwords, tmp[i]) != -1 || tmp[i].match(/^\d+$/) || 318 | tmp[i] == "") { 319 | // skip this "word" 320 | continue; 321 | } 322 | // stem the word 323 | var word = stemmer.stemWord(tmp[i]).toLowerCase(); 324 | // select the correct list 325 | if (word[0] == '-') { 326 | var toAppend = excluded; 327 | word = word.substr(1); 328 | } 329 | else { 330 | var toAppend = searchterms; 331 | hlterms.push(tmp[i].toLowerCase()); 332 | } 333 | // only add if not already in the list 334 | if (!$.contains(toAppend, word)) 335 | toAppend.push(word); 336 | }; 337 | var highlightstring = '?highlight=' + $.urlencode(hlterms.join(" ")); 338 | 339 | // console.debug('SEARCH: searching for:'); 340 | // console.info('required: ', searchterms); 341 | // console.info('excluded: ', excluded); 342 | 343 | // prepare search 344 | var filenames = this._index.filenames; 345 | var titles = this._index.titles; 346 | var terms = this._index.terms; 347 | var objects = this._index.objects; 348 | var objtypes = this._index.objtypes; 349 | var objnames = this._index.objnames; 350 | var fileMap = {}; 351 | var files = null; 352 | // different result priorities 353 | var importantResults = []; 354 | var objectResults = []; 355 | var regularResults = []; 356 | var unimportantResults = []; 357 | $('#search-progress').empty(); 358 | 359 | // lookup as object 360 | if (object != null) { 361 | for (var prefix in objects) { 362 | for (var name in objects[prefix]) { 363 | var fullname = (prefix ? prefix + '.' : '') + name; 364 | if (fullname.toLowerCase().indexOf(object) > -1) { 365 | match = objects[prefix][name]; 366 | descr = objnames[match[1]] + _(', in ') + titles[match[0]]; 367 | // XXX the generated anchors are not generally correct 368 | // XXX there may be custom prefixes 369 | result = [filenames[match[0]], fullname, '#'+fullname, descr]; 370 | switch (match[2]) { 371 | case 1: objectResults.push(result); break; 372 | case 0: importantResults.push(result); break; 373 | case 2: unimportantResults.push(result); break; 374 | } 375 | } 376 | } 377 | } 378 | } 379 | 380 | // sort results descending 381 | objectResults.sort(function(a, b) { 382 | return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); 383 | }); 384 | 385 | importantResults.sort(function(a, b) { 386 | return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); 387 | }); 388 | 389 | unimportantResults.sort(function(a, b) { 390 | return (a[1] > b[1]) ? -1 : ((a[1] < b[1]) ? 1 : 0); 391 | }); 392 | 393 | 394 | // perform the search on the required terms 395 | for (var i = 0; i < searchterms.length; i++) { 396 | var word = searchterms[i]; 397 | // no match but word was a required one 398 | if ((files = terms[word]) == null) 399 | break; 400 | if (files.length == undefined) { 401 | files = [files]; 402 | } 403 | // create the mapping 404 | for (var j = 0; j < files.length; j++) { 405 | var file = files[j]; 406 | if (file in fileMap) 407 | fileMap[file].push(word); 408 | else 409 | fileMap[file] = [word]; 410 | } 411 | } 412 | 413 | // now check if the files don't contain excluded terms 414 | for (var file in fileMap) { 415 | var valid = true; 416 | 417 | // check if all requirements are matched 418 | if (fileMap[file].length != searchterms.length) 419 | continue; 420 | 421 | // ensure that none of the excluded terms is in the 422 | // search result. 423 | for (var i = 0; i < excluded.length; i++) { 424 | if (terms[excluded[i]] == file || 425 | $.contains(terms[excluded[i]] || [], file)) { 426 | valid = false; 427 | break; 428 | } 429 | } 430 | 431 | // if we have still a valid result we can add it 432 | // to the result list 433 | if (valid) 434 | regularResults.push([filenames[file], titles[file], '', null]); 435 | } 436 | 437 | // delete unused variables in order to not waste 438 | // memory until list is retrieved completely 439 | delete filenames, titles, terms; 440 | 441 | // now sort the regular results descending by title 442 | regularResults.sort(function(a, b) { 443 | var left = a[1].toLowerCase(); 444 | var right = b[1].toLowerCase(); 445 | return (left > right) ? -1 : ((left < right) ? 1 : 0); 446 | }); 447 | 448 | // combine all results 449 | var results = unimportantResults.concat(regularResults) 450 | .concat(objectResults).concat(importantResults); 451 | 452 | // print the results 453 | var resultCount = results.length; 454 | function displayNextItem() { 455 | // results left, load the summary and display it 456 | if (results.length) { 457 | var item = results.pop(); 458 | var listItem = $('
    • '); 459 | if (DOCUMENTATION_OPTIONS.FILE_SUFFIX == '') { 460 | // dirhtml builder 461 | var dirname = item[0] + '/'; 462 | if (dirname.match(/\/index\/$/)) { 463 | dirname = dirname.substring(0, dirname.length-6); 464 | } else if (dirname == 'index/') { 465 | dirname = ''; 466 | } 467 | listItem.append($('').attr('href', 468 | DOCUMENTATION_OPTIONS.URL_ROOT + dirname + 469 | highlightstring + item[2]).html(item[1])); 470 | } else { 471 | // normal html builders 472 | listItem.append($('').attr('href', 473 | item[0] + DOCUMENTATION_OPTIONS.FILE_SUFFIX + 474 | highlightstring + item[2]).html(item[1])); 475 | } 476 | if (item[3]) { 477 | listItem.append($(' (' + item[3] + ')')); 478 | Search.output.append(listItem); 479 | listItem.slideDown(5, function() { 480 | displayNextItem(); 481 | }); 482 | } else if (DOCUMENTATION_OPTIONS.HAS_SOURCE) { 483 | $.get(DOCUMENTATION_OPTIONS.URL_ROOT + '_sources/' + 484 | item[0] + '.txt', function(data) { 485 | if (data != '') { 486 | listItem.append($.makeSearchSummary(data, searchterms, hlterms)); 487 | Search.output.append(listItem); 488 | } 489 | listItem.slideDown(5, function() { 490 | displayNextItem(); 491 | }); 492 | }); 493 | } else { 494 | // no source available, just display title 495 | Search.output.append(listItem); 496 | listItem.slideDown(5, function() { 497 | displayNextItem(); 498 | }); 499 | } 500 | } 501 | // search finished, update title and status message 502 | else { 503 | Search.stopPulse(); 504 | Search.title.text(_('Search Results')); 505 | if (!resultCount) 506 | Search.status.text(_('Your search did not match any documents. Please make sure that all words are spelled correctly and that you\'ve selected enough categories.')); 507 | else 508 | Search.status.text(_('Search finished, found %s page(s) matching the search query.').replace('%s', resultCount)); 509 | Search.status.fadeIn(500); 510 | } 511 | } 512 | displayNextItem(); 513 | } 514 | } 515 | 516 | $(document).ready(function() { 517 | Search.init(); 518 | }); 519 | -------------------------------------------------------------------------------- /docs/_build/html/_static/sidebar.js: -------------------------------------------------------------------------------- 1 | /* 2 | * sidebar.js 3 | * ~~~~~~~~~~ 4 | * 5 | * This script makes the Sphinx sidebar collapsible. 6 | * 7 | * .sphinxsidebar contains .sphinxsidebarwrapper. This script adds 8 | * in .sphixsidebar, after .sphinxsidebarwrapper, the #sidebarbutton 9 | * used to collapse and expand the sidebar. 10 | * 11 | * When the sidebar is collapsed the .sphinxsidebarwrapper is hidden 12 | * and the width of the sidebar and the margin-left of the document 13 | * are decreased. When the sidebar is expanded the opposite happens. 14 | * This script saves a per-browser/per-session cookie used to 15 | * remember the position of the sidebar among the pages. 16 | * Once the browser is closed the cookie is deleted and the position 17 | * reset to the default (expanded). 18 | * 19 | * :copyright: Copyright 2007-2011 by the Sphinx team, see AUTHORS. 20 | * :license: BSD, see LICENSE for details. 21 | * 22 | */ 23 | 24 | $(function() { 25 | // global elements used by the functions. 26 | // the 'sidebarbutton' element is defined as global after its 27 | // creation, in the add_sidebar_button function 28 | var bodywrapper = $('.bodywrapper'); 29 | var sidebar = $('.sphinxsidebar'); 30 | var sidebarwrapper = $('.sphinxsidebarwrapper'); 31 | 32 | // original margin-left of the bodywrapper and width of the sidebar 33 | // with the sidebar expanded 34 | var bw_margin_expanded = bodywrapper.css('margin-left'); 35 | var ssb_width_expanded = sidebar.width(); 36 | 37 | // margin-left of the bodywrapper and width of the sidebar 38 | // with the sidebar collapsed 39 | var bw_margin_collapsed = '.8em'; 40 | var ssb_width_collapsed = '.8em'; 41 | 42 | // colors used by the current theme 43 | var dark_color = $('.related').css('background-color'); 44 | var light_color = $('.document').css('background-color'); 45 | 46 | function sidebar_is_collapsed() { 47 | return sidebarwrapper.is(':not(:visible)'); 48 | } 49 | 50 | function toggle_sidebar() { 51 | if (sidebar_is_collapsed()) 52 | expand_sidebar(); 53 | else 54 | collapse_sidebar(); 55 | } 56 | 57 | function collapse_sidebar() { 58 | sidebarwrapper.hide(); 59 | sidebar.css('width', ssb_width_collapsed); 60 | bodywrapper.css('margin-left', bw_margin_collapsed); 61 | sidebarbutton.css({ 62 | 'margin-left': '0', 63 | 'height': bodywrapper.height() 64 | }); 65 | sidebarbutton.find('span').text('»'); 66 | sidebarbutton.attr('title', _('Expand sidebar')); 67 | document.cookie = 'sidebar=collapsed'; 68 | } 69 | 70 | function expand_sidebar() { 71 | bodywrapper.css('margin-left', bw_margin_expanded); 72 | sidebar.css('width', ssb_width_expanded); 73 | sidebarwrapper.show(); 74 | sidebarbutton.css({ 75 | 'margin-left': ssb_width_expanded-12, 76 | 'height': bodywrapper.height() 77 | }); 78 | sidebarbutton.find('span').text('«'); 79 | sidebarbutton.attr('title', _('Collapse sidebar')); 80 | document.cookie = 'sidebar=expanded'; 81 | } 82 | 83 | function add_sidebar_button() { 84 | sidebarwrapper.css({ 85 | 'float': 'left', 86 | 'margin-right': '0', 87 | 'width': ssb_width_expanded - 28 88 | }); 89 | // create the button 90 | sidebar.append( 91 | '
      «
      ' 92 | ); 93 | var sidebarbutton = $('#sidebarbutton'); 94 | light_color = sidebarbutton.css('background-color'); 95 | // find the height of the viewport to center the '<<' in the page 96 | var viewport_height; 97 | if (window.innerHeight) 98 | viewport_height = window.innerHeight; 99 | else 100 | viewport_height = $(window).height(); 101 | sidebarbutton.find('span').css({ 102 | 'display': 'block', 103 | 'margin-top': (viewport_height - sidebar.position().top - 20) / 2 104 | }); 105 | 106 | sidebarbutton.click(toggle_sidebar); 107 | sidebarbutton.attr('title', _('Collapse sidebar')); 108 | sidebarbutton.css({ 109 | 'color': '#FFFFFF', 110 | 'border-left': '1px solid ' + dark_color, 111 | 'font-size': '1.2em', 112 | 'cursor': 'pointer', 113 | 'height': bodywrapper.height(), 114 | 'padding-top': '1px', 115 | 'margin-left': ssb_width_expanded - 12 116 | }); 117 | 118 | sidebarbutton.hover( 119 | function () { 120 | $(this).css('background-color', dark_color); 121 | }, 122 | function () { 123 | $(this).css('background-color', light_color); 124 | } 125 | ); 126 | } 127 | 128 | function set_position_from_cookie() { 129 | if (!document.cookie) 130 | return; 131 | var items = document.cookie.split(';'); 132 | for(var k=0; k=e.computed&&(e={value:f,computed:g})});return e.value};b.min=function(a,c,d){if(!c&&b.isArray(a))return Math.min.apply(Math,a);var e={computed:Infinity};b.each(a,function(f,g,h){g=c?c.call(d,f,g,h):f;gf?1:0}),"value")};b.sortedIndex=function(a,c,d){d=d||b.identity;for(var e=0,f=a.length;e>1;d(a[g])=0})})};b.zip=function(){for(var a=b.toArray(arguments),c=b.max(b.pluck(a,"length")),d=new Array(c),e=0;e0?f-c:c-f)>=0)return e;e[g++]=f}};b.bind=function(a,c){var d=b.rest(arguments,2);return function(){return a.apply(c||j,d.concat(b.toArray(arguments)))}};b.bindAll=function(a){var c=b.rest(arguments);if(c.length==0)c=b.functions(a);b.each(c,function(d){a[d]=b.bind(a[d],a)}); 10 | return a};b.delay=function(a,c){var d=b.rest(arguments,2);return setTimeout(function(){return a.apply(a,d)},c)};b.defer=function(a){return b.delay.apply(b,[a,1].concat(b.rest(arguments)))};b.wrap=function(a,c){return function(){var d=[a].concat(b.toArray(arguments));return c.apply(c,d)}};b.compose=function(){var a=b.toArray(arguments);return function(){for(var c=b.toArray(arguments),d=a.length-1;d>=0;d--)c=[a[d].apply(this,c)];return c[0]}};b.keys=function(a){if(b.isArray(a))return b.range(0,a.length); 11 | var c=[];for(var d in a)q.call(a,d)&&c.push(d);return c};b.values=function(a){return b.map(a,b.identity)};b.functions=function(a){return b.select(b.keys(a),function(c){return b.isFunction(a[c])}).sort()};b.extend=function(a,c){for(var d in c)a[d]=c[d];return a};b.clone=function(a){if(b.isArray(a))return a.slice(0);return b.extend({},a)};b.tap=function(a,c){c(a);return a};b.isEqual=function(a,c){if(a===c)return true;var d=typeof a;if(d!=typeof c)return false;if(a==c)return true;if(!a&&c||a&&!c)return false; 12 | if(a.isEqual)return a.isEqual(c);if(b.isDate(a)&&b.isDate(c))return a.getTime()===c.getTime();if(b.isNaN(a)&&b.isNaN(c))return true;if(b.isRegExp(a)&&b.isRegExp(c))return a.source===c.source&&a.global===c.global&&a.ignoreCase===c.ignoreCase&&a.multiline===c.multiline;if(d!=="object")return false;if(a.length&&a.length!==c.length)return false;d=b.keys(a);var e=b.keys(c);if(d.length!=e.length)return false;for(var f in a)if(!b.isEqual(a[f],c[f]))return false;return true};b.isEmpty=function(a){return b.keys(a).length== 13 | 0};b.isElement=function(a){return!!(a&&a.nodeType==1)};b.isArray=function(a){return!!(a&&a.concat&&a.unshift)};b.isArguments=function(a){return a&&b.isNumber(a.length)&&!b.isArray(a)&&!r.call(a,"length")};b.isFunction=function(a){return!!(a&&a.constructor&&a.call&&a.apply)};b.isString=function(a){return!!(a===""||a&&a.charCodeAt&&a.substr)};b.isNumber=function(a){return p.call(a)==="[object Number]"};b.isDate=function(a){return!!(a&&a.getTimezoneOffset&&a.setUTCFullYear)};b.isRegExp=function(a){return!!(a&& 14 | a.test&&a.exec&&(a.ignoreCase||a.ignoreCase===false))};b.isNaN=function(a){return b.isNumber(a)&&isNaN(a)};b.isNull=function(a){return a===null};b.isUndefined=function(a){return typeof a=="undefined"};b.noConflict=function(){j._=n;return this};b.identity=function(a){return a};b.breakLoop=function(){throw m;};var s=0;b.uniqueId=function(a){var c=s++;return a?a+c:c};b.template=function(a,c){a=new Function("obj","var p=[],print=function(){p.push.apply(p,arguments);};with(obj){p.push('"+a.replace(/[\r\t\n]/g, 15 | " ").replace(/'(?=[^%]*%>)/g,"\t").split("'").join("\\'").split("\t").join("'").replace(/<%=(.+?)%>/g,"',$1,'").split("<%").join("');").split("%>").join("p.push('")+"');}return p.join('');");return c?a(c):a};b.forEach=b.each;b.foldl=b.inject=b.reduce;b.foldr=b.reduceRight;b.filter=b.select;b.every=b.all;b.some=b.any;b.head=b.first;b.tail=b.rest;b.methods=b.functions;var l=function(a,c){return c?b(a).chain():a};b.each(b.functions(b),function(a){var c=b[a];i.prototype[a]=function(){var d=b.toArray(arguments); 16 | o.call(d,this._wrapped);return l(c.apply(b,d),this._chain)}});b.each(["pop","push","reverse","shift","sort","splice","unshift"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){c.apply(this._wrapped,arguments);return l(this._wrapped,this._chain)}});b.each(["concat","join","slice"],function(a){var c=Array.prototype[a];i.prototype[a]=function(){return l(c.apply(this._wrapped,arguments),this._chain)}});i.prototype.chain=function(){this._chain=true;return this};i.prototype.value=function(){return this._wrapped}})(); 17 | -------------------------------------------------------------------------------- /docs/_build/html/genindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | Index — python-transparencydata v1.0 documentation 11 | 12 | 13 | 22 | 23 | 24 | 25 | 26 | 27 | 28 |
      29 |

      Navigation

      30 |       39 |
      40 | 41 |
      42 |
      43 |
      44 |
      45 | 46 | 47 |

      Index

      48 | 49 |
      50 | B | C | E | F | I | L | M | O | P | R | S | T 51 |
      52 |

      B

      53 | 54 | 57 |
      55 |
      bills() (influenceexplorer.Organization method)
      56 |
      58 | 59 |

      C

      60 | 61 | 66 | 70 |
      62 |
      candidates_by_location() (influenceexplorer.Entities method)
      63 |
      clients() (influenceexplorer.Individual method)
      64 |
      contributor_type_breakdown() (influenceexplorer.Politician method)
      65 |
      67 |
      contributors() (influenceexplorer.Politician method)
      68 |
      count() (influenceexplorer.Entities method)
      69 |
      71 | 72 |

      E

      73 | 74 | 81 | 85 |
      75 |
      earmarks() (influenceexplorer.Organization method)
      76 |
      77 |
      (influenceexplorer.Politician method)
      78 |
      79 |
      earmarks_local_breakdown() (influenceexplorer.Politician method)
      80 |
      82 |
      election_districts() (influenceexplorer.Entities method)
      83 |
      Entities (class in influenceexplorer)
      84 |
      86 | 87 |

      F

      88 | 89 | 92 |
      90 |
      fed_spending() (influenceexplorer.Organization method)
      91 |
      93 | 94 |

      I

      95 | 96 | 102 | 110 |
      97 |
      id_lookup() (influenceexplorer.Entities method)
      98 |
      Individual (class in influenceexplorer)
      99 |
      industries() (influenceexplorer.Politician method)
      100 |
      industry_orgs() (influenceexplorer.Organization method)
      101 |
      103 |
      InfluenceExplorer (class in influenceexplorer)
      104 |
      influenceexplorer (module)
      105 |
      issues() (influenceexplorer.Individual method)
      106 |
      107 |
      (influenceexplorer.Organization method)
      108 |
      109 |
      111 | 112 |

      L

      113 | 114 | 118 | 122 |
      115 |
      level_breakdown() (influenceexplorer.Organization method)
      116 |
      list() (influenceexplorer.Entities method)
      117 |
      119 |
      lobbyists() (influenceexplorer.Organization method)
      120 |
      local_breakdown() (influenceexplorer.Politician method)
      121 |
      123 | 124 |

      M

      125 | 126 | 129 |
      127 |
      metadata() (influenceexplorer.Entities method)
      128 |
      130 | 131 |

      O

      132 | 133 | 136 | 139 |
      134 |
      org_recipients() (influenceexplorer.Individual method)
      135 |
      137 |
      Organization (class in influenceexplorer)
      138 |
      140 | 141 |

      P

      142 | 143 | 150 | 153 |
      144 |
      party_breakdown() (influenceexplorer.Individual method)
      145 |
      146 |
      (influenceexplorer.Organization method)
      147 |
      148 |
      pol_recipients() (influenceexplorer.Individual method)
      149 |
      151 |
      Politician (class in influenceexplorer)
      152 |
      154 | 155 |

      R

      156 | 157 | 162 | 170 |
      158 |
      recipients() (influenceexplorer.Organization method)
      159 |
      registrant_bills() (influenceexplorer.Organization method)
      160 |
      registrant_clients() (influenceexplorer.Organization method)
      161 |
      163 |
      registrant_issues() (influenceexplorer.Organization method)
      164 |
      registrant_lobbyists() (influenceexplorer.Organization method)
      165 |
      registrants() (influenceexplorer.Individual method)
      166 |
      167 |
      (influenceexplorer.Organization method)
      168 |
      169 |
      171 | 172 |

      S

      173 | 174 | 178 | 186 |
      175 |
      search() (influenceexplorer.Entities method)
      176 |
      sectors() (influenceexplorer.Politician method)
      177 |
      179 |
      sparkline() (influenceexplorer.Individual method)
      180 |
      181 |
      (influenceexplorer.Organization method)
      182 |
      (influenceexplorer.Politician method)
      183 |
      184 |
      sparkline_by_party() (influenceexplorer.Organization method)
      185 |
      187 | 188 |

      T

      189 | 190 | 194 | 198 |
      191 |
      top_n_individuals() (influenceexplorer.Entities method)
      192 |
      top_n_industries() (influenceexplorer.Entities method)
      193 |
      195 |
      top_n_organizations() (influenceexplorer.Entities method)
      196 |
      top_n_politicians() (influenceexplorer.Entities method)
      197 |
      199 | 200 | 201 | 202 |
      203 |
      204 |
      205 |
      206 |
      207 | 208 | 209 | 210 | 222 | 223 |
      224 |
      225 |
      226 |
      227 |
      228 |

      Navigation

      229 | 238 |
      239 |
      240 | © Copyright 2011, Sunlight Foundation. 241 | Created using Sphinx 1.0.7. 242 |
      243 | 244 | -------------------------------------------------------------------------------- /docs/_build/html/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | python-transparencydata’s documentation — python-transparencydata v1.0 documentation 11 | 12 | 13 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |
      30 |

      Navigation

      31 | 43 |
      44 | 45 |
      46 |
      47 |
      48 |
      49 | 50 |
      51 |

      python-transparencydata’s documentation

      52 |

      Python API wrappers for TransparencyData.com and InfluenceExplorer.com data. 53 | Both APIs provide a variety of political influence data. 54 | Influence Explorer provides easy to use summary information for politicians, 55 | organizations, industries and prominent individuals. 56 | Transparency Data provides extensive search capabilities over raw transactional 57 | records. It is useful for retrieving data sets for your own analysis.

      58 |

      Both sites currently include data on campaign finance (federal- and 59 | state-level), federal lobbying, earmarks, and federal grants and contracts. 60 | More data sets will be added over time.

      61 |
      62 | 81 |
      82 |
      83 |
      84 |

      Indices and tables

      85 | 90 |
      91 | 92 | 93 |
      94 |
      95 |
      96 |
      97 |
      98 |

      Table Of Contents

      99 | 105 | 106 |

      Next topic

      107 |

      Transparency Data API

      109 |

      This Page

      110 | 114 | 126 | 127 |
      128 |
      129 |
      130 |
      131 |
      132 |

      Navigation

      133 | 145 |
      146 |
      147 | © Copyright 2011, Sunlight Foundation. 148 | Created using Sphinx 1.0.7. 149 |
      150 | 151 | -------------------------------------------------------------------------------- /docs/_build/html/influenceexplorer.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | Influence Explorer API — python-transparencydata v1.0 documentation 11 | 12 | 13 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 |
      30 |

      Navigation

      31 | 43 |
      44 | 45 |
      46 |
      47 |
      48 |
      49 | 50 |
      51 |

      Influence Explorer API

      52 |

      The influenceexplorer module provides API wrappers for the data provided on 53 | InfluenceExplorer.com.

      54 |
      55 |
      56 | class influenceexplorer.InfluenceExplorer(api_key, base_url='http://transparencydata.com/api/1.0/')[source]
      57 |

      Provides wrappers to the Influence Explorer APIs.

      58 |

      Methods are divided into four categories. Entity methods can be accessed 59 | through the entities member, Politician methods through pol, Individual 60 | methods through indiv and Organization through org. For example:

      61 | 
      api = InfluenceExplorer(<your-key-here>)
 62 | boehner_id = api.entities.search('john boehner')[1]['id]
 63 | print api.pol.industries(boehner_id)
      64 |
      65 |
      66 | 67 |
      68 |

      General Entity Methods

      69 |
      70 |
      71 | class influenceexplorer.Entities[source]
      72 |

      Methods related to searching, listing and ranking entities.

      73 |

      Accessed as InfluenceExplorer.entities.

      74 |
      75 |
      76 | candidates_by_location(location, cycle='-1')[source]
      77 |

      Internal use only. Not maintained.

      78 |
      79 | 80 |
      81 |
      82 | count(type=None)[source]
      83 |

      Return the total count of entities.

      84 |
      85 | 86 |
      87 |
      88 | election_districts(cycle='-1')[source]
      89 |

      Internal use only. Not maintained.

      90 |
      91 | 92 |
      93 |
      94 | id_lookup(namespace, id)[source]
      95 |

      Return the Influence Explorer entity ID based on a 3rd party ID.

      96 |

      Valid namespaces include:

      97 |
        98 |
      • urn:crp:individual – CRP’s contributor or lobbyist ID
        • 99 |
      • urn:crp:organization – CRP’s organization ID
        • 100 |
      • urn:crp:recipient – CRP’s candidate ID
        • 101 |
      • urn:crp:industry – CRP’s 3-letter category order
        • 102 |
      • urn:crp:subindustry – CRP’s 5-letter category code
        • 103 |
      • urn:nimsp:subindustry – 5-letter category code added by NIMSP
        • 104 |
      • urn:nimsp:organization – NIMSP’s organization ID
        • 105 |
      • urn:nimsp:recipient – NIMSP’s candidate ID
        • 106 |
      • urn:sunlight:lobbyist_registration_tracker_url – URL of Sunlight’s lobbyist registration tracker page
        • 107 |
      108 |
      109 | 110 |
      111 |
      112 | list(start, end, type=None)[source]
      113 |

      List all entities.

      114 |
      115 | 116 |
      117 |
      118 | metadata(entity_id)[source]
      119 |

      Return all available metadata for the given entity.

      120 |
      121 | 122 |
      123 |
      124 | search(query)[source]
      125 |

      Return entities with names matching the given query.

      126 |

      Query terms are space separated. Matches must contain all terms 127 | from the query.

      128 |
      129 | 130 |
      131 |
      132 | top_n_individuals(cycle='-1', limit=None)[source]
      133 |

      Return the top individuals, by amount contributed.

      134 |
      135 | 136 |
      137 |
      138 | top_n_industries(cycle='-1', limit=None)[source]
      139 |

      Return the top industries, by amount contributed.

      140 |
      141 | 142 |
      143 |
      144 | top_n_organizations(cycle='-1', limit=None)[source]
      145 |

      Return the top organizations, by amount contributed.

      146 |
      147 | 148 |
      149 |
      150 | top_n_politicians(cycle='-1', limit=None)[source]
      151 |

      Return the top politicians, by amount received.

      152 |
      153 | 154 |
      155 | 156 |
      157 |
      158 |

      Politician Methods

      159 |
      160 |
      161 | class influenceexplorer.Politician[source]
      162 |

      Methods relating to a politician entity.

      163 |

      Accessed as InfluenceExplorer.pol.

      164 |
      165 |
      166 | contributor_type_breakdown(entity_id, cycle='-1')[source]
      167 |

      Return the breakdown of individual vs. organization contributions.

      168 |
      169 | 170 |
      171 |
      172 | contributors(entity_id, cycle='-1', limit=None)[source]
      173 |

      Return the top organizational contributors.

      174 |
      175 | 176 |
      177 |
      178 | earmarks(entity_id, cycle='-1', limit=None)[source]
      179 |

      Return top earmarks requested by this politician.

      180 |
      181 | 182 |
      183 |
      184 | earmarks_local_breakdown(entity_id, cycle='-1')[source]
      185 |

      Return breakdown of earmark amount for in-state vs. out-of-state projects.

      186 |
      187 | 188 |
      189 |
      190 | industries(entity_id, cycle='-1', limit=None)[source]
      191 |

      Return the top contributing industries.

      192 |
      193 | 194 |
      195 |
      196 | local_breakdown(entity_id, cycle='-1')[source]
      197 |

      Return the breakdown of in-state vs. out-of-state contributions.

      198 |
      199 | 200 |
      201 |
      202 | sectors(entity_id, cycle='-1', limit=None)[source]
      203 |

      Not maintained.

      204 |
      205 | 206 |
      207 |
      208 | sparkline(entity_id, cycle='-1')[source]
      209 |

      Return sparkline data for contributions received.

      210 |
      211 | 212 |
      213 | 214 |
      215 |
      216 |

      Organization Methods

      217 |
      218 |
      219 | class influenceexplorer.Organization[source]
      220 |

      Methods related to organization or industry entities.

      221 |

      Accessed as InfluenceExplorer.org.

      222 |
      223 |
      224 | bills(entity_id, cycle='-1', limit=None)[source]
      225 |

      Return bills lobbied on.

      226 |

      Only return data if organization is a client of lobbying firms.

      227 |
      228 | 229 |
      230 |
      231 | earmarks(entity_id, cycle='-1', limit=None)[source]
      232 |

      Return top earmarks received by organization.

      233 |
      234 | 235 |
      236 |
      237 | fed_spending(entity_id, cycle='-1', limit=None)[source]
      238 |

      Return top federal grants and contracts received.

      239 |

      Matching is based on full-text search and may include incorrect matches 240 | or miss records. Not appropriate for automatic aggregation.

      241 |
      242 | 243 |
      244 |
      245 | industry_orgs(entity_id, cycle='-1', limit=None)[source]
      246 |

      Return top organizations within this industry.

      247 |

      Only return data if entity is an industry.

      248 |
      249 | 250 |
      251 |
      252 | issues(entity_id, cycle='-1', limit=None)[source]
      253 |

      Return issues lobbied on.

      254 |

      Only return data if organization is a client of lobbying firms.

      255 |
      256 | 257 |
      258 |
      259 | level_breakdown(entity_id, cycle='-1')[source]
      260 |

      Return breakdown of amount contributed to state vs. federal races.

      261 |
      262 | 263 |
      264 |
      265 | lobbyists(entity_id, cycle='-1', limit=None)[source]
      266 |

      Return lobbyists hired.

      267 |

      Only return data if organization is a client of lobbying firms.

      268 |
      269 | 270 |
      271 |
      272 | party_breakdown(entity_id, cycle='-1')[source]
      273 |

      Return breakdown of amount contributed to each party.

      274 |
      275 | 276 |
      277 |
      278 | recipients(entity_id, cycle='-1', limit=None)[source]
      279 |

      Return top politicians receiving contributions.

      280 |
      281 | 282 |
      283 |
      284 | registrant_bills(entity_id, cycle='-1', limit=None)[source]
      285 |

      Return bill this organization lobbied on.

      286 |

      Only return data if organization is a lobbying firm.

      287 |
      288 | 289 |
      290 |
      291 | registrant_clients(entity_id, cycle='-1', limit=None)[source]
      292 |

      Return clients that hired this organization to lobby.

      293 |

      Only return data if organization is a lobbying firm.

      294 |
      295 | 296 |
      297 |
      298 | registrant_issues(entity_id, cycle='-1', limit=None)[source]
      299 |

      Return issues this organization lobbied on.

      300 |

      Only return data if organization is a lobbying firm.

      301 |
      302 | 303 |
      304 |
      305 | registrant_lobbyists(entity_id, cycle='-1', limit=None)[source]
      306 |

      Return lobbyists employed.

      307 |

      Only return data if organization is a lobbying firm.

      308 |
      309 | 310 |
      311 |
      312 | registrants(entity_id, cycle='-1', limit=None)[source]
      313 |

      Return lobbying firms hired.

      314 |

      Only return data if organization is a client of lobbying firms.

      315 |
      316 | 317 |
      318 |
      319 | sparkline(entity_id, cycle='-1')[source]
      320 |

      Return sparkline data for contributions.

      321 |
      322 | 323 |
      324 |
      325 | sparkline_by_party(entity_id, cycle='-1')[source]
      326 |

      Return sparkline data for contributions, broken down by recipient party.

      327 |
      328 | 329 |
      330 | 331 |
      332 |
      333 |

      Individual Methods

      334 |
      335 |
      336 | class influenceexplorer.Individual[source]
      337 |

      Methods relating to individual entities.

      338 |

      Accessed as InfluenceExplorer.indiv.

      339 |
      340 |
      341 | clients(entity_id, cycle='-1', limit=None)[source]
      342 |

      Return the clients the individual was contracted to work for.

      343 |

      Only return data for individuals that are registered lobbyists.

      344 |
      345 | 346 |
      347 |
      348 | issues(entity_id, cycle='-1', limit=None)[source]
      349 |

      Return the top issues the individual lobbied on.

      350 |

      Only return data for individuals that are registered lobbyists.

      351 |
      352 | 353 |
      354 |
      355 | org_recipients(entity_id, cycle='-1', limit=None)[source]
      356 |

      Return the top organizations receiving contributions.

      357 |
      358 | 359 |
      360 |
      361 | party_breakdown(entity_id, cycle='-1')[source]
      362 |

      Return breakdown of amount contributed to each party.

      363 |
      364 | 365 |
      366 |
      367 | pol_recipients(entity_id, cycle='-1', limit=None)[source]
      368 |

      Return the top politicians receiving contributions.

      369 |
      370 | 371 |
      372 |
      373 | registrants(entity_id, cycle='-1', limit=None)[source]
      374 |

      Return the lobbying firms that employed the individual.

      375 |

      Only return data for individuals that are registered lobbyists.

      376 |
      377 | 378 |
      379 |
      380 | sparkline(entity_id, cycle='-1')[source]
      381 |

      Return sparkline data for contributions.

      382 |
      383 | 384 |
      385 | 386 |
      387 |
      388 | 389 | 390 |
      391 |
      392 |
      393 |
      394 |
      395 |

      Table Of Contents

      396 | 405 | 406 |

      Previous topic

      407 |

      Transparency Data API

      409 |

      This Page

      410 | 414 | 426 | 427 |
      428 |
      429 |
      430 |
      431 |
      432 |

      Navigation

      433 | 445 |
      446 |
      447 | © Copyright 2011, Sunlight Foundation. 448 | Created using Sphinx 1.0.7. 449 |
      450 | 451 | -------------------------------------------------------------------------------- /docs/_build/html/objects.inv: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/sunlightlabs/python-transparencydata/f843f7c54b4aa742f55f6a8ea5b4f7f12788c9f8/docs/_build/html/objects.inv -------------------------------------------------------------------------------- /docs/_build/html/py-modindex.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | Python Module Index — python-transparencydata v1.0 documentation 11 | 12 | 13 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 31 | 32 | 33 | 34 | 35 |
      36 |

      Navigation

      37 | 46 |
      47 | 48 |
      49 |
      50 |
      51 |
      52 | 53 | 54 |

      Python Module Index

      55 | 56 |
      57 | i 58 |
      59 | 60 | 61 | 62 | 64 | 65 | 66 | 69 |
       
      63 | i
      67 | influenceexplorer 68 |
      70 | 71 | 72 |
      73 |
      74 |
      75 |
      76 |
      77 | 89 | 90 |
      91 |
      92 |
      93 |
      94 |
      95 |

      Navigation

      96 | 105 |
      106 |
      107 | © Copyright 2011, Sunlight Foundation. 108 | Created using Sphinx 1.0.7. 109 |
      110 | 111 | -------------------------------------------------------------------------------- /docs/_build/html/search.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | Search — python-transparencydata v1.0 documentation 11 | 12 | 13 | 22 | 23 | 24 | 25 | 26 | 27 | 30 | 31 | 32 | 33 | 34 |
      35 |

      Navigation

      36 | 45 |
      46 | 47 |
      48 |
      49 |
      50 |
      51 | 52 |

      Search

      53 |
      54 | 55 |

      56 | Please activate JavaScript to enable the search 57 | functionality. 58 |

      59 |
      60 |

      61 | From here you can search these documents. Enter your search 62 | words into the box below and click "search". Note that the search 63 | function will automatically search for all of the words. Pages 64 | containing fewer words won't appear in the result list. 65 |

      66 |
      67 | 68 | 69 | 70 |
      71 | 72 |
      73 | 74 |
      75 | 76 |
      77 |
      78 |
      79 |
      80 |
      81 |
      82 |
      83 |
      84 |
      85 |
      86 |

      Navigation

      87 | 96 |
      97 |
      98 | © Copyright 2011, Sunlight Foundation. 99 | Created using Sphinx 1.0.7. 100 |
      101 | 102 | -------------------------------------------------------------------------------- /docs/_build/html/searchindex.js: -------------------------------------------------------------------------------- 1 | Search.setIndex({objects:{"":{influenceexplorer:[2,0,1]},influenceexplorer:{Entities:[2,2,1],InfluenceExplorer:[2,2,1],Individual:[2,2,1],Politician:[2,2,1],Organization:[2,2,1]},"influenceexplorer.Entities":{count:[2,1,1],id_lookup:[2,1,1],search:[2,1,1],election_districts:[2,1,1],top_n_organizations:[2,1,1],list:[2,1,1],top_n_individuals:[2,1,1],top_n_industries:[2,1,1],top_n_politicians:[2,1,1],candidates_by_location:[2,1,1],metadata:[2,1,1]},"influenceexplorer.Organization":{registrant_bills:[2,1,1],recipients:[2,1,1],industry_orgs:[2,1,1],sparkline:[2,1,1],level_breakdown:[2,1,1],registrant_lobbyists:[2,1,1],earmarks:[2,1,1],sparkline_by_party:[2,1,1],lobbyists:[2,1,1],registrant_issues:[2,1,1],fed_spending:[2,1,1],bills:[2,1,1],registrant_clients:[2,1,1],registrants:[2,1,1],issues:[2,1,1],party_breakdown:[2,1,1]},"influenceexplorer.Individual":{clients:[2,1,1],sparkline:[2,1,1],org_recipients:[2,1,1],pol_recipients:[2,1,1],registrants:[2,1,1],issues:[2,1,1],party_breakdown:[2,1,1]},"influenceexplorer.Politician":{industries:[2,1,1],local_breakdown:[2,1,1],contributors:[2,1,1],sectors:[2,1,1],sparkline:[2,1,1],contributor_type_breakdown:[2,1,1],earmarks_local_breakdown:[2,1,1],earmarks:[2,1,1]}},terms:{recipi:2,sector:2,all:[2,1],code:2,election_district:2,nimsp:2,queri:2,over:0,dollar:1,rang:1,four:2,through:2,sunlightlab:1,registrant_issu:2,find:1,entiti:[0,2],categori:2,onli:2,locat:2,easi:0,transact:0,api_kei:2,base_url:2,bank:1,text:2,contributor_st:1,subindustri:2,match:[2,1],emploi:2,sourc:2,"return":2,contribut:[0,1,2],transpar:[0,1],python:0,promin:0,financ:0,term:2,initi:1,nation:1,pol_recipi:2,lesser:1,candid:2,automat:2,retriev:0,date__between:1,requir:[],receiv:2,crp:2,name:[2,1],organ:[0,2],level:0,transparencydata:[0,1,2],list:[2,1],separ:2,boehner:2,race:2,each:[2,1],found:[],party_breakdown:2,page:[0,2],summari:0,lobbyist_registration_tracker_url:2,set:0,art:1,hollen:1,individu:[0,2],some:1,direct:1,intern:2,aggreg:2,pass:1,org_recipi:2,happen:[],append:1,out:[2,1],cycle__in:1,index:0,what:[],sunlight:2,feder:[0,1,2],"3rd":2,space:2,influenc:[0,2],influenceexplor:[0,2],nea:1,content:[],state:[0,1,2],tracker:2,between:1,print:[2,1],"import":1,paramet:[0,1],method:[0,1,2],metadata:2,local_breakdown:2,full:2,kei:[2,1],sparklin:2,usag:[0,1],gener:[0,2],agency_ft:1,lobbyist:2,main_api:[],extens:0,base:2,here:2,org:2,valu:1,both:0,search:[0,2],sparkline_by_parti:2,broken:2,similar:1,current:0,level_breakdown:2,contract:[0,1,2],fed_spend:2,amount:[2,1],orm:1,industri:[0,2],com:[0,1,2],organiz:2,end_dat:1,boehner_id:2,oper:[0,1],entity_id:2,own:0,elect:1,campaign:[0,1],regist:[2,1],modul:[0,2],within:2,fiscal_year:1,rank:2,top_n_organ:2,down:2,pol:2,top_n_politician:2,seattl:1,contributor:2,total:2,miss:2,your:[0,1,2],given:2,van:1,start:2,top:2,doubl:1,contributor_type_breakdown:2,two:1,construct:1,avail:2,citi:1,includ:[0,2],django:1,john:[2,1],type:2,top_n_industri:2,more:0,firm:2,from:[2,1],wrapper:[0,2],recipient_ft:1,tupl:1,relat:2,lobbyist_ft:1,earmarks_local_breakdown:2,start_dat:1,industry_org:2,top_n_individu:2,than:1,must:[2,1],count:2,id_lookup:2,none:2,made:1,politician:[0,2],contain:2,provid:[0,2],servic:1,bill:2,see:1,exampl:2,project:2,defin:[],limit:2,can:[2,1],visit:1,toward:1,endow:1,greater:1,analysi:0,have:1,wonderlich:1,dure:1,registr:2,site:0,indic:0,equal:1,raw:0,mthod:[],explor:[0,2],tabl:0,work:2,hire:2,string:[],candidates_by_loc:2,indiv:2,end:[2,1],welcom:[],grant:[0,1,2],programmat:1,titl:[],conduct:1,access:[2,1],client:2,member:2,namespac:2,valid:[2,1],respons:1,which:1,varieti:0,record:[0,2],you:1,document:[0,1],chri:1,polit:0,breakdown:2,incorrect:2,http:[2,1],allow:1,api:[0,1,2],less:1,time:0,lobbi:[0,1,2],cycl:[2,1],vendor_nam:1,capabl:0,specifi:1,letter:2,mai:2,multipl:1,underscor:1,america:1,data:[0,1,2],"class":[2,1],registrant_bil:2,appropri:2,earmark:[0,1,2],ani:1,registrant_cli:2,url:2,doc:1,urn:2,divid:2,request:2,registrant_lobbyist:2,issu:[2,1],inform:0,maintain:2,amount__lt:1,thi:2,parti:2,order:2},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},titles:["python-transparencydata’s documentation","Transparency Data API","Influence Explorer API"],objnames:{"0":"Python module","1":"Python method","2":"Python class"},filenames:["index","transparencydata","influenceexplorer"]}) -------------------------------------------------------------------------------- /docs/_build/html/transparencydata.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 5 | 6 | 7 | 8 | 9 | 10 | Transparency Data API — python-transparencydata v1.0 documentation 11 | 12 | 13 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 |
      31 |

      Navigation

      32 | 47 |
      48 | 49 |
      50 |
      51 |
      52 |
      53 | 54 |
      55 |

      Transparency Data API

      56 |
      57 |

      Usage

      58 |

      The TransparencyData class is constructed with your API key as an initialization parameter:

      59 | 
      >>> from transparencydata import TransparencyData
 60 | >>> td = TransparencyData(<your-api-key>)
 61 |
      62 |
      63 |

      If you do not have an API key visit http://services.sunlightlabs.com/api/ to 64 | register for one.

      65 |
      66 |
      67 |

      Parameter Operators

      68 |

      Some parameters allow multiple values or greater than, less than, or between operations. We allow operators to be added similar to the method used by the Django ORM. The operator is appended to the end of the parameter name using double underscore.

      69 | 
      >>> td.contributions(amount=100)                        # contributions equal to 100 dollars
 70 | >>> td.contributions(amount__lt=100)            # contributions less than 100 dollars
 71 |
      72 |
      73 | 
      >>> td.contributions(cycle=1990)                        # contributions from the 1990 election cycle
 74 | >>> td.contributions(cycle__in=(1990,2008)) # contributions from the 1990 and 2008 election cycles
 75 |
      76 |
      77 |
      78 |
      gt
      79 |
      Greater than specified value.
      80 |
      lt
      81 |
      Less than specified value.
      82 |
      between
      83 |

      Between the lesser value and greater value. Parameters must be passed as a two-value tuple or list.

      84 | 
      >>> td.contributions(date__between=(start_date, end_date))
 85 |
      86 |
      87 |
      88 |
      in
      89 |
      Matches any in a range of values. Parameter must be a tuple or list.
      90 |
      91 |

      See the parameter documentation (http://transparencydata.com/api/) to find out which operators are valid for each parameter.

      92 |
      93 |
      94 |

      Campaign Contributions

      95 |

      To find all contributions to Chris Van Hollen from the state of CA during the 2008 election cycle:

      96 | 
      >>> td.contributions(cycle=2008, contributor_state='CA', recipient_ft='van hollen')
 97 |
      98 |
      99 |

      A list of valid contributions parameters can be accessed programmatically:

      100 | 
      >>> print td.contributions.parameters
101 |
      102 |
      103 |

      Parameter documentation: http://transparencydata.com/api/contributions

      104 |

      Response documentation: http://transparencydata.com/docs/contributions

      105 |
      106 |
      107 |

      Lobbying

      108 |

      To find all lobbying conducted by John Wonderlich:

      109 | 
      >>> td.lobbying(lobbyist_ft='john wonderlich')
110 |
      111 |
      112 |

      A list of valid lobbying parameters can be accessed programmatically:

      113 | 
      >>> print td.lobbying.parameters
114 |
      115 |
      116 |

      Parameter documentation: http://transparencydata.com/api/lobbying

      117 |

      Response documentation: http://transparencydata.com/docs/lobbying

      118 |
      119 |
      120 |

      Earmarks

      121 |

      To find all earmarks directed towards Seattle, WA:

      122 | 
      >>> td.earmarks(city='Seattle', state='WA')
123 |
      124 |
      125 |

      A list of valid earmark parameters can be accessed programmatically:

      126 | 
      >>> print td.earmarks.parameters
127 |
      128 |
      129 |

      Parameter documentation: http://transparencydata.com/api/earmarks

      130 |

      Response documentation: http://transparencydata.com/docs/earmarks

      131 |
      132 |
      133 |

      Federal Grants

      134 |

      To find all grants made by the NEA in 2010:

      135 | 
      >>> td.grants(agency_ft='national endowment for the arts', fiscal_year='2010')
136 |
      137 |
      138 |

      A list of valid grant parameters can be accessed programmatically:

      139 | 
      >>> td.grants.parameters
140 |
      141 |
      142 |

      Parameter documentation: http://transparencydata.com/api/grants/

      143 |

      Response documentation: http://transparencydata.com/docs/grants/

      144 |
      145 |
      146 |

      Federal Contracts

      147 |

      To find all federal contracts issued to Bank of America:

      148 | 
      >>> td.contracts(vendor_name='bank of america')
149 |
      150 |
      151 |

      A list of valid contract parameters can be accessed programmatically:

      152 | 
      >>> td.contracts.parameters
153 |
      154 |
      155 |

      Parameter documentation: http://transparencydata.com/api/contracts

      156 |

      Response documentation: http://transparencydata.com/docs/contracts

      157 |
      158 |
      159 | 160 | 161 |
      162 |
      163 |
      164 |
      165 |
      166 |

      Table Of Contents

      167 | 179 | 180 |

      Previous topic

      181 |

      python-transparencydata’s documentation

      183 |

      Next topic

      184 |

      Influence Explorer API

      186 |

      This Page

      187 | 191 | 203 | 204 |
      205 |
      206 |
      207 |
      208 |
      209 |

      Navigation

      210 | 225 |
      226 |
      227 | © Copyright 2011, Sunlight Foundation. 228 | Created using Sphinx 1.0.7. 229 |
      230 | 231 | -------------------------------------------------------------------------------- /docs/conf.py: -------------------------------------------------------------------------------- 1 | # -*- coding: utf-8 -*- 2 | # 3 | # python-transparencydata documentation build configuration file, created by 4 | # sphinx-quickstart on Fri Mar 18 11:16:10 2011. 5 | # 6 | # This file is execfile()d with the current directory set to its containing dir. 7 | # 8 | # Note that not all possible configuration values are present in this 9 | # autogenerated file. 10 | # 11 | # All configuration values have a default; values that are commented out 12 | # serve to show the default. 13 | 14 | import sys, os 15 | 16 | # If extensions (or modules to document with autodoc) are in another directory, 17 | # add these directories to sys.path here. If the directory is relative to the 18 | # documentation root, use os.path.abspath to make it absolute, like shown here. 19 | #sys.path.insert(0, os.path.abspath('.')) 20 | 21 | # -- General configuration ----------------------------------------------------- 22 | 23 | # If your documentation needs a minimal Sphinx version, state it here. 24 | #needs_sphinx = '1.0' 25 | 26 | # Add any Sphinx extension module names here, as strings. They can be extensions 27 | # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. 28 | extensions = ['sphinx.ext.autodoc', 'sphinx.ext.intersphinx', 'sphinx.ext.todo', 'sphinx.ext.coverage', 'sphinx.ext.viewcode'] 29 | 30 | # Add any paths that contain templates here, relative to this directory. 31 | templates_path = ['_templates'] 32 | 33 | # The suffix of source filenames. 34 | source_suffix = '.rst' 35 | 36 | # The encoding of source files. 37 | #source_encoding = 'utf-8-sig' 38 | 39 | # The master toctree document. 40 | master_doc = 'index' 41 | 42 | # General information about the project. 43 | project = u'python-transparencydata' 44 | copyright = u'2011, Sunlight Foundation' 45 | 46 | # The version info for the project you're documenting, acts as replacement for 47 | # |version| and |release|, also used in various other places throughout the 48 | # built documents. 49 | # 50 | # The short X.Y version. 51 | version = '1.0' 52 | # The full version, including alpha/beta/rc tags. 53 | release = '1.0' 54 | 55 | # The language for content autogenerated by Sphinx. Refer to documentation 56 | # for a list of supported languages. 57 | #language = None 58 | 59 | # There are two options for replacing |today|: either, you set today to some 60 | # non-false value, then it is used: 61 | #today = '' 62 | # Else, today_fmt is used as the format for a strftime call. 63 | #today_fmt = '%B %d, %Y' 64 | 65 | # List of patterns, relative to source directory, that match files and 66 | # directories to ignore when looking for source files. 67 | exclude_patterns = ['_build'] 68 | 69 | # The reST default role (used for this markup: `text`) to use for all documents. 70 | #default_role = None 71 | 72 | # If true, '()' will be appended to :func: etc. cross-reference text. 73 | #add_function_parentheses = True 74 | 75 | # If true, the current module name will be prepended to all description 76 | # unit titles (such as .. function::). 77 | #add_module_names = True 78 | 79 | # If true, sectionauthor and moduleauthor directives will be shown in the 80 | # output. They are ignored by default. 81 | #show_authors = False 82 | 83 | # The name of the Pygments (syntax highlighting) style to use. 84 | pygments_style = 'sphinx' 85 | 86 | # A list of ignored prefixes for module index sorting. 87 | #modindex_common_prefix = [] 88 | 89 | 90 | # -- Options for HTML output --------------------------------------------------- 91 | 92 | # The theme to use for HTML and HTML Help pages. See the documentation for 93 | # a list of builtin themes. 94 | html_theme = 'default' 95 | 96 | # Theme options are theme-specific and customize the look and feel of a theme 97 | # further. For a list of options available for each theme, see the 98 | # documentation. 99 | #html_theme_options = {} 100 | 101 | # Add any paths that contain custom themes here, relative to this directory. 102 | #html_theme_path = [] 103 | 104 | # The name for this set of Sphinx documents. If None, it defaults to 105 | # " v documentation". 106 | #html_title = None 107 | 108 | # A shorter title for the navigation bar. Default is the same as html_title. 109 | #html_short_title = None 110 | 111 | # The name of an image file (relative to this directory) to place at the top 112 | # of the sidebar. 113 | #html_logo = None 114 | 115 | # The name of an image file (within the static path) to use as favicon of the 116 | # docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 117 | # pixels large. 118 | #html_favicon = None 119 | 120 | # Add any paths that contain custom static files (such as style sheets) here, 121 | # relative to this directory. They are copied after the builtin static files, 122 | # so a file named "default.css" will overwrite the builtin "default.css". 123 | html_static_path = ['_static'] 124 | 125 | # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, 126 | # using the given strftime format. 127 | #html_last_updated_fmt = '%b %d, %Y' 128 | 129 | # If true, SmartyPants will be used to convert quotes and dashes to 130 | # typographically correct entities. 131 | #html_use_smartypants = True 132 | 133 | # Custom sidebar templates, maps document names to template names. 134 | #html_sidebars = {} 135 | 136 | # Additional templates that should be rendered to pages, maps page names to 137 | # template names. 138 | #html_additional_pages = {} 139 | 140 | # If false, no module index is generated. 141 | #html_domain_indices = True 142 | 143 | # If false, no index is generated. 144 | #html_use_index = True 145 | 146 | # If true, the index is split into individual pages for each letter. 147 | #html_split_index = False 148 | 149 | # If true, links to the reST sources are added to the pages. 150 | #html_show_sourcelink = True 151 | 152 | # If true, "Created using Sphinx" is shown in the HTML footer. Default is True. 153 | #html_show_sphinx = True 154 | 155 | # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. 156 | #html_show_copyright = True 157 | 158 | # If true, an OpenSearch description file will be output, and all pages will 159 | # contain a tag referring to it. The value of this option must be the 160 | # base URL from which the finished HTML is served. 161 | #html_use_opensearch = '' 162 | 163 | # This is the file name suffix for HTML files (e.g. ".xhtml"). 164 | #html_file_suffix = None 165 | 166 | # Output file base name for HTML help builder. 167 | htmlhelp_basename = 'python-transparencydatadoc' 168 | 169 | 170 | # -- Options for LaTeX output -------------------------------------------------- 171 | 172 | # The paper size ('letter' or 'a4'). 173 | #latex_paper_size = 'letter' 174 | 175 | # The font size ('10pt', '11pt' or '12pt'). 176 | #latex_font_size = '10pt' 177 | 178 | # Grouping the document tree into LaTeX files. List of tuples 179 | # (source start file, target name, title, author, documentclass [howto/manual]). 180 | latex_documents = [ 181 | ('index', 'python-transparencydata.tex', u'python-transparencydata Documentation', 182 | u'Ethan Phelps-Goodman', 'manual'), 183 | ] 184 | 185 | # The name of an image file (relative to this directory) to place at the top of 186 | # the title page. 187 | #latex_logo = None 188 | 189 | # For "manual" documents, if this is true, then toplevel headings are parts, 190 | # not chapters. 191 | #latex_use_parts = False 192 | 193 | # If true, show page references after internal links. 194 | #latex_show_pagerefs = False 195 | 196 | # If true, show URL addresses after external links. 197 | #latex_show_urls = False 198 | 199 | # Additional stuff for the LaTeX preamble. 200 | #latex_preamble = '' 201 | 202 | # Documents to append as an appendix to all manuals. 203 | #latex_appendices = [] 204 | 205 | # If false, no module index is generated. 206 | #latex_domain_indices = True 207 | 208 | 209 | # -- Options for manual page output -------------------------------------------- 210 | 211 | # One entry per manual page. List of tuples 212 | # (source start file, name, description, authors, manual section). 213 | man_pages = [ 214 | ('index', 'python-transparencydata', u'python-transparencydata Documentation', 215 | [u'Ethan Phelps-Goodman'], 1) 216 | ] 217 | 218 | 219 | # Example configuration for intersphinx: refer to the Python standard library. 220 | intersphinx_mapping = {'http://docs.python.org/': None} 221 | -------------------------------------------------------------------------------- /docs/index.rst: -------------------------------------------------------------------------------- 1 | .. python-transparencydata documentation master file, created by 2 | sphinx-quickstart on Fri Mar 18 11:16:10 2011. 3 | You can adapt this file completely to your liking, but it should at least 4 | contain the root `toctree` directive. 5 | 6 | python-transparencydata's documentation 7 | ======================================= 8 | 9 | Python API wrappers for TransparencyData.com and InfluenceExplorer.com data. 10 | Both APIs provide a variety of political influence data. 11 | Influence Explorer provides easy to use summary information for politicians, 12 | organizations, industries and prominent individuals. 13 | Transparency Data provides extensive search capabilities over raw transactional 14 | records. It is useful for retrieving data sets for your own analysis. 15 | 16 | Both sites currently include data on campaign finance (federal- and 17 | state-level), federal lobbying, earmarks, and federal grants and contracts. 18 | More data sets will be added over time. 19 | 20 | .. toctree:: 21 | :maxdepth: 2 22 | 23 | transparencydata 24 | influenceexplorer 25 | 26 | 27 | Indices and tables 28 | ================== 29 | 30 | * :ref:`genindex` 31 | * :ref:`modindex` 32 | * :ref:`search` 33 | 34 | -------------------------------------------------------------------------------- /docs/influenceexplorer.rst: -------------------------------------------------------------------------------- 1 | Influence Explorer API 2 | ====================== 3 | 4 | 5 | .. automodule:: influenceexplorer 6 | 7 | .. autoclass:: influenceexplorer.InfluenceExplorer 8 | 9 | ---------------------- 10 | General Entity Methods 11 | ---------------------- 12 | 13 | .. autoclass:: influenceexplorer.Entities() 14 | :members: 15 | 16 | ------------------ 17 | Politician Methods 18 | ------------------ 19 | 20 | .. autoclass:: influenceexplorer.Politician() 21 | :members: 22 | 23 | -------------------- 24 | Organization Methods 25 | -------------------- 26 | 27 | .. autoclass:: influenceexplorer.Organization() 28 | :members: 29 | 30 | ------------------ 31 | Individual Methods 32 | ------------------ 33 | 34 | .. autoclass:: influenceexplorer.Individual() 35 | :members: -------------------------------------------------------------------------------- /docs/transparencydata.rst: -------------------------------------------------------------------------------- 1 | Transparency Data API 2 | ===================== 3 | 4 | ----- 5 | Usage 6 | ----- 7 | 8 | The TransparencyData class is constructed with your API key as an initialization parameter: 9 | 10 | >>> from transparencydata import TransparencyData 11 | >>> td = TransparencyData() 12 | 13 | If you do not have an API key visit http://services.sunlightlabs.com/api/ to 14 | register for one. 15 | 16 | ------------------- 17 | Parameter Operators 18 | ------------------- 19 | 20 | Some parameters allow multiple values or greater than, less than, or between operations. We allow operators to be added similar to the method used by the Django ORM. The operator is appended to the end of the parameter name using double underscore. 21 | 22 | >>> td.contributions(amount=100) # contributions equal to 100 dollars 23 | >>> td.contributions(amount__lt=100) # contributions less than 100 dollars 24 | 25 | >>> td.contributions(cycle=1990) # contributions from the 1990 election cycle 26 | >>> td.contributions(cycle__in=(1990,2008)) # contributions from the 1990 and 2008 election cycles 27 | 28 | gt 29 | Greater than specified value. 30 | 31 | lt 32 | Less than specified value. 33 | 34 | between 35 | Between the lesser value and greater value. Parameters must be passed as a two-value tuple or list. 36 | 37 | >>> td.contributions(date__between=(start_date, end_date)) 38 | 39 | in 40 | Matches any in a range of values. Parameter must be a tuple or list. 41 | 42 | 43 | See the parameter documentation (http://transparencydata.com/api/) to find out which operators are valid for each parameter. 44 | 45 | ---------------------- 46 | Campaign Contributions 47 | ---------------------- 48 | 49 | To find all contributions to Chris Van Hollen from the state of CA during the 2008 election cycle: 50 | 51 | >>> td.contributions(cycle=2008, contributor_state='CA', recipient_ft='van hollen') 52 | 53 | A list of valid contributions parameters can be accessed programmatically: 54 | 55 | >>> print td.contributions.parameters 56 | 57 | Parameter documentation: http://transparencydata.com/api/contributions 58 | 59 | Response documentation: http://transparencydata.com/docs/contributions 60 | 61 | -------- 62 | Lobbying 63 | -------- 64 | 65 | To find all lobbying conducted by John Wonderlich: 66 | 67 | >>> td.lobbying(lobbyist_ft='john wonderlich') 68 | 69 | A list of valid lobbying parameters can be accessed programmatically: 70 | 71 | >>> print td.lobbying.parameters 72 | 73 | Parameter documentation: http://transparencydata.com/api/lobbying 74 | 75 | Response documentation: http://transparencydata.com/docs/lobbying 76 | 77 | 78 | -------- 79 | Earmarks 80 | -------- 81 | 82 | To find all earmarks directed towards Seattle, WA: 83 | 84 | >>> td.earmarks(city='Seattle', state='WA') 85 | 86 | A list of valid earmark parameters can be accessed programmatically: 87 | 88 | >>> print td.earmarks.parameters 89 | 90 | Parameter documentation: http://transparencydata.com/api/earmarks 91 | 92 | Response documentation: http://transparencydata.com/docs/earmarks 93 | 94 | 95 | -------------- 96 | Federal Grants 97 | -------------- 98 | 99 | To find all grants made by the NEA in 2010: 100 | 101 | >>> td.grants(agency_ft='national endowment for the arts', fiscal_year='2010') 102 | 103 | A list of valid grant parameters can be accessed programmatically: 104 | 105 | >>> td.grants.parameters 106 | 107 | Parameter documentation: http://transparencydata.com/api/grants/ 108 | 109 | Response documentation: http://transparencydata.com/docs/grants/ 110 | 111 | 112 | ----------------- 113 | Federal Contracts 114 | ----------------- 115 | 116 | To find all federal contracts issued to Bank of America: 117 | 118 | >>> td.contracts(vendor_name='bank of america') 119 | 120 | A list of valid contract parameters can be accessed programmatically: 121 | 122 | >>> td.contracts.parameters 123 | 124 | Parameter documentation: http://transparencydata.com/api/contracts 125 | 126 | Response documentation: http://transparencydata.com/docs/contracts 127 | 128 | 129 | -------------------------------------------------------------------------------- /influenceexplorer.py: -------------------------------------------------------------------------------- 1 | """ 2 | The influenceexplorer module provides API wrappers for the data provided on 3 | InfluenceExplorer.com. 4 | """ 5 | 6 | 7 | import requests 8 | try: 9 | import json 10 | except ImportError: 11 | import simplejson as json 12 | 13 | from transparencydata import DEFAULT_URL 14 | 15 | 16 | # defaults of None don't mean that there is not default or no limit-- 17 | # it means that no parameter will be sent to the server, and the server 18 | # will use its own default. 19 | DEFAULT_LIMIT = None 20 | 21 | ALL_CYCLES = "-1" 22 | DEFAULT_CYCLE = ALL_CYCLES # -1 will return career totals. 23 | 24 | 25 | class InfluenceExplorer(object): 26 | 27 | """ 28 | Provides wrappers to the Influence Explorer APIs. 29 | 30 | Methods are divided into four categories. Entity methods can be accessed 31 | through the ``entities`` member, Politician methods through ``pol``, Individual 32 | methods through ``indiv`` and Organization through ``org``. For example:: 33 | 34 | api = InfluenceExplorer() 35 | boehner_id = api.entities.search('john boehner')[1]['id] 36 | print api.pol.industries(boehner_id) 37 | """ 38 | 39 | def __init__(self, api_key, base_url=DEFAULT_URL): 40 | """ 41 | Create an API wrapper. 42 | 43 | API keys can be obtained from http://services.sunlightlabs.com. 44 | """ 45 | 46 | self.base_url = base_url if base_url[-1] == '/' else base_url + '/' 47 | self.api_key = api_key 48 | self.entities = Entities(self) 49 | self.pol = Politician(self) 50 | self.indiv = Individual(self) 51 | self.org = Organization(self) 52 | self.map_ = Map(self) 53 | self.summaries = Summaries(self) 54 | 55 | 56 | def _get_url_json(self, path, cycle=None, limit=None, **params): 57 | """ Low level call that just adds the API key, retrieves the URL and parses the JSON. """ 58 | 59 | if cycle: 60 | params.update({'cycle': cycle}) 61 | if limit: 62 | params.update({'limit': limit}) 63 | 64 | params.update({'apikey': self.api_key}) 65 | 66 | full_url = self.base_url + path 67 | 68 | r = requests.get(full_url, params=params) 69 | 70 | # this will only raise an HTTPError if one occurred during our request, otherwise it will do nothing. 71 | r.raise_for_status() 72 | 73 | return r.json() 74 | 75 | 76 | class SubAPI(object): 77 | def __init__(self, main_api): 78 | self._get_url_json = main_api._get_url_json 79 | 80 | class Summaries(SubAPI): 81 | """ 82 | Methods related to obtaining aggregate information for groups corresponding 83 | to main site nav 84 | """ 85 | 86 | def summarize(self, entity_type, indicator, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 87 | return self._get_url_json('aggregates/summary/%s/%s.json'%(entity_type,indicator),cycle) 88 | 89 | def metadata(self, entity_type): 90 | return self._get_url_json('entities/summary/%s.json'%(entity_type,)) 91 | 92 | class Entities(SubAPI): 93 | """ 94 | Methods related to searching, listing and ranking entities. 95 | 96 | Accessed as ``InfluenceExplorer.entities``. 97 | """ 98 | 99 | def search(self, query, entity_type=None): 100 | """ 101 | Return entities with names matching the given query. 102 | 103 | Query terms are space separated. Matches must contain all terms 104 | from the query. 105 | 106 | Will by default return all types of entities available. Limit to one 107 | type (politician, individual, organization, industry) with the 108 | ``entity_type`` parameter. 109 | """ 110 | 111 | if entity_type: 112 | return self._get_url_json('entities.json', **{'search': query.encode('ascii', 'ignore'), 'type': entity_type}) 113 | else: 114 | return self._get_url_json('entities.json', search=query.encode('ascii', 'ignore')) 115 | 116 | def adv_search(self, query, **kwargs): 117 | """ 118 | Return entities with names matching the given query, with pagination 119 | and filtering by metadata. 120 | """ 121 | params = {'search': query.encode('ascii', 'ignore')} 122 | for arg, val in kwargs.items(): 123 | params[arg] = ','.join(val) if type(val) in (tuple, list) else val 124 | 125 | return self._get_url_json('entities/search.json', **params) 126 | 127 | _camp_fin_markers = ['contributor_count', 'recipient_count', 'independent_expenditure_amount', 'fec_summary_count'] 128 | _lobbying_markers = ['lobbying_count'] 129 | _spending_markers = ['grant_count', 'loan_count', 'contract_count'] 130 | _earmark_markers = ['earmark_count'] 131 | _contractor_misconduct_markers = ['contractor_misconduct_count'] 132 | _epa_echo_markers = ['epa_actions_count'] 133 | _regulations_markers = ['regs_docket_count', 'regs_submitted_docket_count'] 134 | _faca_markers = ['faca_committee_count', 'faca_member_count'] 135 | 136 | def metadata(self, entity_id): 137 | 138 | """Return all available metadata for the given entity.""" 139 | 140 | results = self._get_url_json('entities/%s.json' % entity_id) 141 | 142 | results['years'] = self._entity_years(results['totals'], self._camp_fin_markers + self._lobbying_markers + self._spending_markers) 143 | results['camp_fin_years'] = self._entity_years(results['totals'], self._camp_fin_markers) 144 | results['lobbying_years'] = self._entity_years(results['totals'], self._lobbying_markers) 145 | results['spending_years'] = self._entity_years(results['totals'], self._spending_markers) 146 | results['earmark_years'] = self._entity_years(results['totals'], self._earmark_markers) 147 | results['contractor_misconduct_years'] = self._entity_years(results['totals'], self._contractor_misconduct_markers) 148 | results['epa_echo_years'] = self._entity_years(results['totals'], self._epa_echo_markers) 149 | results['regulations_years'] = self._entity_years(results['totals'], self._regulations_markers) 150 | results['faca_years'] = self._entity_years(results['totals'], self._faca_markers) 151 | 152 | return results 153 | 154 | def _entity_years(self, totals, keys): 155 | years = [year for (year, values) in totals.items() if any([v for (k,v) in values.items() if k in keys]) and year != "-1"] 156 | years.sort() 157 | if years: 158 | return dict(start=years[0], end=years[-1]) 159 | else: 160 | return {} 161 | 162 | def id_lookup(self, namespace, id): 163 | """ 164 | Return the Influence Explorer entity ID based on a 3rd party ID. 165 | 166 | Valid namespaces include: 167 | 168 | * ``urn:crp:individual`` -- CRP's contributor or lobbyist ID 169 | * ``urn:crp:organization`` -- CRP's organization ID 170 | * ``urn:crp:recipient`` -- CRP's candidate ID 171 | * ``urn:crp:industry`` -- CRP's 3-letter category order 172 | * ``urn:crp:subindustry`` -- CRP's 5-letter category code 173 | * ``urn:nimsp:subindustry`` -- 5-letter category code added by NIMSP 174 | * ``urn:nimsp:organization`` -- NIMSP's organization ID 175 | * ``urn:nimsp:recipient`` -- NIMSP's candidate ID 176 | * ``urn:sunlight:lobbyist_registration_tracker_url`` -- URL of Sunlight's lobbyist registration tracker page 177 | * ``urn:sunlight:congressional_bioguide`` -- ID as assigned by the Congressional Bioguide (bioguide.congress.gov) 178 | """ 179 | 180 | bioguide_id = None 181 | if namespace == 'urn:sunlight:congressional_bioguide': 182 | bioguide_id = id 183 | namespace = None 184 | id = None 185 | return self._get_url_json('entities/id_lookup.json', namespace=namespace, id=id, bioguide_id=bioguide_id) 186 | else: 187 | return self._get_url_json('entities/id_lookup.json', namespace=namespace, id=id) 188 | 189 | 190 | def count(self, type=None): 191 | """ Return the total count of entities. """ 192 | params = {'count': 1} 193 | if type: 194 | params['type'] = type 195 | return int(self._get_url_json('entities/list.json', **params)['count']) 196 | 197 | 198 | def list(self, start, end, type=None): 199 | """ List all entities. """ 200 | params = {'start': start, 'end': end} 201 | if type: 202 | params['type'] = type 203 | return self._get_url_json('entities/list.json', **params) 204 | 205 | 206 | # top n lists 207 | def top_n_individuals(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 208 | """ Return the top individuals, by amount contributed. """ 209 | return self._get_url_json('aggregates/indivs/top_%s.json' % limit, cycle) 210 | 211 | def top_n_indiv_democratic_donors(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 212 | """ Return the top individuals, by amount contributed to Democrats. """ 213 | return self._get_url_json('aggregates/indivs/party/D/top_%s.json' % limit, cycle) 214 | 215 | def top_n_indiv_republican_donors(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 216 | """ Return the top individuals, by amount contributed to Republicans. """ 217 | return self._get_url_json('aggregates/indivs/party/R/top_%s.json' % limit, cycle) 218 | 219 | def top_n_organizations(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 220 | """ Return the top organizations, by amount contributed. """ 221 | return self._get_url_json('aggregates/orgs/top_%s.json' % limit, cycle) 222 | 223 | def top_n_politicians(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT, office=None): 224 | """ Return the top politicians, by amount received. """ 225 | if office in ('president', 'senate', 'house', 'governor'): 226 | return self._get_url_json('aggregates/pols/%s/top_%s.json' % (office, limit), cycle) 227 | 228 | return self._get_url_json('aggregates/pols/top_%s.json' % limit, cycle) 229 | 230 | def top_n_industries(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 231 | """ Return the top industries, by amount contributed. """ 232 | return self._get_url_json('aggregates/industries/top_%s.json' % limit, cycle) 233 | 234 | def candidates_by_location(self, location, cycle=DEFAULT_CYCLE): 235 | """ Internal use only. Not maintained. """ 236 | return self._get_url_json('entities/race/%s.json' % location, cycle) 237 | 238 | def election_districts(self, cycle=DEFAULT_CYCLE): 239 | """ Internal use only. Not maintained. """ 240 | return self._get_url_json('entities/race/districts.json', cycle) 241 | 242 | def bundles(self, entity_id, cycle=DEFAULT_CYCLE): 243 | """ Return any bundling data for the entity. """ 244 | return self._get_url_json('aggregates/pol/{0}/bundles.json'.format(entity_id), cycle) 245 | 246 | def top_n_lobbyist_bundlers(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 247 | """ Return top lobbyist bundlers. """ 248 | return self._get_url_json('aggregates/indivs/lobbyist_bundlers/top_{0}.json'.format(limit), cycle) 249 | 250 | def top_n_orgs_lobbying(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT, is_industry=False): 251 | """ Return top industries by lobbying spending. """ 252 | if is_industry: 253 | return self._get_url_json('aggregates/industries/lobbying/top_{0}.json'.format(limit), cycle) 254 | else: 255 | return self._get_url_json('aggregates/orgs/lobbying/top_{0}.json'.format(limit), cycle) 256 | 257 | def top_n_industry_donors_to_democrats(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 258 | """ Return top industries by dollars donated to democrats. """ 259 | return self._get_url_json('aggregates/industries/party/D/top_{0}.json'.format(limit), cycle) 260 | 261 | def top_n_industry_donors_to_republicans(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 262 | """ Return top industries by dollars donated to republicans. """ 263 | return self._get_url_json('aggregates/industries/party/R/top_{0}.json'.format(limit), cycle) 264 | 265 | def top_n_largest_donations_in_last_month(self, limit=DEFAULT_LIMIT): 266 | """ Return largest donations in last month. """ 267 | return self._get_url_json('aggregates/fec/last_month/largest_{0}.json'.format(limit)) 268 | 269 | def top_n_pacs_by_indexp(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 270 | """ Return top PACs by independent expenditures. """ 271 | return self._get_url_json('aggregates/orgs/indexp/top_{0}.json'.format(limit), cycle) 272 | 273 | def top_n_pols_by_indexp_by_office(self, office, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 274 | """ Return top politicians by independent expenditures, by office. """ 275 | if office in 'senate house president'.split(): 276 | return self._get_url_json('aggregates/pols/indexp/{}/top_{}.json'.format(office, limit), cycle) 277 | 278 | def top_n_firms_by_income(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 279 | """ Return top lobbying firms by income. """ 280 | return self._get_url_json('aggregates/orgs/lobbying_firms/top_{0}.json'.format(limit)) 281 | 282 | def top_n_indivs_by_area(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT, area=None): 283 | """ Return top individuals donating at the state level. """ 284 | if area.lower() in ('state', 'federal'): 285 | return self._get_url_json('aggregates/indivs/{}/top_{}.json'.format(area, limit)) 286 | 287 | def top_n_regs_submitters(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 288 | """ Return top organizations submitting comments on regulations. """ 289 | return self._get_url_json('aggregates/orgs/regulations/submitters/top_{}.json'.format(limit)) 290 | 291 | def top_n_org_donors_by_area_contributor_type(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT, area=None, contributor_type=None): 292 | """ Return top organizations contributing via PACs or employees by area (state/federal). """ 293 | if area in 'state federal'.split() and contributor_type in 'pac employee'.split(): 294 | return self._get_url_json('aggregates/orgs/{}/{}/top_{}.json'.format(area, contributor_type, limit)) 295 | 296 | def top_n_industries_time_series(self, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 297 | return self._get_url_json('aggregates/industries/top_{0}_industries_time_series.json'.format((limit)), cycle) 298 | 299 | 300 | class Politician(SubAPI): 301 | """ 302 | Methods relating to a politician entity. 303 | 304 | Accessed as ``InfluenceExplorer.pol``. 305 | """ 306 | 307 | def contributors(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 308 | """ Return the top organizational contributors. """ 309 | return self._get_url_json('aggregates/pol/%s/contributors.json' % entity_id, cycle, limit) 310 | 311 | def sectors(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 312 | """ Not maintained. """ 313 | return self._get_url_json('aggregates/pol/%s/contributors/sectors.json' % entity_id, cycle, limit) 314 | 315 | def industries(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 316 | """ Return the top contributing industries. """ 317 | return self._get_url_json('aggregates/pol/%s/contributors/industries.json' % entity_id, cycle, limit) 318 | 319 | def industries_unknown(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 320 | """ Return the count and total from unknown industries """ 321 | return self._get_url_json('aggregates/pol/%s/contributors/industries_unknown.json' % entity_id, cycle) 322 | 323 | def local_breakdown(self, entity_id, cycle=DEFAULT_CYCLE): 324 | """ Return the breakdown of in-state vs. out-of-state contributions. """ 325 | return self._get_url_json('aggregates/pol/%s/contributors/local_breakdown.json' % entity_id, cycle) 326 | 327 | def contributor_type_breakdown(self, entity_id, cycle=DEFAULT_CYCLE): 328 | """ Return the breakdown of individual vs. organization contributions. """ 329 | return self._get_url_json('aggregates/pol/%s/contributors/type_breakdown.json' % entity_id, cycle) 330 | 331 | def earmarks(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 332 | """ Return top earmarks requested by this politician. """ 333 | return self._get_url_json('aggregates/pol/%s/earmarks.json' % entity_id, cycle, limit) 334 | 335 | def earmarks_local_breakdown(self, entity_id, cycle=DEFAULT_CYCLE): 336 | """ Return breakdown of earmark amount for in-state vs. out-of-state projects. """ 337 | return self._get_url_json('aggregates/pol/%s/earmarks/local_breakdown.json' % entity_id, cycle) 338 | 339 | def fec_summary(self, entity_id, cycle=DEFAULT_CYCLE): 340 | """ Return the latest figures from the FECs summary report. """ 341 | return self._get_url_json('aggregates/pol/%s/fec_summary.json' % entity_id, cycle) 342 | 343 | def fec_timeline(self, entity_id, cycle=DEFAULT_CYCLE): 344 | """ Return weekly itemized fundraising totals for the candidate and opponents. """ 345 | return self._get_url_json('aggregates/pol/%s/fec_timeline.json' % entity_id, cycle) 346 | 347 | def fec_indexp(self, entity_id, cycle=DEFAULT_CYCLE): 348 | """ Return independent expenditures for and against the candidate. """ 349 | return self._get_url_json('aggregates/pol/%s/fec_indexp.json' % entity_id, cycle) 350 | 351 | 352 | class Individual(SubAPI): 353 | """ 354 | Methods relating to individual entities. 355 | 356 | Accessed as ``InfluenceExplorer.indiv``. 357 | """ 358 | 359 | def org_recipients(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 360 | ''' Return the top organizations receiving contributions. ''' 361 | return self._get_url_json('aggregates/indiv/%s/recipient_orgs.json' % entity_id, cycle, limit) 362 | 363 | 364 | def pol_recipients(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 365 | ''' Return the top politicians receiving contributions. ''' 366 | return self._get_url_json('aggregates/indiv/%s/recipient_pols.json' % entity_id, cycle, limit) 367 | 368 | def party_breakdown(self, entity_id, cycle=DEFAULT_CYCLE): 369 | """ Return breakdown of amount contributed to each party. """ 370 | return self._get_url_json('aggregates/indiv/%s/recipients/party_breakdown.json' % entity_id, cycle) 371 | 372 | def registrants(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 373 | """ 374 | Return the lobbying firms that employed the individual. 375 | 376 | Only return data for individuals that are registered lobbyists. 377 | """ 378 | 379 | return self._get_url_json('aggregates/indiv/%s/registrants.json' % entity_id, cycle, limit) 380 | 381 | def issues(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 382 | """ 383 | Return the top issues the individual lobbied on. 384 | 385 | Only return data for individuals that are registered lobbyists. 386 | """ 387 | return self._get_url_json('aggregates/indiv/%s/issues.json' % entity_id, cycle, limit) 388 | 389 | def clients(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 390 | """ 391 | Return the clients the individual was contracted to work for. 392 | 393 | Only return data for individuals that are registered lobbyists. 394 | """ 395 | return self._get_url_json('aggregates/indiv/%s/clients.json' % entity_id, cycle, limit) 396 | 397 | 398 | class Organization(SubAPI): 399 | """ 400 | Methods related to organization or industry entities. 401 | 402 | Accessed as ``InfluenceExplorer.org``. 403 | """ 404 | 405 | def recipients(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 406 | """ Return top politicians receiving contributions. """ 407 | return self._get_url_json('aggregates/org/%s/recipients.json' % entity_id, cycle, limit) 408 | 409 | 410 | def pac_recipients(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 411 | ''' Return the top organizations receiving contributions. ''' 412 | return self._get_url_json('aggregates/org/%s/recipient_pacs.json' % entity_id, cycle, limit) 413 | 414 | def party_breakdown(self, entity_id, cycle=DEFAULT_CYCLE): 415 | """ Return breakdown of amount contributed to each party. """ 416 | return self._get_url_json('aggregates/org/%s/recipients/party_breakdown.json' % entity_id, cycle) 417 | 418 | def level_breakdown(self, entity_id, cycle=DEFAULT_CYCLE): 419 | """ Return breakdown of amount contributed to state vs. federal races. """ 420 | return self._get_url_json('aggregates/org/%s/recipients/level_breakdown.json' % entity_id, cycle) 421 | 422 | def registrants(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 423 | ''' 424 | Return lobbying firms hired. 425 | 426 | Only return data if organization is a client of lobbying firms. 427 | ''' 428 | return self._get_url_json('aggregates/org/%s/registrants.json' % entity_id, cycle, limit) 429 | 430 | def issues(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 431 | """ 432 | Return issues lobbied on. 433 | 434 | Only return data if organization is a client of lobbying firms. 435 | """ 436 | return self._get_url_json('aggregates/org/%s/issues.json' % entity_id, cycle, limit) 437 | 438 | def bills(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 439 | """ 440 | Return bills lobbied on. 441 | 442 | Only return data if organization is a client of lobbying firms. 443 | """ 444 | return self._get_url_json('aggregates/org/%s/bills.json' % entity_id, cycle, limit) 445 | 446 | def lobbyists(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 447 | """ 448 | Return lobbyists hired. 449 | 450 | Only return data if organization is a client of lobbying firms. 451 | """ 452 | return self._get_url_json('aggregates/org/%s/lobbyists.json' % entity_id, cycle, limit) 453 | 454 | def registrant_clients(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 455 | """ 456 | Return clients that hired this organization to lobby. 457 | 458 | Only return data if organization is a lobbying firm. 459 | """ 460 | return self._get_url_json('aggregates/org/%s/registrant/clients.json' % entity_id, cycle, limit) 461 | 462 | def registrant_issues(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 463 | """ 464 | Return issues this organization lobbied on. 465 | 466 | Only return data if organization is a lobbying firm. 467 | """ 468 | return self._get_url_json('aggregates/org/%s/registrant/issues.json' % entity_id, cycle, limit) 469 | 470 | def registrant_bills(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 471 | """ 472 | Return bill this organization lobbied on. 473 | 474 | Only return data if organization is a lobbying firm. 475 | """ 476 | return self._get_url_json('aggregates/org/%s/registrant/bills.json' % entity_id, cycle, limit) 477 | 478 | 479 | def registrant_lobbyists(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 480 | """ 481 | Return lobbyists employed. 482 | 483 | Only return data if organization is a lobbying firm. 484 | """ 485 | return self._get_url_json('aggregates/org/%s/registrant/lobbyists.json' % entity_id, cycle, limit) 486 | 487 | def industry_orgs(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 488 | """ 489 | Return top organizations within this industry. 490 | 491 | Only return data if entity is an industry. 492 | """ 493 | return self._get_url_json('aggregates/industry/%s/orgs.json' % entity_id, cycle, limit) 494 | 495 | def subindustry_totals(self,cycle=DEFAULT_CYCLE): 496 | """ 497 | Return totals for all subindustries in a given cycle 498 | """ 499 | return self._get_url_json('aggregates/industries/subindustry_totals.json', cycle=cycle) 500 | 501 | def fed_spending(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 502 | """ 503 | Return top federal grants and contracts received. 504 | 505 | Matching is based on full-text search and may include incorrect matches 506 | or miss records. Not appropriate for automatic aggregation. 507 | """ 508 | return self._get_url_json('aggregates/org/%s/fed_spending.json' % entity_id, cycle, limit) 509 | 510 | def earmarks(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 511 | """ Return top earmarks received by organization. """ 512 | return self._get_url_json('aggregates/org/%s/earmarks.json' % entity_id, cycle, limit) 513 | 514 | def contractor_misconduct(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 515 | """ Return top misconduct instances by organization. """ 516 | return self._get_url_json('aggregates/org/%s/contractor_misconduct.json' % entity_id, cycle, limit) 517 | 518 | def regulations_text(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 519 | """ Return the regulatory dockets that most frequently mention this entity. """ 520 | return self._get_url_json('aggregates/org/%s/regulations_text.json' % entity_id, cycle, limit) 521 | 522 | def regulations_submitter(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 523 | """ Return the regulatory dockets with the most submissions from this entity. """ 524 | return self._get_url_json('aggregates/org/%s/regulations_submitter.json' % entity_id, cycle, limit) 525 | 526 | def epa_echo(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 527 | """ Return top EPA enforcement actions by organization. """ 528 | return self._get_url_json('aggregates/org/%s/epa_enforcement_actions.json' % entity_id, cycle, limit) 529 | 530 | def faca(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 531 | """ Return this entity's employees' memberships on federal advisory committees. """ 532 | return self._get_url_json('aggregates/org/%s/faca.json' % entity_id, cycle, limit) 533 | 534 | def fec_summary(self, entity_id, cycle=DEFAULT_CYCLE): 535 | """ Return the latest figures from the FECs summary report. """ 536 | return self._get_url_json('aggregates/org/%s/fec_summary.json' % entity_id, cycle) 537 | 538 | def fec_indexp(self, entity_id, cycle=DEFAULT_CYCLE): 539 | """ Return independent expenditures made by the committee. """ 540 | return self._get_url_json('aggregates/org/%s/fec_indexp.json' % entity_id, cycle) 541 | 542 | def fec_top_contribs(self, entity_id, cycle=DEFAULT_CYCLE, limit=DEFAULT_LIMIT): 543 | """ Return top contributors to the committee. """ 544 | return self._get_url_json('aggregates/org/%s/fec_top_contribs.json' % entity_id, cycle, limit) 545 | 546 | 547 | class Map(SubAPI): 548 | """ 549 | Methods that return geographical data. 550 | 551 | Accessed as ``InfluenceExplorer.org``. 552 | """ 553 | def senate_independent_expenditures(self, cycle=DEFAULT_CYCLE): 554 | return self._get_url_json('aggregates/map/indexp/senate/lat_lng.geo.json', cycle) 555 | 556 | def house_independent_expenditures(self, cycle=DEFAULT_CYCLE): 557 | return self._get_url_json('aggregates/map/indexp/house/lat_lng.geo.json', cycle) 558 | 559 | def presidential_contribs(self, state, cycle=DEFAULT_CYCLE): 560 | return self._get_url_json('aggregates/map/contributions/presidential/{0}/lat_lng.geo.json'.format(state), cycle) 561 | 562 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | from distutils.core import setup 2 | from transparencydata import __version__ 3 | 4 | long_description = open('README.rst').read() 5 | 6 | setup(name="python-transparencydata", 7 | version=__version__, 8 | py_modules=["transparencydata", "influenceexplorer"], 9 | description="Library for interacting with the Sunlight Labs Transparency Data API", 10 | author="Jeremy Carbaugh", 11 | author_email = "jcarbaugh@sunlightfoundation.com", 12 | license='BSD', 13 | url="http://github.com/sunlightlabs/python-transparencydata/", 14 | long_description=long_description, 15 | platforms=["any"], 16 | classifiers=["Development Status :: 4 - Beta", 17 | "Intended Audience :: Developers", 18 | "License :: OSI Approved :: BSD License", 19 | "Natural Language :: English", 20 | "Operating System :: OS Independent", 21 | "Programming Language :: Python", 22 | "Topic :: Software Development :: Libraries :: Python Modules", 23 | ], 24 | ) 25 | -------------------------------------------------------------------------------- /transparencydata.py: -------------------------------------------------------------------------------- 1 | """ 2 | The transparencydata module provides API wrappers for the data found on 3 | transparencydata.com. 4 | """ 5 | 6 | __author__ = "Jeremy Carbaugh (jcarbaugh@sunlightfoundation.com)" 7 | __version__ = "0.1" 8 | __copyright__ = "Copyright (c) 2010 Sunlight Labs" 9 | __license__ = "BSD" 10 | 11 | import sys 12 | 13 | if sys.version_info[0] == 3: 14 | from urllib.parse import urlencode, urljoin 15 | from urllib.request import urlopen 16 | from urllib.error import HTTPError 17 | else: 18 | from urllib import urlencode 19 | from urlparse import urljoin 20 | from urllib2 import HTTPError, urlopen 21 | 22 | try: 23 | import json 24 | except ImportError: 25 | import simplejson as json 26 | 27 | DEFAULT_URL = "http://transparencydata.com/api/1.0/" 28 | DEFAULT_PARAMETERS = ('apikey','page','per_page') 29 | DEFAULT_HANDLERS = {} 30 | 31 | class TransparencyDataError(Exception): 32 | pass 33 | 34 | 35 | # base client 36 | class Client(object): 37 | 38 | def __init__(self, key, base_url=DEFAULT_URL): 39 | self.apikey = key 40 | self.apiurl = base_url 41 | self.debug = False 42 | 43 | def __call__(self, **kwargs): 44 | 45 | kwargs['apikey'] = self.apikey 46 | params = {} 47 | 48 | handlers = {} 49 | handlers.update(DEFAULT_HANDLERS) 50 | if hasattr(self, 'handlers'): 51 | handlers.update(self.handlers) 52 | 53 | for param, value in kwargs.iteritems(): 54 | 55 | (name, operator) = param.split('__') if '__' in param else (param, None) 56 | 57 | if name not in self.parameters and name not in DEFAULT_PARAMETERS: 58 | raise TransparencyDataError('%s is not a valid parameter' % param) 59 | 60 | if operator == 'in': 61 | if isinstance(value, (list, tuple)): 62 | value = "|".join(str(v) for v in value) 63 | else: 64 | operator = None 65 | 66 | elif operator == 'gt': 67 | value = ">|%s" % value 68 | 69 | elif operator == 'lt': 70 | value = "<|%s" % value 71 | 72 | elif operator == 'between': 73 | if not isinstance(value, (list, tuple)): 74 | raise TransparencyDataError('%s__%s must be a tuple or list' % (name, operator)) 75 | start = value[0].strftime("%Y-%m-%d") 76 | end = value[1].strftime("%Y-%m-%d") 77 | value = "><|%s|%s" % (start, end) 78 | 79 | handler = handlers.get(name, None) 80 | if handler: 81 | value = handler(name, value, operator) 82 | 83 | params[name] = value.encode('utf8') 84 | 85 | url = "%s?%s" % (urljoin(self.apiurl, self.endpoint), urlencode(params)) 86 | if self.debug: 87 | print url 88 | return 89 | 90 | try: 91 | response = urlopen(url).read().decode() 92 | return json.loads(response) 93 | except HTTPError, e: 94 | raise TransparencyDataError(e.read()) 95 | except (ValueError, KeyError), e: 96 | raise TransparencyDataError('Invalid Response') 97 | 98 | # base types 99 | class ContributionsClient(Client): 100 | endpoint = 'contributions.json' 101 | parameters = ( 102 | 'contributor_state', 103 | 'recipient_state', 104 | 'cycle', 105 | 'for_against', 106 | 'contributor_industry', 107 | 'seat', 108 | 'transaction_namespace', 109 | 'transaction_type', 110 | 'contributor_ext_id', 111 | 'recipient_ext_id', 112 | 'organization_ext_id', 113 | 'parent_organization_ext_id', 114 | 'committee_ext_id', 115 | 'contributor_type', 116 | 'recipient_type', 117 | 'date', 118 | 'amount', 119 | 'committee_ft', 120 | 'contributor_ft', 121 | 'employer_ft', 122 | 'organization_ft', 123 | 'recipient_ft', 124 | ) 125 | 126 | class LobbyingClient(Client): 127 | endpoint = 'lobbying.json' 128 | parameters = ( 129 | 'lobbyist_is_rep', 130 | 'industry', 131 | 'transaction_id', 132 | 'transaction_type', 133 | 'filing_type', 134 | 'year', 135 | 'issue', 136 | 'client_ext_id', 137 | 'lobbyist_ext_id', 138 | 'candidate_ext_id', 139 | 'client_ft', 140 | 'client_parent_ft', 141 | 'lobbyist_ft', 142 | 'registrant_ft', 143 | 'issue_ft', 144 | ) 145 | 146 | class EarmarkClient(Client): 147 | endpoint = 'earmarks.json' 148 | parameters = ( 149 | 'year', 150 | 'state', 151 | 'member_party', 152 | 'member_state', 153 | 'bill', 154 | 'description', 155 | 'city', 156 | 'member', 157 | 'recipient', 158 | ) 159 | 160 | 161 | class GrantsClient(Client): 162 | endpoint = 'grants.json' 163 | parameters = ( 164 | 'assistance_type', 165 | 'fiscal_year', 166 | 'recipient_state', 167 | 'recipient_type', 168 | 'agency_ft', 169 | 'recipient_ft', 170 | ) 171 | 172 | 173 | class ContractsClient(Client): 174 | endpoint = 'contracts.json' 175 | parameters = ( 176 | 'agency_id', 177 | 'contracting_agency_id', 178 | 'fiscal_year', 179 | 'place_distrct', 180 | 'place_state', 181 | 'requesting_agency_id', 182 | 'vendor_state', 183 | 'vendor_zipcode', 184 | 'vendor_district', 185 | 'vendor_duns', 186 | 'vendor_parent_duns', 187 | 'agency_name', 188 | 'contracting_agency_name', 189 | 'requesting_agency_name', 190 | 'vendor_name', 191 | 'vendor_city', 192 | 'obligated_amount', 193 | 'current_amount', 194 | 'maximum_amount', 195 | ) 196 | 197 | 198 | # main wrapper 199 | class TransparencyData(object): 200 | 201 | def __init__(self, key): 202 | self.contributions = ContributionsClient(key) 203 | self.lobbying = LobbyingClient(key) 204 | self.earmarks = EarmarkClient(key) 205 | self.grants = GrantsClient(key) 206 | self.contracts = ContractsClient(key) 207 | --------------------------------------------------------------------------------