Skip to main content

LPSN API

New in v1.0.0: Better error handling and new method flex_search()

Using the LPSN API requires registration. Registration is free but the usage of LPSN data is only permitted when in compliance with the LPSN copyright. See the LPSN copyright notice for details.

For questions, requests and comments regarding the LPSN API, please use the LPSN contact form.

Please register here.

The Python package can be initialized using your login credentials:

import lpsn

client = lpsn.LpsnClient('name@mail.example', 'password')

# the prepare method fetches all LPSN-IDs matching your query
# and returns the number of IDs found
count = client.search(taxon_name='Sulfolobus', correct_name='yes')
print(count, 'entries found.')

# the retrieve method lets you iterate over all results
# and returns the full entry as dict
# Entries can be further filtered using a list of keys (e.g. ['keywords'])
for entry in client.retrieve():
    print(entry)

Example queries:

You can use IDs to query LPSN as described here. Note that when using the parameter id, all other parameters are ignored.

# Search by LPSN-IDs (either semicolon separated or as list):
query = {"id": 520424}
query = {"id": "520424;4948;17724"}
query = {"id": [520424, 4948, 17724]}

# run query
client.search(**query)

Or you can use all the advanced search parameters that are described here.

Note that dashes (-) are replaced by underscores when used as python parameters.

# Example looking for validly published names of species in the genus Escherichia that have risk group 1:
client.search(taxon_name='Escherichia', category='species', riskgroup='1', validly_published='yes')

# The same example using a Python dictionary:
query = {
    'taxon-name': 'Escherichia', 
    'category': 'species',
    'riskgroup': '1',
    'validly-published': 'yes'
}
client.search(**query)

The flexible search has been implemented in v1.0.0.

# Example looking for all entries with a basonym id that has been retreived by a previous fetch:
client.flex_search(search={"basonym_id":4370}, negate=False)
for entry in client.retrieve():
    print(entry)

Filtering

Results from the retrieve Method of both clients can be further filtered. The result contains a list of matched keyword dicts:

result = client.retrieve(filter=["full_name", "lpsn_taxonomic_status"])
print({k:v for x in result for k,v in x.items()})

The printed result will look like this:

{782310: [{'full_name': 'Sulfolobus acidocaldarius'},
          {'lpsn_taxonomic_status': 'correct name'}],
 782311: [{'full_name': 'Sulfolobus brierleyi'},
          {'lpsn_taxonomic_status': 'synonym'}],
 782312: [{'full_name': 'Sulfolobus hakonensis'},
          {'lpsn_taxonomic_status': 'synonym'}],
 782313: [{'full_name': 'Sulfolobus metallicus'},
          {'lpsn_taxonomic_status': 'synonym'}],
...

Known issues

This package depends on python-keycloak for authorization and login handling. However, python-keycloak seems to have issues with older versions of requests and urllib3. See the related issue on github. This might lead to the following error when trying to access the API:

AttributeError: 'Retry' object has no attribute 'allowed_methods'

You might be able to resolve this issue by updating the mentioned libraries, e.g. via pip:

pip install requests>=2.25.1 urllib3>=1.26.5

Metadata

Release files for lpsn 1.0.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for lpsn 1.0.0
File Size Uploaded Provenance Actions
lpsn-1.0.0.tar.gz 6.6 kB Without provenance Details for lpsn-1.0.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for lpsn 1.0.0
File Interpreter ABI Platform Actions
lpsn-1.0.0-py3-none-any.whl Python 3 none any Details for lpsn-1.0.0-py3-none-any.whl

Total release size: 13.3 kB

Release files / lpsn-1.0.0.tar.gz

Download URL lpsn-1.0.0.tar.gz
Size 6.6 kB
Tags Source
SHA-256 checksum
How to use checksums
d16c612f527b83819f16eadf564c4514b8f99426429b6a1d09275b6029c5e817
BLAKE2b-256 checksum
How to use checksums
e5a102dae8ba7ac464ec10f7048727e29f6702cec1c73efb40e9b852ecfe565b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.12.1

Release files / lpsn-1.0.0-py3-none-any.whl

Download URL lpsn-1.0.0-py3-none-any.whl
Size 6.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
87bfff41921626ee180a4470bb6e9140e95082e2902c31c2f7f4bd063280e648
BLAKE2b-256 checksum
How to use checksums
1caecde287d19bf5f788a6773e475baffddeb9efbaf23dc78854b400f9348f4f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.2 CPython/3.12.1

Security for lpsn 1.0.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page