itkdb history¶

All notable changes to itkdb will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased¶

Changed:

Added:

Fixed:

0.6.12 - 2024-11-08¶

Changed:

close response after streaming to file locally

0.6.11 - 2024-11-07¶

Fixed:

support context manager for closing chunked responses (#131)

0.6.10 - 2024-11-01¶

Fixed:

do not override verify argument if supplied by user (#127)

0.6.9 - 2024-08-23¶

Fixed: 0.6.8 is yanked. getXYZAttachment returns binary-file object.

0.6.8 - 2024-08-13¶

Added: Retry failed call to new binary API (e.g. getComponentAttachment) with old API (getBinaryData).

0.6.7 - 2024-06-27¶

Changed:

Added: Type coercion when comparing test run properties to be uploaded with test run properties in the production database in _get_duplicate_test_runs.

Fixed:

0.6.6 - 2024-05-15¶

Fixed: Bug in allow_duplicate where it continued to check for duplicates after removing the testRun from the list of runs to compare.

0.6.5 - 2024-05-03¶

Changed:

itkdb.Client.post for allow_duplicate was modified in #101, thanks to Lingxin Meng for following up in the production database meeting to remove runNumber and parameter result fields with dataType == 'image' from being used to determine duplicate test runs

0.6.4 - 2024-04-18¶

Added:

itkdb.Client.post now has a keyword argument allow_duplicate which defaults to True. If set to False, will check if a duplicate object exists before POST'ing it to the production database. Currently, this logic is implemented for uploadTestRunResults. Refer to documentation of itkdb.Client.post to see what other endpoints are supported.

0.6.3 - 2024-04-17¶

Changed:

Reverted changes for 0.6.2 which were broken.

0.6.2 - 2024-04-17¶

Changed:

Switched to shutil.copyfileobj for downloading attachments in itkdb.models.BinaryFile.from_response

0.6.1 - 2024-04-16¶

Fixed:

Bug in itkdb.core.Session.authorize where it was checking the wrong URL prefix for updating headers

0.6.0 - 2024-04-16¶

Added:

Support for simple bearer authentication via itkdb.core.UserBearer

Changed:

Dropped support for python 3.7
Renamed ITKDB_SITE_URL to ITKDB_API_URL

0.5.1 - 2024-04-05¶

Fixed:

Pagination of requests without a body are fixed, such as client.get('listComponents').

0.5.0 - 2024-03-11¶

Added:

Command-line interfaces for itkdb eos upload and itkdb eos delete

Changed:

Migrated relevant portions of client.py to eos.py for splitting out the EOS-specific functionality with pycurl

0.4.14 - 2024-02-15¶

Fixed:

Dropped python-magic dependency for Windows installations.

0.4.13 - 2023-11-30¶

Fixed:

Dropped pylibmagic dependency for Windows installations.

0.4.12 - 2023-11-15¶

Fixed:

Handle empty attachments properly, returning a itkdb.models.BinaryFile instead of a requests.models.Response object, and not crashing with content-type / mimetype checks.

0.4.11 - 2023-10-30¶

Fixed:

Do not attempt to delete attachment from EOS if the token is not returned from ITk PD.

0.4.10 - 2023-10-27¶

Fixed:

Added a new pycurl callback SEEKFUNCTION to handle EOS redirects better to resolve errors like
```
pycurl.error: (65, "necessary data rewind wasn't possible")
```

0.4.9 - 2023-10-18¶

Fixed:

Add upper bound on urllib3 for CentOS7/SL7 machines to match openssl. Without the fix one gets something like

ImportError: urllib3 v2.0 only supports OpenSSL 1.1.1+, currently the 'ssl' module is compiled with 'OpenSSL 1.0.2k-fips  26 Jan 2017'. See: https://github.com/urllib3/urllib3/issues/2168

0.4.8 - 2023-09-12¶

Fixed:

itkdb.responses.PagedResponse reruns authentication when paginating.

0.4.7 - 2023-08-30¶

Added:

auth_expiry_threshold to itkdb.core.User, itkdb.core.Session, and itkdb.client.Client to force reauthentication sooner than when the token actually expires

0.4.6 - 2023-08-29¶

Changed:

Pagination will not keep history by default (see below for how to recover existing behavior)

Added:

Keyword arguments for keeping pagination history, set to False by default to not keep previous pages
- itkdb.Client has a pagination_history keyword argument
- itkdb.responses.PagedResponse has a history keyword argument

Fixed:

itkdb authenticate had a broken f-string

0.4.5 - 2023-07-14¶

Added:

Dependency on python-magic-bin for Windows installations

0.4.4 - 2023-06-02¶

Added:

Functionality to automatically delete attachments from EOS (if the attachment is on EOS)

0.4.3 - 2023-05-04¶

Changed:

Undo changes in v0.4.3

Added:

Upper-bound on urllib3<2

Fixed:

Handle json attachments correctly

0.4.2 - 2023-05-01¶

Fixed:

Improved caching for later versions of urllib3 where HTTPResponse object does not have strict attribute

0.4.1 - 2023-04-28¶

Changed:

Updated CERN TLS chain/certificates

Added:

More examples to documentation

0.4.0 - 2023-03-02¶

Added:

This documentation website!
Functionality to upload to EOS (with_eos argument to itkdb.Client)
Automatic SSL verification for requests to .cern.ch
itkdb.utils
itkdb.models
- itkdb.models.BinaryFile as a base for all file models
- itkdb.models.ZipFile (#17)
Configuration
- audience, site, access scopes [ITKDB_ACCESS_SCOPE, ITKDB_ACCESS_AUDIENCE] (1c18ad6c, 1942333f)
- leeway [ITKDB_LEEWAY] (3dc7027d)
Support for python 3.11 (#19)
contrib feature for rendering exceptions that return HTML (#20)
itkdb.data for data files (#15 for image/text data files and the CERN SSL cert chain, #24 for ROOT file)

Changed:

Renamed itkdb.utilities to itkdb.utils
itkdb.models
- itkdb.models.Image to itkdb.models.ImageFile
- itkdb.models.Text to itkdb.models.TextFile
Improved handling of large data files by creating a temporary file on disk when downloading from ITkPD or EOS
itkdb.core.User arguments renamed from accessCode1 / accessCode2 to access_code1 / access_code2 to be more pythonic

Fixed:

Fix version command when the version is dynamic and build dependencies are unmet
Fixed bug in CLI for overriding base configuration settings (#14)
Fixed bug in duplicated logging when redirects occur (#21)