fix #31 - added spellcheck param to optionally spell check full text …

…searches

updated changelog and docs

Changelog.rst

@@ -3,12 +3,9 @@ Changelog
 
 0.1.5.4 (2016-10-01)
 --------------------
-- Added many new occurrence search parameters, including
-	`repatriated`, `kingdomKey`, `phylumKey`, `classKey`,
-	`orderKey`, `familyKey`, `genusKey`, `subgenusKey`,
-	`establishmentMeans`, `facet`, `facetMincount`,
-	`facetMultiselect`, and support for facet paging via
-	`**kwargs`
+- Added many new `occurrence.search` parameters, including `repatriated`, `kingdomKey`, `phylumKey`, `classKey`, `orderKey`, `familyKey`, `genusKey`, `subgenusKey`, `establishmentMeans`, `facet`, `facetMincount`, `facetMultiselect`, and support for facet paging via	`**kwargs` (#30) (#34)
+- Fixes to `**kwargs` in `occurrence.search` so that facet parameters can be parsed correctly and `requests` GET	request options are collected correctly (#36)
+- Added `spellCheck` parameter to `occurrence.search` that goes along with the `q` parameter to optionally spell check full text searches (#31)
 
 0.1.4 (2016-06-04)
 --------------------

docs/_build/html/_modules/pygbif/occurrences/search.html

@@ -133,22 +133,25 @@ <h1>Source code for pygbif.occurrences.search</h1><div class="highlight"><pre>
 <span></span><span class="kn">import</span> <span class="nn">re</span>
 <span class="kn">from</span> <span class="nn">..gbifutils</span> <span class="kn">import</span> <span class="o">*</span>
 
-<span class="k">def</span> <span class="nf">search</span><span class="p">(</span><span class="n">taxonKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">repatriated</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">kingdomKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">phylumKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
-    <span class="n">classKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">orderKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">familyKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">genusKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">subgenusKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
-    <span class="n">scientificName</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">country</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
-    <span class="n">publishingCountry</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">hasCoordinate</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">typeStatus</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+<span class="k">def</span> <span class="nf">search</span><span class="p">(</span><span class="n">taxonKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">repatriated</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+    <span class="n">kingdomKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">phylumKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">classKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">orderKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+    <span class="n">familyKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">genusKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">subgenusKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">scientificName</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+    <span class="n">country</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">publishingCountry</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">hasCoordinate</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">typeStatus</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
     <span class="n">recordNumber</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">lastInterpreted</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">continent</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
     <span class="n">geometry</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">recordedBy</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">basisOfRecord</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">datasetKey</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
     <span class="n">eventDate</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">catalogNumber</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">year</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">month</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
     <span class="n">decimalLatitude</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">decimalLongitude</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">elevation</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
     <span class="n">depth</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">institutionCode</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">collectionCode</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
-    <span class="n">hasGeospatialIssue</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">issue</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">mediatype</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
+    <span class="n">hasGeospatialIssue</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">issue</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">spellCheck</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">mediatype</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
     <span class="n">limit</span><span class="o">=</span><span class="mi">300</span><span class="p">,</span> <span class="n">offset</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">establishmentMeans</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span>
     <span class="n">facet</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">facetMincount</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">facetMultiselect</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
     <span class="sd">&#39;&#39;&#39;</span>
 <span class="sd">    Search GBIF occurrences</span>
 
 <span class="sd">    :param taxonKey: [int] A GBIF occurrence identifier</span>
+<span class="sd">    :param q: [str] Simple search parameter. The value for this parameter can be a simple word or a phrase.</span>
+<span class="sd">    :param spellCheck: [bool] If ``True`` ask GBIF to check your spelling of the value passed to the ``search`` parameter.</span>
+<span class="sd">        IMPORTANT: This only checks the input to the ``search`` parameter, and no others. Default: ``False``</span>
 <span class="sd">    :param repatriated: [str] Searches for records whose publishing country is different to the country where the record was recorded in</span>
 <span class="sd">    :param kingdomKey: [int] Kingdom classification key</span>
 <span class="sd">    :param phylumKey: [int] Phylum classification key</span>
@@ -278,7 +281,15 @@ <h1>Source code for pygbif.occurrences.search</h1><div class="highlight"><pre>
 <span class="sd">        [ x[&#39;results&#39;][0][&#39;speciesKey&#39;] for x in out ]</span>
 
 <span class="sd">        # Search - q parameter</span>
-<span class="sd">        occurrences.search(q=&quot;kingfisher&quot;, limit=2)</span>
+<span class="sd">        occurrences.search(q = &quot;kingfisher&quot;, limit=20)</span>
+<span class="sd">        ## spell check - only works with the `search` parameter</span>
+<span class="sd">        ### spelled correctly - same result as above call</span>
+<span class="sd">        occurrences.search(q = &quot;kingfisher&quot;, limit=20, spellCheck = True)</span>
+<span class="sd">        ### spelled incorrectly - stops with suggested spelling</span>
+<span class="sd">        occurrences.search(q = &quot;kajsdkla&quot;, limit=20, spellCheck = True)</span>
+<span class="sd">        ### spelled incorrectly - stops with many suggested spellings</span>
+<span class="sd">        ###   and number of results for each</span>
+<span class="sd">        occurrences.search(q = &quot;helir&quot;, limit=20, spellCheck = True)</span>
 
 <span class="sd">        # Search on latitidue and longitude</span>
 <span class="sd">        occurrences.search(decimalLatitude=50, decimalLongitude=10, limit=2)</span>
@@ -441,8 +452,8 @@ <h1>Source code for pygbif.occurrences.search</h1><div class="highlight"><pre>
         <span class="s1">&#39;decimalLatitude&#39;</span><span class="p">:</span> <span class="n">decimalLatitude</span><span class="p">,</span> <span class="s1">&#39;decimalLongitude&#39;</span><span class="p">:</span> <span class="n">decimalLongitude</span><span class="p">,</span>
         <span class="s1">&#39;elevation&#39;</span><span class="p">:</span> <span class="n">elevation</span><span class="p">,</span> <span class="s1">&#39;depth&#39;</span><span class="p">:</span> <span class="n">depth</span><span class="p">,</span> <span class="s1">&#39;institutionCode&#39;</span><span class="p">:</span> <span class="n">institutionCode</span><span class="p">,</span>
         <span class="s1">&#39;collectionCode&#39;</span><span class="p">:</span> <span class="n">collectionCode</span><span class="p">,</span> <span class="s1">&#39;hasGeospatialIssue&#39;</span><span class="p">:</span> <span class="n">hasGeospatialIssue</span><span class="p">,</span>
-        <span class="s1">&#39;issue&#39;</span><span class="p">:</span> <span class="n">issue</span><span class="p">,</span> <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">q</span><span class="p">,</span> <span class="s1">&#39;mediatype&#39;</span><span class="p">:</span> <span class="n">mediatype</span><span class="p">,</span> <span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span>
-        <span class="s1">&#39;offset&#39;</span><span class="p">:</span> <span class="n">offset</span><span class="p">,</span> <span class="s1">&#39;establishmentMeans&#39;</span><span class="p">:</span> <span class="n">establishmentMeans</span><span class="p">,</span>
+        <span class="s1">&#39;issue&#39;</span><span class="p">:</span> <span class="n">issue</span><span class="p">,</span> <span class="s1">&#39;q&#39;</span><span class="p">:</span> <span class="n">q</span><span class="p">,</span> <span class="s1">&#39;spellCheck&#39;</span><span class="p">:</span> <span class="n">spellCheck</span><span class="p">,</span> <span class="s1">&#39;mediatype&#39;</span><span class="p">:</span> <span class="n">mediatype</span><span class="p">,</span>
+        <span class="s1">&#39;limit&#39;</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span> <span class="s1">&#39;offset&#39;</span><span class="p">:</span> <span class="n">offset</span><span class="p">,</span> <span class="s1">&#39;establishmentMeans&#39;</span><span class="p">:</span> <span class="n">establishmentMeans</span><span class="p">,</span>
         <span class="s1">&#39;facetMincount&#39;</span><span class="p">:</span> <span class="n">facetMincount</span><span class="p">,</span> <span class="s1">&#39;facet&#39;</span><span class="p">:</span> <span class="n">facet</span><span class="p">,</span>
         <span class="s1">&#39;facetMultiselect&#39;</span><span class="p">:</span> <span class="n">facetMultiselect</span><span class="p">}</span>
     <span class="n">gbif_kwargs</span> <span class="o">=</span> <span class="p">{</span><span class="n">key</span><span class="p">:</span> <span class="n">kwargs</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="k">for</span> <span class="n">key</span> <span class="ow">in</span> <span class="n">kwargs</span> <span class="k">if</span> <span class="n">key</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">requests_argset</span><span class="p">}</span>

docs/_build/html/changelog_link.html

@@ -86,9 +86,9 @@
 <li class="toctree-l1"><a class="reference internal" href="species.html">species module</a></li>
 <li class="toctree-l1 current"><a class="current reference internal" href="#">Changelog</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="#id1">0.1.5.4 (2016-10-01)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id2">0.1.4 (2016-06-04)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id3">0.1.1 (2015-11-03)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="#id4">0.1.0 (2015-11-02)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id4">0.1.4 (2016-06-04)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id5">0.1.1 (2015-11-03)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="#id6">0.1.0 (2015-11-02)</a></li>
 </ul>
 </li>
 </ul>
@@ -139,21 +139,14 @@
 <h1>Changelog<a class="headerlink" href="#changelog" title="Permalink to this headline">¶</a></h1>
 <div class="section" id="id1">
 <h2>0.1.5.4 (2016-10-01)<a class="headerlink" href="#id1" title="Permalink to this headline">¶</a></h2>
-<ul>
-<li><dl class="first docutils">
-<dt>Added many new occurrence search parameters, including</dt>
-<dd><p class="first last"><cite>repatriated</cite>, <cite>kingdomKey</cite>, <cite>phylumKey</cite>, <cite>classKey</cite>,
-<cite>orderKey</cite>, <cite>familyKey</cite>, <cite>genusKey</cite>, <cite>subgenusKey</cite>,
-<cite>establishmentMeans</cite>, <cite>facet</cite>, <cite>facetMincount</cite>,
-<cite>facetMultiselect</cite>, and support for facet paging via
-<cite>**kwargs</cite></p>
-</dd>
-</dl>
-</li>
+<ul class="simple">
+<li>Added many new <cite>occurrence.search</cite> parameters, including <cite>repatriated</cite>, <cite>kingdomKey</cite>, <cite>phylumKey</cite>, <cite>classKey</cite>, <cite>orderKey</cite>, <cite>familyKey</cite>, <cite>genusKey</cite>, <cite>subgenusKey</cite>, <cite>establishmentMeans</cite>, <cite>facet</cite>, <cite>facetMincount</cite>, <cite>facetMultiselect</cite>, and support for facet paging via       <cite>**kwargs</cite> (#30) (#34)</li>
+<li>Fixes to <a href="#id2"><span class="problematic" id="id3">**</span></a>kwargs in <cite>occurrence.search</cite> so that facet parameters can be parsed correctly and <cite>requests</cite> GET  request options are collected correctly (#36)</li>
+<li>Added <cite>spellCheck</cite> parameter to <cite>occurrence.search</cite> that goes along with the <cite>q</cite> parameter to optionally spell check full text searches (#31)</li>
 </ul>
 </div>
-<div class="section" id="id2">
-<h2>0.1.4 (2016-06-04)<a class="headerlink" href="#id2" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="id4">
+<h2>0.1.4 (2016-06-04)<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li>Added variable types throughout docs</li>
 <li>Changed default <cite>limit</cite> value to 300 for <cite>occurrences.search</cite> method</li>
@@ -168,14 +161,14 @@ <h2>0.1.4 (2016-06-04)<a class="headerlink" href="#id2" title="Permalink to this
 <li>Improved documentation a lot, autodoc methods now</li>
 </ul>
 </div>
-<div class="section" id="id3">
-<h2>0.1.1 (2015-11-03)<a class="headerlink" href="#id3" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="id5">
+<h2>0.1.1 (2015-11-03)<a class="headerlink" href="#id5" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li>Fixed distribution for pypi</li>
 </ul>
 </div>
-<div class="section" id="id4">
-<h2>0.1.0 (2015-11-02)<a class="headerlink" href="#id4" title="Permalink to this headline">¶</a></h2>
+<div class="section" id="id6">
+<h2>0.1.0 (2015-11-02)<a class="headerlink" href="#id6" title="Permalink to this headline">¶</a></h2>
 <ul class="simple">
 <li>First release</li>
 </ul>

docs/_build/html/index.html

@@ -203,9 +203,9 @@ <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this head
 <li class="toctree-l1"><a class="reference internal" href="species.html">species module</a></li>
 <li class="toctree-l1"><a class="reference internal" href="changelog_link.html">Changelog</a><ul>
 <li class="toctree-l2"><a class="reference internal" href="changelog_link.html#id1">0.1.5.4 (2016-10-01)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="changelog_link.html#id2">0.1.4 (2016-06-04)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="changelog_link.html#id3">0.1.1 (2015-11-03)</a></li>
-<li class="toctree-l2"><a class="reference internal" href="changelog_link.html#id4">0.1.0 (2015-11-02)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changelog_link.html#id4">0.1.4 (2016-06-04)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changelog_link.html#id5">0.1.1 (2015-11-03)</a></li>
+<li class="toctree-l2"><a class="reference internal" href="changelog_link.html#id6">0.1.0 (2015-11-02)</a></li>
 </ul>
 </li>
 </ul>