Skip to content

CHANGELOG.md

Latest commit

 

History

History
344 lines (216 loc) · 8.97 KB

CHANGELOG.md

File metadata and controls

344 lines (216 loc) · 8.97 KB

4.1.0 - 2026-03-20

  • Removed support for file system credentials caching.
  • S3 download URLs are now validated.
  • Improved request timeout handling.

4.0.0 - 2026-01-22

  • Added support for Python 3.14.
  • Dropped support for Python 3.9 which has reached end of life. Python 3.10+ is now required.

3.4.0 - 2025-09-08

  • Fixed binary file downloads.
  • Fixed credentials cache handling.
  • Added missing env init parameter to the Upload SDK class.

3.3.0 - 2025-06-20

  • Added support for Python 3.13.
  • Dropped support for Python 3.8 which has reached end of life. Python 3.9+ is now required.
  • PipelineApiClient.get_pipeline_instances now supports querying pipeline instances by dataset ID and version.
  • Upgraded urllib3 to version 2.x.

3.2.0 - 2024-10-03

  • New methods Dataset.delete_version, Dataset.delete_edition, and Dataset.delete_distribution for deleting dataset versions, editions, and distributions respectively.

3.1.1 - 2024-04-11

  • Removed dependency on the vulnerable (and seemingly abandoned) python-jose library.
  • PyJWT is no longer a dependency.

3.1.0 - 2024-01-10

  • New method Dataset.auto_create_edition for creating a new edition with an automatic name based on the current time.

3.0.0 - 2023-11-08

  • Added support for Python 3.12.
  • Dropped support for Python 3.7 which has reached end of life. Python 3.8+ is now required.
  • Fixed version requirement for urllib3.

2.4.1 - 2023-03-03

  • The optional search filter in Dataset.get_datasets has been relaxed to allow matches anywhere in the dataset name (instead of only at the beginning). In addition it now also searches the dataset's ID.

2.4.0 - 2023-02-13

  • Added support for Python 3.11.

2.3.0 - 2022-09-01

  • New method TeamClient.get_user_by_username for looking up Keycloak users.
  • New method TeamClient.update_team_members for adding and/or removing members to/from a team.

2.2.1 - 2022-08-24

  • Fixed a bug in TeamClient.update_team_attribute when value is falsy.

2.2.0 - 2022-08-23

  • New parameter include added to TeamClient.get_teams.
  • New method TeamClient.get_team_members for getting the members of a team.
  • New methods TeamClient.update_team_name and TeamClient.update_team_attribute for updating team names and their attributes, respectively.

2.1.0 - 2022-06-30

  • New method TeamClient.get_team_by_name.
  • Fixed a deprecation warning from urllib3.

2.0.0 - 2022-05-09

  • A new client class TeamClient for retrieving information about teams has been added.
  • The classes PostEvent, EventStreamClient, and ElasticsearchQueries for working with event streams have all been removed.
  • The WebhookClient class for managing webhooks has been removed.
  • The SimpleDatasetAuthorizerClient class was deprecated and has been removed.

1.0.0 - 2022-04-25

  • Added support for Python 3.10.
  • Dropped support for Python 3.6.

0.9.2 - 2022-01-20

  • Use built-in JSON encoder from requests for post, put and patch methods.

0.9.1 - 2021-09-13

  • Handle error responses from status API update calls.

0.9.0 - 2021-05-26

  • Tweaked the webhook client to create and authorize tokens based on operations (read, write) instead of tying them to a specific service.

0.8.2 - 2021-05-25

  • Add new SDK WebhookClient for managing webhook tokens with okdata-permission-api.

0.8.1 - 2021-05-06

  • Fix handling of Keycloak tokens that don't contain a refresh token.

0.8.0 - 2021-05-04

  • Added support for the new permission API.

  • Retries have been re-enabled for low-level network errors (connection errors, read errors, and redirects). The retry parameter now only controls the maximum number of retries to perform on bad HTTP status codes.

  • Fix refresh of Keycloak access token when refresh token is invalid, e.g. due to inactive session because Keycloak server restarted.

0.7.0 - 2021-03-19

  • Dataset.update_dataset now supports partial metadata updates when the keyword argument partial is true.

0.6.3 - 2021-03-01

  • PyJWT 2.0.0 or above is now required.

0.6.2 - 2021-02-09

  • Authentication is no longer necessary for downloading public ("green") datasets.

0.6.1 - 2021-02-01

  • PostEvent.post_event now also supports retries.

0.6.0 - 2021-01-26

  • Added Dataset.get_distribution method.
  • Added Dataset.update_* methods for updating dataset, version, edition and distribution metadata.
  • Added retry parameter to SDK methods.
  • The confidentiality metadata field is now fully replaced by accessRights.

0.5.2 - 2020-12-16

  • The okdata namespace package now uses the old-style pkg_resources declaration instead of being an implicit namespace package.

0.5.1 - 2020-11-26

  • Added Status.update_status method

0.5.0 - 2020-11-06

Breaking

  • Rename project to okdata-sdk.
    • Repository name will be okdata-sdk-python
    • PyPI package okdata-sdk
    • Python modules will reside in okdata.sdk.*, where okdata is an implicit namespace.

0.4.1 - 2020-11-03

  • No changes

0.4.0 - 2020-11-03

Breaking

  • Modules reorganized to leave top level origo namespace empty, all modules are now under origo.sdk. Ie. from origo.data.upload import Upload now becomes from origo.sdk.data.upload import Upload. This allows other packages to add their modules under the origo namespace.

0.3.0 - 2020-10-29

  • Support the new status API response format. This affects the upload command response, now returning a trace_id key instead of status.

  • PipelineInstance now takes an optional parameter pipelineProcessorId, intended to supersede pipelineArn once all users have been updated. The pipelineArn parameter is now optional.

  • The taskConfig to PipelineInstance is now also optional.

  • PipelineInstance no longer accepts the obsolete parameters schemaId, transformation, and useLatestEdition.

0.2.7 - 2020-09-29

  • Enable, disable and get event stream sinks by type (not id).

0.2.6 - 2020-09-21

  • Add function for listing webhook tokens for a dataset.

0.2.5 - 2020-09-17

  • Rename event stream methods:
    • enable_subscribable > enable_subscription
    • disable_subscribable > disable_subscription
    • add_sink > enable_sink
    • remove_sink > disable_sink

0.2.4 - 2020-09-01

  • Add event stream API support.

0.2.3 - 2020-06-22

  • Use the same default value for cacheCredentials in both development and production environments.
  • Update Makefile for better Python 3 compatibility.

0.2.2 - 2020-05-13

  • Add function for downloading data.
  • Call raise_for_status() when not using SDK class.
  • Reintroduce Python 3.6 support.

0.2.1 - 2020-04-29

  • Check if refresh token is expired before calling KeycloakOpenID.refresh_token().

0.2.0 - 2020-04-27

  • Change default environment to production.
  • Add simple-dataset-authorizer.

0.1.0 - 2020-04-22

  • Get default value from s3SignedData if it doesn't exist.
  • Return both status and status ID for uploads to a dataset.
  • Add support for taskConfig.
  • Add support for status API.

0.0.19 - 2020-02-24

  • Remove DataExistError.
  • Use self.post() in PostEvent.
  • Use response.raise_for_status() as sole error handling in SDK.

0.0.18 - 2020-02-17

  • Use python-keycloak.

0.0.17 - 2020-02-04

  • Use API gateway mapped URL for Elasticsearch queries.
  • Add Elasticsearch queries SDK.

0.0.16 - 2020-01-29

  • Update documentation with new code examples and structure.

0.0.15 - 2020-01-23

  • Add stream manager to SDK.

0.0.14 - 2020-01-16

  • Distribute JSON schemas for pipeline inputs and schemas.

0.0.13 - 2020-01-16

  • No changes

0.0.12 - 2020-01-16

  • Schema bugfix.
  • Fix homepage URL in setup.py.

0.0.11 - 2020-01-16

  • Add schema.
  • Add code examples for creating datasets, uploading files, and sending events.
  • Move developer documentation to separate file.
  • Add support for pipeline input.

0.0.10 - 2020-01-09

  • Update README.
  • Export schema for pipeline and instance.

0.0.9 - 2020-01-06

  • Add possibility to create distribution via API.

0.0.8 - 2020-01-02

  • Use correct production value for s3BucketUrl.
  • Use correct resource name for pipeline instances.
  • Update tests to match new filter implementation.
  • Add filter possibilities on dataset list.
  • Add helpers for pipeline API.
  • Add pipeline instances to SDK client.
  • Add pipeline API SDK client for pipelines.

0.0.7 - 2019-12-06

  • Run is-git-clean before bump-patch.
  • Add constructor argument for custom configuration object.

0.0.6 - 2019-11-25

  • Use correct production URLs.

0.0.5 - 2019-11-25

  • Add __init__.py to event module.

0.0.4 - 2019-11-25

  • No changes

0.0.3 - 2019-11-25

  • Include all packages, but exclude tests, in setup.py.
  • Bump version before building.
  • Automatic tests with GitHub Actions.

0.0.2 - 2019-11-25

  • Add make targets for publishing to PyPI.
  • Add classifiers for license.

0.0.1 - 2019-11-22

  • Initial release.