Skip to main content

neuromorpho-api

Querying the neuromorpho.org database in Python with requests.

As of May 2024, the SSL key for neuromorpho.org has been updated, and the
workaround packaged here is no longer necessary!
The [requests](https://pypi.org/project/requests/) package can now be used
directly with the neuromorpho.org API.
This project will be archived, though the documentation will remain live and
updated to demonstrate programmatic access of neuromorpho data.

Quickstart

>>> import requests

>>> neuron_endpoint = "https://neuromorpho.org/api/neuron/"
>>> resp = requests.get(neuron_endpoint + "fields")
>>> resp.json()
{'Neuron Fields': ['neuron_id',
  'neuron_name',
  'archive',
  'age_scale',
  'gender',
  ...

See the tutorial for more detailed examples, including selecting neurons by attribute pattern matching and downloading SWC traces.


What is was this package?

The neuromorpho-api package provides a requests.Session instance with a custom SSLContext needed for interacting with neuromorpho.org.

Why can't I just use requests directly?

NOTE: should no longer be an issue as of 05-24

You may see something like the following:

>>> import requests
>>> requests.get("https://neuromorpho.org/api/neuron/id/1")
Traceback (most recent call last)
   ...
SSLError: HTTPSConnectionPool(host='neuromorpho.org', port=443): Max retries exceeded with url: /api/neuron/id/1 (Caused by SSLError(SSLError(1, '[SSL: DH_KEY_TOO_SMALL] dh key too small (_ssl.c:1006)')))

It appears the key provided by neuromorpho.org is incompatible with the default Python SSL cipher. This package works around this issue using Robin De Schepper's solution posted on Stack Overflow. At some point in the future, the neuromorpho certificate may (hopefully) be updated, at which point this package will be archived.

Future compatibility

The requestor provided by this package is intended as a temporary workaround for the current DH key issue with neuromorpho.org. If the neuromorpho.org certificate is updated, the requestor with the custom SSLContext will no longer be necessary, and users can switch to using requests directly. Therefore, the following import alias is recommended:

from neuromorpho-api import requestor as requests

With an updated certificate, the above can be changed to:

import requests

and all code that depends on requests.get should continue to work as expected.

Metadata

Release files for neuromorpho-api 0.2

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

Source distribution (sdist)

Source distribution for neuromorpho-api 0.2
File Size Uploaded Provenance Actions
neuromorpho_api-0.2.tar.gz 4.5 kB Without provenance Details for neuromorpho_api-0.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for neuromorpho-api 0.2
File Interpreter ABI Platform Actions
neuromorpho_api-0.2-py3-none-any.whl Python 3 none any Details for neuromorpho_api-0.2-py3-none-any.whl

Total release size: 9.7 kB

Release files / neuromorpho_api-0.2.tar.gz

Download URL neuromorpho_api-0.2.tar.gz
Size 4.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b9e7a76eba5cdc16ce55e6866f02739ff4f01324bf7759bcb05523f8d7eb7ac1
BLAKE2b-256 checksum
How to use checksums
efc3aba2abe714cd05b23ada0579335f3004fbe44e9e0f163cfa6a47074ae0b6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.3

Release files / neuromorpho_api-0.2-py3-none-any.whl

Download URL neuromorpho_api-0.2-py3-none-any.whl
Size 5.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
dbc81f2f90c46be423e3879eb888fa449716040f3f6cdc3ab750fefcedafc4c0
BLAKE2b-256 checksum
How to use checksums
44b54a97274f6fbee7ffcaf066a833d1b0b82d6f2f73f14ab1eede528262a24e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.3

Security for neuromorpho-api 0.2

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