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.

Project links

Data verified by PyPI on Aug 21, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.4.2)

Owner

PyPI data
Data sourced directly from PyPI's database.

Credits

Author: Robert Court

GitHub Statistics

Data verified by PyPI on Aug 21, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

GPL-3.0-or-later

Requires

Python >=3.8

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

vfb_connect-2.4.1.tar.gz (49.5 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

vfb_connect-2.4.1-py3-none-any.whl (9.4 MB view details)

Uploaded Python 3

File details

Details for the file vfb_connect-2.4.1.tar.gz.

File metadata

  • Download URL: vfb_connect-2.4.1.tar.gz
  • Upload date:
  • Size: 49.5 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for vfb_connect-2.4.1.tar.gz
Algorithm Hash digest
SHA256 f67786ed74ceeae61c8e089fcd545ef7ef80e7c7fe6d2a2235b13e0b70fbdaec
MD5 078611eb320fc4643f71ad516b133201
BLAKE2b-256 6092d3e18a1dcf54168911c1ad06db2759253b58788dde686ab487aed6882177

See more details on using hashes here.

Provenance

The following attestation bundles were made for vfb_connect-2.4.1.tar.gz:

Publisher: publish-to-pypi.yml on VirtualFlyBrain/VFB_connect

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file vfb_connect-2.4.1-py3-none-any.whl.

File metadata

  • Download URL: vfb_connect-2.4.1-py3-none-any.whl
  • Upload date:
  • Size: 9.4 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/7.0.0 CPython/3.13.14

File hashes

Hashes for vfb_connect-2.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9ebc2999386b223dcb207bf1514b5a15de66376a2a6fd7679d508ba5d6aaf622
MD5 f4a1cba6c8d40f036a42852a009b91a5
BLAKE2b-256 1662c66b4f9eeb3a303b6f882f9ba2f0d346d8a5ca43ac11e38da73bcb0af53a

See more details on using hashes here.

Provenance

The following attestation bundles were made for vfb_connect-2.4.1-py3-none-any.whl:

Publisher: publish-to-pypi.yml on VirtualFlyBrain/VFB_connect

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.4.2

2 files

This release

2.4.1 This release

2 files

2.3.14

2 files

2.3.13

2 files

2.3.11

1 file

2.3.10

1 file

2.3.9

2 files

2.2.15

2 files

2.2.14

2 files

2.2.13

2 files

2.2.12

2 files

2.2.11

2 files

2.2.10

2 files

2.2.9

2 files

2.2.8

2 files

2.2.7

2 files

2.2.6

2 files

2.2.5

2 files

2.2.4

2 files

2.2.3

2 files

2.2.2

2 files

2.2.1

2 files

2.2.0

2 files

2.1.24

2 files

2.1.23

2 files

2.1.22

2 files

2.1.21

2 files

2.1.20

2 files

2.1.19

2 files

2.1.18

2 files

2.1.17

2 files

2.1.16

2 files

2.1.15

2 files

2.1.14

2 files

2.1.13

2 files

2.1.12

2 files

2.1.11

2 files

2.1.10

2 files

2.1.9

2 files

2.1.8

2 files

2.1.7

2 files

2.1.6

2 files

2.1.5

2 files

2.1.4

2 files

2.1.3

2 files

2.1.2

2 files

2.1.1

2 files

2.1.0

2 files

2.0.2

2 files

2.0.1

2 files

2.0.0

2 files

1.6.0

2 files

1.5.1

2 files

1.5.0

2 files

1.4.3

2 files

1.4.2

2 files

1.4.1

2 files

1.3.0

2 files

1.2.20

2 files

1.2.19

2 files

1.2.18

2 files

1.2.17

2 files

1.2.16

2 files

1.2.15

2 files

1.2.14

2 files

1.2.13

2 files

1.2.12

2 files

1.2.10

2 files

1.2.9

2 files

1.2.8

2 files

1.2.7

2 files

1.2.6.9

2 files

1.2.6.8

2 files

1.2.6.7

1 file

1.2.6

1 file

1.2.5

3 files

1.2.4

2 files

1.2.3

2 files

1.2.2

2 files

1.2.1

2 files

1.2

2 files

1.1.2

2 files

1.1.1

2 files

1.1

2 files

1.0.1

1 file

1.0

1 file

0.1.1

2 files

0.1.0

2 files

0.0.3

1 file

0.0.2

2 files

0.0.1

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page