Registry / database / dbs3-client

dbs3-client

JSON →
library4.0.19pypypi✓ verified 85d ago

Client library for the DBS3 (Data Bookkeeping Service) API, used in CMS (Compact Muon Solenoid) data management. Version 4.0.19 interacts with DBS3 server instances to query dataset, file, and block metadata. Release cadence is irregular.

databaseaws
pip install dbs3-client
github ↗package ↗
INSTALL
IMPORT
SIG · DBS3-CLIENT
D
dbs3-client
databasepythonv4.0.19
Install
1.9s avg
Import
134ms
Disk
30MB
Pass rate
5/ 10
Env Coverage5 / 10
glibc
3.9–3.13
musl
3.9–3.13
Install & Compatibility
Where this runs
tested against v4.0.19 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.10–3.95 runs
build_error
glibc
py 3.10–3.95 runs
installs and imports cleanly · install 1.9s · import 0.134s · 32MB
30MB installed
● package 30MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

DbsApi
✓ from dbs.apis.dbsClient import DbsApi
✗ from dbs.apis.dbsClient import dbsApi
Class name is case-sensitive: DbsApi

Creates a DbsApi instance and fetches datasets matching a pattern.

from dbs.apis.dbsClient import DbsApi api = DbsApi(url='https://cmsweb.cern.ch/dbs/prod/global/DBSReader') datasets = api.listDatasets(dataset='/Muon/Run2016B-23Sep2016-v1/MINIAOD') print(datasets)
Debug
Known issues
deprecatedThe package dbs3-client is deprecated in favor of dbs-client (merged repo). New versions may break imports.
fix
Transition to dbs-client and update imports to dbs.apis.dbsClient as this remains the same.
affects: >=4.0.0
breakingAPI URL must include trailing slash or specific path; missing path causes HTTP 400.
fix
Use full URL with '/dbs/prod/global/DBSReader' as in quickstart.
affects: All
gotchaMany methods return lists of dictionaries; assume empty list on error (no exception raised for empty results).
fix
Check if the returned list is empty before accessing elements.
affects: All
Errors
Common errors & fixes
ImportError: No module named dbs.apis.dbsClient
Package not installed or installed as a different name (dbs-client vs dbs3-client).
fix
Run 'pip install dbs3-client' or 'pip install dbs-client' and ensure the environment is correct.
'DbsApi' object has no attribute 'listDatasets'
Wrong URL or authentication; also some API methods require specific parameters.
fix
Verify URL, authentication, and method signature. Use 'api.listDatasets(dataset=...)' with correct key and value.
Upgrade
Version history
4.0.19latest on PyPI · released Sep 16, 2024
Audit
Dependencies
requestsrequiredHTTP client for API calls
Agent activity
14 hits · last 30 days
node
12
Resources
githubhttps://github.com/dmwm/DBSClient ↗
packagehttps://pypi.org/project/dbs3-client/ ↗
dbs3-client — pip install dbs3-client · libregistry