Skip to main content

Agent-friendly local index for Janelia FlyLight Split-GAL4 resources

This project has been archived.

The maintainers of this project have marked this project as archived. No new releases are expected.

Project description

flylight-cli

This package has been renamed. Install flylight now: pipx install flylight

Agent-friendly local index for Janelia FlyLight Split-GAL4 resources.

Surfaces used:

Source order:

  1. release manifest json
  2. per-line/per-image S3 metadata json
  3. CGI release summary html

CLI

PyPI with pipx:

pipx install flylight-cli

PyPI with plain pip:

python3 -m pip install flylight-cli

Homebrew:

brew tap gumadeiras/tap
brew install flylight-cli
flylight --version

From source:

python3 -m pip install -e .

Release

Current release: v0.12.2.

Tag pushes like vX.Y.Z run the release workflow: build artifacts, create a GitHub release, publish to PyPI, and update gumadeiras/homebrew-tap.

Release prerequisites:

  • PyPI trusted publishing configured for this repo.
  • HOMEBREW_TAP_TOKEN repository secret can write to gumadeiras/homebrew-tap.

Entry:

flylight --help
python3 janelia_splitgal4.py

Examples:

flylight releases
flylight sync --release 'MB Paper 2014'
flylight sync --all
flylight sync --all --force
flylight sync --all --offline
flylight sync --all --refresh-cache
flylight sync --release 'Descending Neurons 2018' --workers 8
flylight sync-plan --all
flylight sync-plan --release 'MB Paper 2014' --offline
flylight reindex
flylight cache-info
flylight schema --entity line
flylight examples --topic release-diff
flylight snapshot-export --out data/flylight-snapshot.tar.gz
flylight snapshot-import data/flylight-snapshot.tar.gz --force
flylight search --expressed-in DNp04 --ad 31B08 --source-kind line-metadata
flylight search --em-cell-type EPG
flylight search-text 'DNp04 AND 31B08'
flylight search-images --area Brain --objective 20x --robot-id 3007645
flylight search-images --em-cell-type EPG
flylight show-line SS00724 --release 'Descending Neurons 2018'
flylight show-image 6878306
flylight compare-line MB005B
flylight compare-release 'MB Paper 2014' 'MB Paper 2015'
flylight show-release 'MB Paper 2014' --include-lines --genotype 34A03
flylight stats
flylight export-ndjson --entity line --release 'Descending Neurons 2018'
flylight export-ndjson --entity image --term MB005B --out data/mb005b.ndjson
flylight export-ndjson --entity release
flylight export-ndjson --entity compare-line --line MB005B
flylight export-ndjson --entity compare-release --left-release 'MB Paper 2014' --right-release 'MB Paper 2015'

Notes

  • HTTP fetches are cache-first by default; cached responses are reused until you pass --refresh-cache.
  • --offline disables network access and uses cached HTTP responses only.
  • cache path: data/http_cache
  • sync-plan is a dry-run: source kind, cache coverage, db coverage, skip vs sync decision.
  • reindex rebuilds derived searchable fields from stored raw image payloads; use it after schema upgrades on an existing db.
  • snapshot-export bundles sqlite + raw manifests + HTTP cache for portable offline reuse.
  • snapshot-import restores that bundle on another machine or working copy.
  • schema shows agent-facing row shapes and producer commands.
  • examples shows canned command recipes for common agent workflows.
  • sync --all is incremental by default; unchanged releases skip.
  • cache-info also reports cache suffix counts and oldest/newest cached timestamps.
  • missing release manifest: fallback walks line dirs + metadata jsons.
  • CGI summary enriches line-level fields like expressed-in, genotype, AD, DBD.
  • line/image exports include normalized arrays alongside text fields.
  • line/image records now include normalized em_cell_types derived from raw em_cell_type metadata when present.
  • search supports field filters over line metadata: AD, DBD, genotype, expressed-in, robot-id, source-kind.
  • search and search-images also support exact --em-cell-type matching.
  • search-text uses SQLite FTS for faster boolean/full-text matching over line text fields.
  • search-images supports field filters over image metadata: area, objective, gender, robot-id, roi.
  • compare-line shows shared fields for the same line across synced releases.
  • compare-release summarizes added, removed, changed, and unchanged lines between two synced releases.
  • export-ndjson also supports compare-line and compare-release entities for agent ingest.
  • local db path: data/janelia_splitgal4.sqlite
  • raw manifest cache: data/raw_manifests/*.json

Project details


Download files

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

Source Distribution

flylight_cli-0.12.3.tar.gz (31.7 kB view details)

Uploaded Source

Built Distribution

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

flylight_cli-0.12.3-py3-none-any.whl (29.3 kB view details)

Uploaded Python 3

File details

Details for the file flylight_cli-0.12.3.tar.gz.

File metadata

  • Download URL: flylight_cli-0.12.3.tar.gz
  • Upload date:
  • Size: 31.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flylight_cli-0.12.3.tar.gz
Algorithm Hash digest
SHA256 10e33bca6096346f815e05b58255859997d5621014b3d2fa052b6ceab2f36563
MD5 33507b05e9e62ac94caa986454af32e6
BLAKE2b-256 8124587aec9f88b95ad63b363dbf06270623e8e7a95c0f5c93bac151b1374e3c

See more details on using hashes here.

Provenance

The following attestation bundles were made for flylight_cli-0.12.3.tar.gz:

Publisher: release.yml on gumadeiras/flylight-cli

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

File details

Details for the file flylight_cli-0.12.3-py3-none-any.whl.

File metadata

  • Download URL: flylight_cli-0.12.3-py3-none-any.whl
  • Upload date:
  • Size: 29.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for flylight_cli-0.12.3-py3-none-any.whl
Algorithm Hash digest
SHA256 5e12644fc560bc9368e88a587d16ed629daf7e5bcbb22e30d9446d44837da16a
MD5 d027ea1e211998e1de972b015a90cb14
BLAKE2b-256 e590dace15505504519cb9277afdaa8a1805e03a0566aff5cb5ee9a222c2d3f8

See more details on using hashes here.

Provenance

The following attestation bundles were made for flylight_cli-0.12.3-py3-none-any.whl:

Publisher: release.yml on gumadeiras/flylight-cli

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

Supported by

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