Skip to main content

VFB_connect test_vfb-connect publish-to-pypi PyPI version DOI

test_notebooks Documentation Status

VFB_connect is a Python lib that wraps data/knowledgeBase query endpoints and returns DataFrame tables.

Available on PyPi:

pip install vfb_connect

Some examples:

# VFB connect object wraps connections and queries to public VFB servers.

from vfb_connect import vfb

# Get TermInfo for Types/Classes, DataSets and anatomical individuals.

vfb.term('FBbt_00003686')

vfb.terms(['Ito02013'])

vfb.terms(['VFB_00010001'])

# Get all terms relevant to a brain region (all parts and all overlapping cells. You can query by label, symbol, synonym, id or xref.

vfb.get_terms_by_region('fan-shaped body')

TermInfo returns a pandas DataFrame by default but can also return a dict summary or full VFBTerms.

For more examples see our Quick Guide Jupyter Notebook

Cached query results

Several queries — similar morphology, the neurons and neuron types in a region, parts, subtypes, lineage clones and innervating tracts — are answered from VFBquery's pre-computed results at https://api.virtualflybrain.org, the same source the Virtual Fly Brain website reads. Results and column names are unchanged; the query is simply not re-derived. If the service is unavailable, slow or returns an incomplete result, the original Neo4j/Owlery query runs instead, so nothing depends on it being up.

Results larger than one response (25,000 rows) are paged, with a progress bar — a whole neuropil can be hundreds of thousands of rows. vfb._load_limit truncates them, and any truncation is reported rather than silent.

vfb.query_counts(id) returns how many results every query on a term would give, in one request and without running any of them:

vfb.query_counts('FBbt_00003748')
# {'NeuronsSynaptic': 464, 'PartsOf': 28, 'ImagesNeurons': 226524, ...}

A count of -1 there means VFBquery could not count that query — not that it is empty.

Environment variables:

  • VFB_USE_CACHED_QUERIES=false — always run queries directly.
  • VFB_CACHED_QUERY_URL — point at a different VFBquery deployment.
  • VFB_CACHED_QUERY_MAX_ROWS — row ceiling before a result is truncated (default 250,000).

Methods that use it also take use_cached=True|False to override per call.

Metadata

Release files for vfb-connect 2.4.9

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

Source distribution (sdist)

Source distribution for vfb-connect 2.4.9
File Size Uploaded Provenance Actions
vfb_connect-2.4.9.tar.gz 49.5 MB With provenance Details for vfb_connect-2.4.9.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for vfb-connect 2.4.9
File Interpreter ABI Platform Actions
vfb_connect-2.4.9-py3-none-any.whl Python 3 none any Details for vfb_connect-2.4.9-py3-none-any.whl

Total release size: 58.9 MB

Release files / vfb_connect-2.4.9.tar.gz

Download URL vfb_connect-2.4.9.tar.gz
Size 49.5 MB
Tags Source
SHA-256 checksum
How to use checksums
f80f457c97d2de927cdfa251d33a2f84a0a1e47a3d5ef9efea0563f500af467e
BLAKE2b-256 checksum
How to use checksums
ea7a02828ede53dbea744a9ab286bbfecbfb5dc3a9ff111fea761d5bc59ba501
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

Release files / vfb_connect-2.4.9-py3-none-any.whl

Download URL vfb_connect-2.4.9-py3-none-any.whl
Size 9.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
62e84d96912222c55c93111684824e8a2a02fc1fa970dedcd56e09441f2a5ab5
BLAKE2b-256 checksum
How to use checksums
56dab5abf436adc980ca9bef78b19b6881fca39ca608e9d6fee68cea0e69e0ef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

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.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

Security for vfb-connect 2.4.9

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.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for vfb_connect-2.4.9.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 15, 2026.

Transparency log

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.

Release history Release notifications | RSS feed

This release

2.4.9 This release

2 release files Full provenance

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