Permalink
Browse files

Updated index page.

  • Loading branch information...
1 parent 7e213f5 commit 425cbcf4146d7f46004e814da998a52cd60460e4 Ethan Phelps-Goodman committed Mar 18, 2011
View
74 README.rst
@@ -22,77 +22,3 @@ python >= 2.4
simplejson >= 1.8 (not required with Python 2.6, will use built-in ``json`` module)
-Usage
-=====
-
-To initialize the api, all that is required is for it to be imported and for an
-API key to be defined.
-
-(If you do not have an API key visit http://services.sunlightlabs.com/api/ to
-register for one.)
-
-Import TransparencyData class and set your API key:
-
- >>> from transparencydata import TransparencyData
- >>> td = TransparencyData('sunlight-api-key')
-
--------------------
-Parameter Operators
--------------------
-
-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.
-
- >>> td.contributions(amount=100) # contributions equal to 100 dollars
- >>> td.contributions(amount__lt=100) # contributions less than 100 dollars
-
- >>> td.contributions(cycle=1990) # contributions from the 1990 election cycle
- >>> td.contributions(cycle__in=(1990,2008)) # contributions from the 1990 and 2008 election cycles
-
-gt
- Greater than specified value.
-
-lt
- Less than specified value.
-
-between
- Between the lesser value and greater value. Parameters must be passed as a two-value tuple or list.
-
- >>> td.contributions(date__between=(start_date, end_date))
-
-in
- Matches any in a range of values. Parameter must be a tuple or list.
-
-
-See the parameter documentation (http://transparencydata.com/api/) to find out which operators are valid for each parameter.
-
-----------------------
-Campaign Contributions
-----------------------
-
-To find all contributions to Chris Van Hollen from the state of CA during the 2008 election cycle:
-
- >>> td.contributions(cycle=2008, contributor_state='CA', recipient_ft='van hollen')
-
-A list of valid contributions parameters can be accessed programmatically:
-
- >>> print td.contributions.parameters
-
-Parameter documentation: http://transparencydata.com/api/#contributions
-
-Response documentation: http://transparencydata.com/docs/#contributions
-
---------
-Lobbying
---------
-
-To find all lobbying conducted by John Wonderlich:
-
- >>> td.lobbying(lobbyist_ft='john wonderlich')
-
-A list of valid lobbying parameters can be accessed programmatically:
-
- >>> print td.lobbying.parameters
-
-Parameter documentation: http://transparencydata.com/api/#lobbying
-
-Response documentation: http://transparencydata.com/docs/#lobbying
View
BIN docs/_build/doctrees/environment.pickle
Binary file not shown.
View
BIN docs/_build/doctrees/influenceexplorer.doctree
Binary file not shown.
View
BIN docs/_build/doctrees/transparencydata.doctree
Binary file not shown.
View
17 docs/_build/html/_sources/influenceexplorer.txt
@@ -1,18 +1,35 @@
Influence Explorer API
======================
+
.. automodule:: influenceexplorer
.. autoclass:: influenceexplorer.InfluenceExplorer
+
+----------------------
+General Entity Methods
+----------------------
.. autoclass:: influenceexplorer.Entities()
:members:
+------------------
+Politician Methods
+------------------
+
.. autoclass:: influenceexplorer.Politician()
:members:
+--------------------
+Organization Methods
+--------------------
+
.. autoclass:: influenceexplorer.Organization()
:members:
+------------------
+Individual Methods
+------------------
+
.. autoclass:: influenceexplorer.Individual()
:members:
View
12 docs/_build/html/_sources/transparencydata.txt
@@ -1,9 +1,9 @@
Transparency Data API
=====================
+-----
Usage
-=====
-
+-----
The TransparencyData class is constructed with your API key as an initialization parameter:
@@ -98,11 +98,11 @@ Federal Grants
To find all grants made by the NEA in 2010:
- >>> api.grants(agency_ft='national endowment for the arts', fiscal_year='2010')
+ >>> td.grants(agency_ft='national endowment for the arts', fiscal_year='2010')
A list of valid grant parameters can be accessed programmatically:
- >>> api.grants.parameters
+ >>> td.grants.parameters
Parameter documentation: http://transparencydata.com/api/grants/
@@ -115,11 +115,11 @@ Federal Contracts
To find all federal contracts issued to Bank of America:
- >>> api.contracts(vendor_name='bank of america')
+ >>> td.contracts(vendor_name='bank of america')
A list of valid contract parameters can be accessed programmatically:
- >>> api.contracts.parameters
+ >>> td.contracts.parameters
Parameter documentation: http://transparencydata.com/api/contracts
View
12 docs/_build/html/index.html
@@ -60,8 +60,8 @@
More data sets will be added over time.</p>
<div class="toctree-wrapper compound">
<ul>
-<li class="toctree-l1"><a class="reference internal" href="transparencydata.html">Transparency Data API</a></li>
-<li class="toctree-l1"><a class="reference internal" href="transparencydata.html#usage">Usage</a><ul>
+<li class="toctree-l1"><a class="reference internal" href="transparencydata.html">Transparency Data API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="transparencydata.html#usage">Usage</a></li>
<li class="toctree-l2"><a class="reference internal" href="transparencydata.html#parameter-operators">Parameter Operators</a></li>
<li class="toctree-l2"><a class="reference internal" href="transparencydata.html#campaign-contributions">Campaign Contributions</a></li>
<li class="toctree-l2"><a class="reference internal" href="transparencydata.html#lobbying">Lobbying</a></li>
@@ -70,7 +70,13 @@
<li class="toctree-l2"><a class="reference internal" href="transparencydata.html#federal-contracts">Federal Contracts</a></li>
</ul>
</li>
-<li class="toctree-l1"><a class="reference internal" href="influenceexplorer.html">Influence Explorer API</a></li>
+<li class="toctree-l1"><a class="reference internal" href="influenceexplorer.html">Influence Explorer API</a><ul>
+<li class="toctree-l2"><a class="reference internal" href="influenceexplorer.html#general-entity-methods">General Entity Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="influenceexplorer.html#politician-methods">Politician Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="influenceexplorer.html#organization-methods">Organization Methods</a></li>
+<li class="toctree-l2"><a class="reference internal" href="influenceexplorer.html#individual-methods">Individual Methods</a></li>
+</ul>
+</li>
</ul>
</div>
</div>
View
23 docs/_build/html/influenceexplorer.html
@@ -64,6 +64,8 @@
</div>
</dd></dl>
+<div class="section" id="general-entity-methods">
+<h2>General Entity Methods<a class="headerlink" href="#general-entity-methods" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="influenceexplorer.Entities">
<em class="property">class </em><tt class="descclassname">influenceexplorer.</tt><tt class="descname">Entities</tt><a class="reference internal" href="_modules/influenceexplorer.html#Entities"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#influenceexplorer.Entities" title="Permalink to this definition">¶</a></dt>
@@ -151,6 +153,9 @@
</dd></dl>
+</div>
+<div class="section" id="politician-methods">
+<h2>Politician Methods<a class="headerlink" href="#politician-methods" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="influenceexplorer.Politician">
<em class="property">class </em><tt class="descclassname">influenceexplorer.</tt><tt class="descname">Politician</tt><a class="reference internal" href="_modules/influenceexplorer.html#Politician"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#influenceexplorer.Politician" title="Permalink to this definition">¶</a></dt>
@@ -206,6 +211,9 @@
</dd></dl>
+</div>
+<div class="section" id="organization-methods">
+<h2>Organization Methods<a class="headerlink" href="#organization-methods" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="influenceexplorer.Organization">
<em class="property">class </em><tt class="descclassname">influenceexplorer.</tt><tt class="descname">Organization</tt><a class="reference internal" href="_modules/influenceexplorer.html#Organization"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#influenceexplorer.Organization" title="Permalink to this definition">¶</a></dt>
@@ -320,6 +328,9 @@
</dd></dl>
+</div>
+<div class="section" id="individual-methods">
+<h2>Individual Methods<a class="headerlink" href="#individual-methods" title="Permalink to this headline">¶</a></h2>
<dl class="class">
<dt id="influenceexplorer.Individual">
<em class="property">class </em><tt class="descclassname">influenceexplorer.</tt><tt class="descname">Individual</tt><a class="reference internal" href="_modules/influenceexplorer.html#Individual"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#influenceexplorer.Individual" title="Permalink to this definition">¶</a></dt>
@@ -373,13 +384,25 @@
</dd></dl>
</div>
+</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
+ <h3><a href="index.html">Table Of Contents</a></h3>
+ <ul>
+<li><a class="reference internal" href="#">Influence Explorer API</a><ul>
+<li><a class="reference internal" href="#general-entity-methods">General Entity Methods</a></li>
+<li><a class="reference internal" href="#politician-methods">Politician Methods</a></li>
+<li><a class="reference internal" href="#organization-methods">Organization Methods</a></li>
+<li><a class="reference internal" href="#individual-methods">Individual Methods</a></li>
+</ul>
+</li>
+</ul>
+
<h4>Previous topic</h4>
<p class="topless"><a href="transparencydata.html"
title="previous chapter">Transparency Data API</a></p>
View
BIN docs/_build/html/objects.inv
Binary file not shown.
View
2 docs/_build/html/searchindex.js
@@ -1 +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:2,content:[],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:[],crp:2,name:[2,1],organ:[0,2],level:0,transparencydata:[0,1,2],list:[2,1],separ:2,boehner:2,race:2,contain:2,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,categori:2,state:[0,1,2],tracker:2,between:1,print:[2,1],"import":1,paramet:[0,1],method:[2,1],metadata:2,local_breakdown:2,full:2,seattl:1,kei:[2,1],sparklin:2,usag:[0,1],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],within:2,regist:[2,1],modul:[0,2],each:[2,1],fiscal_year:1,rank:2,top_n_organ:2,down:2,pol:2,top_n_politician:2,wrapper:[0,2],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],programmat:1,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],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],receiv:2,parti:2,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,titl:[],order:2},objtypes:{"0":"py:module","1":"py:method","2":"py:class"},titles:["python-transparencydata&#8217;s documentation","Transparency Data API","Influence Explorer API"],objnames:{"0":"Python module","1":"Python method","2":"Python class"},filenames:["index","transparencydata","influenceexplorer"]})
+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&#8217;s documentation","Transparency Data API","Influence Explorer API"],objnames:{"0":"Python module","1":"Python method","2":"Python class"},filenames:["index","transparencydata","influenceexplorer"]})
View
16 docs/_build/html/transparencydata.html
@@ -53,16 +53,16 @@
<div class="section" id="transparency-data-api">
<h1>Transparency Data API<a class="headerlink" href="#transparency-data-api" title="Permalink to this headline">¶</a></h1>
-</div>
<div class="section" id="usage">
-<h1>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h1>
+<h2>Usage<a class="headerlink" href="#usage" title="Permalink to this headline">¶</a></h2>
<p>The TransparencyData class is constructed with your API key as an initialization parameter:</p>
<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span> <span class="nn">transparencydata</span> <span class="kn">import</span> <span class="n">TransparencyData</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">td</span> <span class="o">=</span> <span class="n">TransparencyData</span><span class="p">(</span><span class="o">&lt;</span><span class="n">your</span><span class="o">-</span><span class="n">api</span><span class="o">-</span><span class="n">key</span><span class="o">&gt;</span><span class="p">)</span>
</pre></div>
</div>
<p>If you do not have an API key visit <a class="reference external" href="http://services.sunlightlabs.com/api/">http://services.sunlightlabs.com/api/</a> to
register for one.</p>
+</div>
<div class="section" id="parameter-operators">
<h2>Parameter Operators<a class="headerlink" href="#parameter-operators" title="Permalink to this headline">¶</a></h2>
<p>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.</p>
@@ -132,11 +132,11 @@
<div class="section" id="federal-grants">
<h2>Federal Grants<a class="headerlink" href="#federal-grants" title="Permalink to this headline">¶</a></h2>
<p>To find all grants made by the NEA in 2010:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">grants</span><span class="p">(</span><span class="n">agency_ft</span><span class="o">=</span><span class="s">&#39;national endowment for the arts&#39;</span><span class="p">,</span> <span class="n">fiscal_year</span><span class="o">=</span><span class="s">&#39;2010&#39;</span><span class="p">)</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">td</span><span class="o">.</span><span class="n">grants</span><span class="p">(</span><span class="n">agency_ft</span><span class="o">=</span><span class="s">&#39;national endowment for the arts&#39;</span><span class="p">,</span> <span class="n">fiscal_year</span><span class="o">=</span><span class="s">&#39;2010&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p>A list of valid grant parameters can be accessed programmatically:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">grants</span><span class="o">.</span><span class="n">parameters</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">td</span><span class="o">.</span><span class="n">grants</span><span class="o">.</span><span class="n">parameters</span>
</pre></div>
</div>
<p>Parameter documentation: <a class="reference external" href="http://transparencydata.com/api/grants/">http://transparencydata.com/api/grants/</a></p>
@@ -145,11 +145,11 @@
<div class="section" id="federal-contracts">
<h2>Federal Contracts<a class="headerlink" href="#federal-contracts" title="Permalink to this headline">¶</a></h2>
<p>To find all federal contracts issued to Bank of America:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">contracts</span><span class="p">(</span><span class="n">vendor_name</span><span class="o">=</span><span class="s">&#39;bank of america&#39;</span><span class="p">)</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">td</span><span class="o">.</span><span class="n">contracts</span><span class="p">(</span><span class="n">vendor_name</span><span class="o">=</span><span class="s">&#39;bank of america&#39;</span><span class="p">)</span>
</pre></div>
</div>
<p>A list of valid contract parameters can be accessed programmatically:</p>
-<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span><span class="o">.</span><span class="n">contracts</span><span class="o">.</span><span class="n">parameters</span>
+<div class="highlight-python"><div class="highlight"><pre><span class="gp">&gt;&gt;&gt; </span><span class="n">td</span><span class="o">.</span><span class="n">contracts</span><span class="o">.</span><span class="n">parameters</span>
</pre></div>
</div>
<p>Parameter documentation: <a class="reference external" href="http://transparencydata.com/api/contracts">http://transparencydata.com/api/contracts</a></p>
@@ -165,8 +165,8 @@
<div class="sphinxsidebarwrapper">
<h3><a href="index.html">Table Of Contents</a></h3>
<ul>
-<li><a class="reference internal" href="#">Transparency Data API</a></li>
-<li><a class="reference internal" href="#usage">Usage</a><ul>
+<li><a class="reference internal" href="#">Transparency Data API</a><ul>
+<li><a class="reference internal" href="#usage">Usage</a></li>
<li><a class="reference internal" href="#parameter-operators">Parameter Operators</a></li>
<li><a class="reference internal" href="#campaign-contributions">Campaign Contributions</a></li>
<li><a class="reference internal" href="#lobbying">Lobbying</a></li>
View
17 docs/influenceexplorer.rst
@@ -1,18 +1,35 @@
Influence Explorer API
======================
+
.. automodule:: influenceexplorer
.. autoclass:: influenceexplorer.InfluenceExplorer
+
+----------------------
+General Entity Methods
+----------------------
.. autoclass:: influenceexplorer.Entities()
:members:
+------------------
+Politician Methods
+------------------
+
.. autoclass:: influenceexplorer.Politician()
:members:
+--------------------
+Organization Methods
+--------------------
+
.. autoclass:: influenceexplorer.Organization()
:members:
+------------------
+Individual Methods
+------------------
+
.. autoclass:: influenceexplorer.Individual()
:members:
View
4 docs/transparencydata.rst
@@ -1,9 +1,9 @@
Transparency Data API
=====================
+-----
Usage
-=====
-
+-----
The TransparencyData class is constructed with your API key as an initialization parameter:

0 comments on commit 425cbcf

Please sign in to comment.