-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
17 changed files
with
374 additions
and
7 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
253 changes: 253 additions & 0 deletions
253
docs/_build/html/_modules/pygbif/registry/organizations.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,253 @@ | ||
|
||
|
||
<!DOCTYPE html> | ||
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> | ||
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> | ||
<head> | ||
<meta charset="utf-8"> | ||
|
||
<meta name="viewport" content="width=device-width, initial-scale=1.0"> | ||
|
||
<title>pygbif.registry.organizations — pygbif 0.1.6.0 documentation</title> | ||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../../../_static/css/theme.css" type="text/css" /> | ||
|
||
|
||
|
||
|
||
|
||
<link rel="top" title="pygbif 0.1.6.0 documentation" href="../../../index.html"/> | ||
<link rel="up" title="Module code" href="../../index.html"/> | ||
|
||
|
||
<script src="../../../_static/js/modernizr.min.js"></script> | ||
|
||
</head> | ||
|
||
<body class="wy-body-for-nav" role="document"> | ||
|
||
<div class="wy-grid-for-nav"> | ||
|
||
|
||
<nav data-toggle="wy-nav-shift" class="wy-nav-side"> | ||
<div class="wy-side-scroll"> | ||
<div class="wy-side-nav-search"> | ||
|
||
|
||
|
||
<a href="../../../index.html" class="icon icon-home"> pygbif | ||
|
||
|
||
|
||
</a> | ||
|
||
|
||
|
||
|
||
<div class="version"> | ||
0.1.6.0 | ||
</div> | ||
|
||
|
||
|
||
|
||
<div role="search"> | ||
<form id="rtd-search-form" class="wy-form" action="../../../search.html" method="get"> | ||
<input type="text" name="q" placeholder="Search docs" /> | ||
<input type="hidden" name="check_keywords" value="yes" /> | ||
<input type="hidden" name="area" value="default" /> | ||
</form> | ||
</div> | ||
|
||
|
||
</div> | ||
|
||
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> | ||
|
||
|
||
|
||
<ul> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../occurrences.html">occurrences module</a></li> | ||
<li class="toctree-l1"><a class="reference internal" href="../../../registry.html">registry module</a></li> | ||
<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></li> | ||
</ul> | ||
|
||
|
||
|
||
</div> | ||
</div> | ||
</nav> | ||
|
||
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> | ||
|
||
|
||
<nav class="wy-nav-top" role="navigation" aria-label="top navigation"> | ||
<i data-toggle="wy-nav-top" class="fa fa-bars"></i> | ||
<a href="../../../index.html">pygbif</a> | ||
</nav> | ||
|
||
|
||
|
||
<div class="wy-nav-content"> | ||
<div class="rst-content"> | ||
|
||
|
||
|
||
|
||
|
||
|
||
<div role="navigation" aria-label="breadcrumbs navigation"> | ||
<ul class="wy-breadcrumbs"> | ||
<li><a href="../../../index.html">Docs</a> »</li> | ||
|
||
<li><a href="../../index.html">Module code</a> »</li> | ||
|
||
<li>pygbif.registry.organizations</li> | ||
<li class="wy-breadcrumbs-aside"> | ||
|
||
|
||
|
||
</li> | ||
</ul> | ||
<hr/> | ||
</div> | ||
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> | ||
<div itemprop="articleBody"> | ||
|
||
<h1>Source code for pygbif.registry.organizations</h1><div class="highlight"><pre> | ||
<span></span><span class="kn">from</span> <span class="nn">..gbifutils</span> <span class="kn">import</span> <span class="o">*</span> | ||
<span class="kn">from</span> <span class="nn">.registry_utils</span> <span class="kn">import</span> <span class="o">*</span> | ||
|
||
<span class="k">def</span> <span class="nf">organizations</span><span class="p">(</span><span class="n">data</span> <span class="o">=</span> <span class="s1">'all'</span><span class="p">,</span> <span class="n">uuid</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">query</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> <span class="n">identifier</span> <span class="o">=</span> <span class="bp">None</span><span class="p">,</span> | ||
<span class="n">identifierType</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">100</span><span class="p">,</span> <span class="n">start</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">'''</span> | ||
<span class="sd"> organizations metadata.</span> | ||
|
||
<span class="sd"> :param data: [str] The type of data to get. Default is all data. If not ``all``, then one</span> | ||
<span class="sd"> or more of ``contact``, ``endpoint``, ``identifier``, ``tag``, ``machineTag``,</span> | ||
<span class="sd"> ``comment``, ``hostedDataset``, ``ownedDataset``, ``deleted``, ``pending``,</span> | ||
<span class="sd"> ``nonPublishing``.</span> | ||
<span class="sd"> :param uuid: [str] UUID of the data node provider. This must be specified if data</span> | ||
<span class="sd"> is anything other than ``all``.</span> | ||
<span class="sd"> :param query: [str] Query nodes. Only used when ``data='all'``. Ignored otherwise.</span> | ||
|
||
<span class="sd"> References: http://www.gbif.org/developer/registry#organizations</span> | ||
|
||
<span class="sd"> Usage::</span> | ||
|
||
<span class="sd"> from pygbif import registry</span> | ||
<span class="sd"> registry.organizations(limit=5)</span> | ||
<span class="sd"> registry.organizations(query="france")</span> | ||
<span class="sd"> registry.organizations(uuid="e2e717bf-551a-4917-bdc9-4fa0f342c530")</span> | ||
<span class="sd"> registry.organizations(data='contact', uuid="e2e717bf-551a-4917-bdc9-4fa0f342c530")</span> | ||
<span class="sd"> registry.organizations(data='endpoint', uuid="e2e717bf-551a-4917-bdc9-4fa0f342c530")</span> | ||
<span class="sd"> registry.organizations(data='deleted')</span> | ||
<span class="sd"> registry.organizations(data='deleted', limit=2)</span> | ||
<span class="sd"> registry.organizations(data=['deleted','nonPublishing'], limit=2)</span> | ||
<span class="sd"> registry.organizations(identifierType='DOI', limit=2)</span> | ||
<span class="sd"> '''</span> | ||
<span class="n">args</span> <span class="o">=</span> <span class="p">{</span><span class="s1">'q'</span><span class="p">:</span> <span class="n">query</span><span class="p">,</span> <span class="s1">'limit'</span><span class="p">:</span> <span class="n">limit</span><span class="p">,</span> <span class="s1">'offset'</span><span class="p">:</span> <span class="n">start</span><span class="p">}</span> | ||
<span class="n">data_choices</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'all'</span><span class="p">,</span> <span class="s1">'contact'</span><span class="p">,</span> <span class="s1">'endpoint'</span><span class="p">,</span> | ||
<span class="s1">'identifier'</span><span class="p">,</span> <span class="s1">'tag'</span><span class="p">,</span> <span class="s1">'machineTag'</span><span class="p">,</span> <span class="s1">'comment'</span><span class="p">,</span> <span class="s1">'hostedDataset'</span><span class="p">,</span> | ||
<span class="s1">'ownedDataset'</span><span class="p">,</span> <span class="s1">'deleted'</span><span class="p">,</span> <span class="s1">'pending'</span><span class="p">,</span> <span class="s1">'nonPublishing'</span><span class="p">]</span> | ||
<span class="n">check_data</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">data_choices</span><span class="p">)</span> | ||
|
||
<span class="k">def</span> <span class="nf">getdata</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span> | ||
<span class="n">nouuid</span> <span class="o">=</span> <span class="p">[</span><span class="s1">'all'</span><span class="p">,</span> <span class="s1">'deleted'</span><span class="p">,</span> <span class="s1">'pending'</span><span class="p">,</span> <span class="s1">'nonPublishing'</span><span class="p">]</span> | ||
<span class="k">if</span> <span class="n">x</span> <span class="ow">not</span> <span class="ow">in</span> <span class="n">nouuid</span> <span class="ow">and</span> <span class="n">uuid</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span> | ||
<span class="n">stop</span><span class="p">(</span><span class="s1">'You must specify a uuid if data does not equal "all" and data does not equal one of '</span> <span class="o">+</span> <span class="s1">', '</span><span class="o">.</span><span class="n">join</span><span class="p">(</span><span class="n">nouuid</span><span class="p">))</span> | ||
|
||
<span class="k">if</span> <span class="n">uuid</span> <span class="ow">is</span> <span class="bp">None</span><span class="p">:</span> | ||
<span class="k">if</span> <span class="n">x</span> <span class="ow">is</span> <span class="s1">'all'</span><span class="p">:</span> | ||
<span class="n">url</span> <span class="o">=</span> <span class="n">gbif_baseurl</span> <span class="o">+</span> <span class="s1">'organization'</span> | ||
<span class="k">else</span><span class="p">:</span> | ||
<span class="n">url</span> <span class="o">=</span> <span class="n">gbif_baseurl</span> <span class="o">+</span> <span class="s1">'organization/'</span> <span class="o">+</span> <span class="n">x</span> | ||
<span class="k">else</span><span class="p">:</span> | ||
<span class="k">if</span> <span class="n">x</span> <span class="ow">is</span> <span class="s1">'all'</span><span class="p">:</span> | ||
<span class="n">url</span> <span class="o">=</span> <span class="n">gbif_baseurl</span> <span class="o">+</span> <span class="s1">'organization/'</span> <span class="o">+</span> <span class="n">uuid</span> | ||
<span class="k">else</span><span class="p">:</span> | ||
<span class="n">url</span> <span class="o">=</span> <span class="n">gbif_baseurl</span> <span class="o">+</span> <span class="s1">'organization/'</span> <span class="o">+</span> <span class="n">uuid</span> <span class="o">+</span> <span class="s1">'/'</span> <span class="o">+</span> <span class="n">x</span> | ||
|
||
<span class="n">res</span> <span class="o">=</span> <span class="n">gbif_GET</span><span class="p">(</span><span class="n">url</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> | ||
<span class="k">return</span> <span class="p">{</span><span class="s1">'meta'</span><span class="p">:</span> <span class="n">get_meta</span><span class="p">(</span><span class="n">res</span><span class="p">),</span> <span class="s1">'data'</span><span class="p">:</span> <span class="n">parse_results</span><span class="p">(</span><span class="n">res</span><span class="p">,</span> <span class="n">uuid</span><span class="p">)}</span> | ||
|
||
<span class="k">if</span> <span class="n">len2</span><span class="p">(</span><span class="n">data</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span> | ||
<span class="k">return</span> <span class="n">getdata</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> | ||
<span class="k">else</span><span class="p">:</span> | ||
<span class="k">return</span> <span class="p">[</span><span class="n">getdata</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">uuid</span><span class="p">,</span> <span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span> <span class="k">for</span> <span class="n">x</span> <span class="ow">in</span> <span class="n">data</span><span class="p">]</span> | ||
</pre></div> | ||
|
||
</div> | ||
</div> | ||
<footer> | ||
|
||
|
||
<hr/> | ||
|
||
<div role="contentinfo"> | ||
<p> | ||
© Copyright 2016, Scott Chamberlain. | ||
|
||
</p> | ||
</div> | ||
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. | ||
|
||
</footer> | ||
|
||
</div> | ||
</div> | ||
|
||
</section> | ||
|
||
</div> | ||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript"> | ||
var DOCUMENTATION_OPTIONS = { | ||
URL_ROOT:'../../../', | ||
VERSION:'0.1.6.0', | ||
COLLAPSE_INDEX:false, | ||
FILE_SUFFIX:'.html', | ||
HAS_SOURCE: true | ||
}; | ||
</script> | ||
<script type="text/javascript" src="../../../_static/jquery.js"></script> | ||
<script type="text/javascript" src="../../../_static/underscore.js"></script> | ||
<script type="text/javascript" src="../../../_static/doctools.js"></script> | ||
|
||
|
||
|
||
|
||
|
||
<script type="text/javascript" src="../../../_static/js/theme.js"></script> | ||
|
||
|
||
|
||
|
||
<script type="text/javascript"> | ||
jQuery(function () { | ||
SphinxRtdTheme.StickyNav.enable(); | ||
}); | ||
</script> | ||
|
||
|
||
</body> | ||
</html> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.