registry module¶
-
registry.datasets(data='all', type=None, uuid=None, query=None, id=None, limit=100, start=None, **kwargs)¶ Search for datasets and dataset metadata.
Parameters: - data – [str] The type of data to get. Default: ‘all’
- type – [str] Type of dataset, options include ‘OCCURRENCE’, etc.
- uuid – [str] UUID of the data node provider. This must be specified if data is anything other than ‘all’.
- query – [str] Query term(s). Only used when data = ‘all’
- id – [int] A metadata document id.
References http://www.gbif.org/developer/registry#datasets
Usage:
from pygbif import registry registry.datasets(limit=5) registry.datasets(type="OCCURRENCE") registry.datasets(uuid="a6998220-7e3a-485d-9cd6-73076bd85657") registry.datasets(data='contact', uuid="a6998220-7e3a-485d-9cd6-73076bd85657") registry.datasets(data='metadata', uuid="a6998220-7e3a-485d-9cd6-73076bd85657") registry.datasets(data='metadata', uuid="a6998220-7e3a-485d-9cd6-73076bd85657", id=598) registry.datasets(data=['deleted','duplicate']) registry.datasets(data=['deleted','duplicate'], limit=1)
-
registry.dataset_metrics(uuid, **kwargs)¶ Get details on a GBIF dataset.
Parameters: uuid – [str] One or more dataset UUIDs. See examples. References: http://www.gbif.org/developer/registry#datasetMetrics
Usage:
from pygbif import registry registry.dataset_metrics(uuid='3f8a1297-3259-4700-91fc-acc4170b27ce') registry.dataset_metrics(uuid='66dd0960-2d7d-46ee-a491-87b9adcfe7b1') registry.dataset_metrics(uuid=['3f8a1297-3259-4700-91fc-acc4170b27ce', '66dd0960-2d7d-46ee-a491-87b9adcfe7b1'])
-
registry.installations(data='all', uuid=None, query=None, identifier=None, identifierType=None, limit=100, start=None, **kwargs)¶ Installations metadata.
Parameters: - data – [str] The type of data to get. Default is all data. If not ‘all’, then one or more of ‘contact’, ‘endpoint’, ‘dataset’, ‘comment’, ‘deleted’, ‘nonPublishing’.
- uuid – [str] UUID of the data node provider. This must be specified if data is anything other than ‘all’.
- query – [str] Query nodes. Only used when data=’all’. Ignored otherwise.
References: http://www.gbif.org/developer/registry#installations
Usage:
from pygbif import registry registry.installations(limit=5) registry.installations(query="france") registry.installations(uuid="b77901f9-d9b0-47fa-94e0-dd96450aa2b4") registry.installations(data='contact', uuid="b77901f9-d9b0-47fa-94e0-dd96450aa2b4") registry.installations(data='contact', uuid="2e029a0c-87af-42e6-87d7-f38a50b78201") registry.installations(data='endpoint', uuid="b77901f9-d9b0-47fa-94e0-dd96450aa2b4") registry.installations(data='dataset', uuid="b77901f9-d9b0-47fa-94e0-dd96450aa2b4") registry.installations(data='deleted') registry.installations(data='deleted', limit=2) registry.installations(data=['deleted','nonPublishing'], limit=2) registry.installations(identifierType='DOI', limit=2)
-
registry.networks(data='all', uuid=None, query=None, identifier=None, identifierType=None, limit=100, start=None, **kwargs)¶ Networks metadata.
Parameters: - data – [str] The type of data to get. Default: ‘all’
- uuid – [str] UUID of the data network provider. This must be specified if data is anything other than ‘all’.
- query – [str] Query networks. Only used when data = ‘all’. Ignored otherwise.
References: http://www.gbif.org/developer/registry#networks
Returns: A dict Usage:
from pygbif import registry registry.networks(limit=5) registry.networks(uuid='16ab5405-6c94-4189-ac71-16ca3b753df7') registry.networks(data='endpoint', uuid='16ab5405-6c94-4189-ac71-16ca3b753df7')
-
registry.nodes(data='all', uuid=None, query=None, identifier=None, identifierType=None, limit=100, start=None, isocode=None, **kwargs)¶ Nodes metadata.
Parameters: - data – [str] The type of data to get. Default: ‘all’
- uuid – [str] UUID of the data node provider. This must be specified if data is anything other than ‘all’.
- query – [str] Query nodes. Only used when data = ‘all’
- isocode – [str] A 2 letter country code. Only used if data = ‘country’.
References http://www.gbif.org/developer/registry#nodes
Usage:
from pygbif import registry registry.nodes(limit=5) registry.nodes(uuid="1193638d-32d1-43f0-a855-8727c94299d8") registry.nodes(data='identifier', uuid="03e816b3-8f58-49ae-bc12-4e18b358d6d9") registry.nodes(data=['identifier','organization','comment'], uuid="03e816b3-8f58-49ae-bc12-4e18b358d6d9") uuids = ["8cb55387-7802-40e8-86d6-d357a583c596","02c40d2a-1cba-4633-90b7-e36e5e97aba8", "7a17efec-0a6a-424c-b743-f715852c3c1f","b797ce0f-47e6-4231-b048-6b62ca3b0f55", "1193638d-32d1-43f0-a855-8727c94299d8","d3499f89-5bc0-4454-8cdb-60bead228a6d", "cdc9736d-5ff7-4ece-9959-3c744360cdb3","a8b16421-d80b-4ef3-8f22-098b01a89255", "8df8d012-8e64-4c8a-886e-521a3bdfa623","b35cf8f1-748d-467a-adca-4f9170f20a4e", "03e816b3-8f58-49ae-bc12-4e18b358d6d9","073d1223-70b1-4433-bb21-dd70afe3053b", "07dfe2f9-5116-4922-9a8a-3e0912276a72","086f5148-c0a8-469b-84cc-cce5342f9242", "0909d601-bda2-42df-9e63-a6d51847ebce","0e0181bf-9c78-4676-bdc3-54765e661bb8", "109aea14-c252-4a85-96e2-f5f4d5d088f4","169eb292-376b-4cc6-8e31-9c2c432de0ad", "1e789bc9-79fc-4e60-a49e-89dfc45a7188","1f94b3ca-9345-4d65-afe2-4bace93aa0fe"] [ registry.nodes(data='identifier', uuid=x) for x in uuids ]