Skip to main content

Python library and CLI for the CERN ATLAS Glance/Fence API

Project description

stare

Python library and CLI for the CERN ATLAS Glance/Fence API.

Actions Status Documentation Status PyPI version

Installation

python -m pip install stare

Authentication

stare uses PKCE (no passwords stored). Run once to authenticate:

stare auth login

Your browser will open CERN SSO. After approval, tokens are stored locally and refreshed automatically.

CLI usage

# Search analyses — Rich table in terminal, JSON when piped
stare analysis search
stare analysis search --query 'referenceCode = ANA-HION-2018-01'
stare analysis search -q 'keywords contain Higgs' --limit 20
stare analysis search -q 'shortTitle = "Phase Closed"'

# Pipe to jq for field selection (JSON is auto-emitted)
stare analysis search | jq '.results[].referenceCode'
stare analysis search -q 'referenceCode contain HION' \
  | jq -r '.results[] | select(.status == "Active") | .referenceCode'

# Search papers
stare paper search --query 'referenceCode = HDBS-2018-33'

# Get individual resources
stare analysis get ANA-HION-2018-01
stare paper get HDBS-2018-33

# CONF notes / PUB notes
stare conf-note ATLAS-CONF-2024-001
stare pub-note ATL-PHYS-PUB-2024-001

# List metadata
stare groups
stare subgroups

# Auth management
stare auth login
stare auth logout
stare auth status

# Cache management
stare cache info
stare cache clear --yes

Output is a Rich table when stdout is a terminal and JSON when piped or redirected. Use --json / --no-json to override. Commands that expose --no-cache bypass the 8-hour on-disk response cache for that invocation.

Library usage

from stare import Glance

g = Glance()

# Search analyses (currently live)
result = g.analyses.search(query="referenceCode = ANA-HION-2018-01")
print(f"Found {result.total_rows} analyses")
for analysis in result.results:
    print(analysis.reference_code, analysis.short_title)

# Search papers (currently live)
paper_result = g.papers.search(query="referenceCode = HDBS-2018-33")
print(f"Found {paper_result.total_rows} papers")
for paper in paper_result.results:
    print(paper.reference_code, paper.short_title)

# Individual resource lookups (available as API endpoints go live)
analysis = g.analyses.get("ANA-HION-2018-01")
paper = g.papers.get("HDBS-2018-33")
groups = g.groups.list()

Use as a context manager for explicit connection lifecycle:

with Glance() as g:
    result = g.analyses.search(query="status = Active")

Inject a token directly (useful in CI/automated scripts):

g = Glance(token="your-access-token")

Configuration

Override defaults via environment variables:

Variable Default
STARE_BASE_URL https://atlas-glance.cern.ch/atlas/analysis/api
STARE_CLIENT_ID stare
STARE_AUTH_URL CERN Keycloak auth endpoint
STARE_TOKEN_URL CERN Keycloak token endpoint
STARE_CALLBACK_PORT 8182 (must match Keycloak registration)

Development

git clone https://github.com/kratsg/stare
cd stare
pixi install
pixi run pre-commit-install
pixi run stare auth login
pixi run test

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

stare-0.3.0rc2.tar.gz (155.8 kB view details)

Uploaded Source

Built Distribution

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

stare-0.3.0rc2-py3-none-any.whl (62.0 kB view details)

Uploaded Python 3

File details

Details for the file stare-0.3.0rc2.tar.gz.

File metadata

  • Download URL: stare-0.3.0rc2.tar.gz
  • Upload date:
  • Size: 155.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for stare-0.3.0rc2.tar.gz
Algorithm Hash digest
SHA256 2c77b245bbcb86e1ca5997b5d3c5a548c981be572892bcfe0d933a9691ca18a2
MD5 991eb39cb262e3467017c86586149fb1
BLAKE2b-256 791793f5940c23d621235f2192371c6dd92291884f82dc61a7b17a2d2398f370

See more details on using hashes here.

Provenance

The following attestation bundles were made for stare-0.3.0rc2.tar.gz:

Publisher: cd.yml on kratsg/stare

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

File details

Details for the file stare-0.3.0rc2-py3-none-any.whl.

File metadata

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

File hashes

Hashes for stare-0.3.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 30a4d69be1ed60afbd809c20c0cd1ce6358d697c1aef8b893f059a51bb93c64d
MD5 791d2563fe401ca2a8a71ee07c6d6448
BLAKE2b-256 011c86e3f9abb724a0eab8a7545d2d0b975194a9f07364b343036a188c5d4057

See more details on using hashes here.

Provenance

The following attestation bundles were made for stare-0.3.0rc2-py3-none-any.whl:

Publisher: cd.yml on kratsg/stare

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