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://v3-cached.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.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 vfb-connect 2.4.2
File Size Uploaded
vfb_connect-2.4.2.tar.gz 49.5 MB Details

Built distribution (wheel)

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

Total release size: 58.9 MB

Release files / vfb_connect-2.4.2.tar.gz

Download URL vfb_connect-2.4.2.tar.gz
Size 49.5 MB
Tags Source
SHA-256 checksum
How to use checksums
eb841bbfa2e997e1115d0a8760917f3ab7f2e24b4d6d9347b22024f009640388
BLAKE2b-256 checksum
How to use checksums
6b994819c7ba6fa218ce93b74c57a6d46f9b2d7bc581dfa3459553b3a4744e6a
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 Aug 21, 2026.

Transparency log

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

Download URL vfb_connect-2.4.2-py3-none-any.whl
Size 9.4 MB
Tags Python 3
SHA-256 checksum
How to use checksums
81be6250911379fd2695c2f1f9db40bbd20b541a675d9f7b1a1ff5130054e834
BLAKE2b-256 checksum
How to use checksums
e73c3217b4869bc12b73b00995e81d071b98cbd27ecd2d7b14bd4c67a5a963d5
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 Aug 21, 2026.

Transparency log

Release history Release notifications | RSS feed

2.4.5

2 release files

2.4.4

2 release files

2.4.3

2 release files

This release

2.4.2 This release

2 release files

2.4.1

2 release files

2.3.11

1 release file

2.3.10

1 release file

2.3.9

2 release files

2.2.9

2 release files

2.2.8

2 release files

2.2.7

2 release files

2.2.6

2 release files

2.2.5

2 release files

2.2.4

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.19

2 release files

2.1.18

2 release files

2.1.17

2 release files

2.1.16

2 release files

2.1.15

2 release files

2.1.14

2 release files

2.1.13

2 release files

2.1.12

2 release files

2.1.11

2 release files

2.1.10

2 release files

2.1.9

2 release files

2.1.8

2 release files

2.1.7

2 release files

2.1.6

2 release files

2.1.5

2 release files

2.1.4

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.2

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.6.0

2 release files

1.5.1

2 release files

1.5.0

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.3.0

2 release files

1.2.20

2 release files

1.2.19

2 release files

1.2.17

2 release files

1.2.16

2 release files

1.2.13

2 release files

1.2.12

2 release files

1.2.10

2 release files

1.2.9

2 release files

1.2.8

2 release files

1.2.7

2 release files

1.2.6

1 release file

1.2.5

3 release files

1.2.4

2 release files

1.2.3

2 release files

1.2.2

2 release files

1.2.1

2 release files

1.2

2 release files

1.1.2

2 release files

1.1.1

2 release files

1.1

2 release files

1.0.1

1 release file

1.0

1 release file

0.1.1

2 release files

0.1.0

2 release files

0.0.3

1 release file

0.0.2

2 release files

0.0.1

2 release files

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