Python wrapper to interface with ITk DB.
Project description
ITk DB v0.4.0rc9
To install as a user
pip install itkdb
or if you wish to develop/contribute
git clone ...
pip install -e .[develop]
or
git clone ...
pip install -e .[complete]
Using
Command line available via
itkdb --help
Environment Variables
See itkdb/settings/base.py for all environment
variables that can be set. All environment variables for this package are
prefixed with ITKDB_
. As of now, there are:
ITKDB_ACCESS_CODE1
: access code #1 for authenticationITKDB_ACCESS_CODE2
: access code #2 for authenticationITKDB_ACCESS_SCOPE
: scope for the access token authentication requestITKDB_AUTH_URL
: authentication serverITKDB_SITE_URL
: API serverITKDB_CASSETTE_LIBRARY_DIR
: for tests, where to store recorded requests/responses
Develop
Bump Version
Run bump2version x.y.z
to bump to the next version. We will always tag any
version we bump, and this creates the relevant commits/tags for you. All you
need to do is git push --tags
and that should be it.
Examples
import itkdb
client = itkdb.Client()
comps = client.get(
"listComponents", json={"project": "P", "pageInfo": {"pageSize": 32}}
)
for i, comp in enumerate(comps):
print(i, comp["code"])
FAQ
SSL Error with CERN websites
If you run into SSL errors with CERN websites, you might need the CERN
certificate chain to sign the certificates correctly. Just add a verify
keyword into your calls:
client.get(..., verify=itkdb.data / "CERN_chain.pem")
and it should work.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.