v1.2.0

Release notes

These release notes summarize changes contained in the Python SDK 1.2 release. Please ensure you are using the latest version of GoodData.CN (2.2) or GoodData Cloud before trying these out.

Improvements to working with APIs

Added unified Python package gooddata-api-client that combines the following packages:

• gooddata-afm-client
• gooddata-metadata-client
• gooddata-scan-client

Please note that the three packages will be deprecated and only the gooddata-api-client will be maintained going forward.

Improvements to working with entities

• The entity data source was reimplemented as a data class.
• Added support for Greenplum data sources. Please note that at the moment Greenplum is only supported in GoodData Cloud.

Support for managing declarative layouts

• Added a series of methods, store_xxx_to_disk, and load_xxx_from_disk, for the analytical model, LDM, and PDM. These methods let you store these layouts without including their parent organization and workspace in the file structure.

Breaking changes

• Attribute data_source_type was renamed to type for the CatalogDataSource entity.

Commits

• 06e05e0: PSDK-94 fix tests-support installation (hkad98) #149
• 43727a1: PSDK-95: Enable schemata parameter in ScanRequest (Jacek) #150
• recreate folders containing stored fixtures #150 (Jacek)
• 0756843: PSDK-97 fix missing imports (hkad98) #151
• edba589: PSDK-102 add parameter to mypy.ini (hkad98) #153
• c9b8a55: PSDK-102 add missing Optional (hkad98) #153
• 30b7867: XSH-800 Regenerate afm-client to reflect updated AFM API (Dominik Sauer) #152
• 1f8358f: XSH-800 Rename ResultSizeDimensions and related identifiers (Dominik Sauer) #152
• c199eba: XSH-800 Check the size limits only on first result chunk (Dominik Sauer) #152
• 9e84f1b: XSH-800 Rename execution response conversion function and related code (Dominik Sauer) #152
• 57d42e3: XSH-800 Wrap result cache metadata into a wrapper (Dominik Sauer) #152
• 0d9ee20: XSH-800 Allow limiting byte size of an execution result (Dominik Sauer) #152
• 24933f5: PSDK-93 fix package build (hkad98) #154
• c5442b9: PSDK-28 new package definition (hkad98) #155
• 5f89564: PSDK-28 generated clients (hkad98) #155
• cca26b7: PSDK-28 files updated to contain new package (hkad98) #155
• 104acdd: PSDK-28 adjust existing packages to the new api client (hkad98) #155
• 03472da: PSDK-28 tests (hkad98) #155
• 53570da: PSDK-104 added load & store methods to service (hkad98) #156
• f81bf74: PSDK-104 added tests (hkad98) #156
• 8428d45: PSDK-105 new package temporary fix (hkad98) #157
• 8264ede: XSH-837: Allow returning local ids of header labels (Roman Hartig) #158
• 4b09391: XSH-850: Fix doc typo (Roman Hartig) #159
• a6552fc: XSH-850: Allow returning DataFrame metadata (Roman Hartig) #159
• feeae52: XSH-835 Allow specifying custom headers in GoodPandas constructor (Dominik Sauer) #160
• 4d8824c: XSH-835 Publish sdk property of GoodPandas (Dominik Sauer) #160
• cbbcfb1: Update image for fossa scanning (Binh Pham) #161
• d056609: Updated clients (hkad98) #162
• 3504fe6: PSDK-103 Fix docker image name (hkad98) #163
• 0428534: PSDK-103 BigQuery data source API change (hkad98) #163
• 6b3dc1f: PSDK-103 declarative workspace new parameter (hkad98) #163
• 83c21fd: PSDK-103 tests + fixtures (hkad98) #163
• 205cc9c: PSDK-103 Fix entity data source (hkad98) #164
• 04f287a: PSDK-103 fixtures (hkad98) #164
• c05a40a: PSDK-111 Update Dockerfile for GoodData FDW (hkad98) #165
• a7c6408: PSDK-109 change entity data source to use data class (hkad98) #166
• 134dec9: PSDK-109 test support (hkad98) #166
• 914653b: PSDK-109 turn off docs build warnings (hkad98) #166
• a77e7ba: PSDK-108 Add GREENPLUM data source (hkad98) #167
• e97c640: PSDK-108 tests (hkad98) #167
• e14c5d5: PSDK-112 add new licenses (hkad98) #168
• 46ca1c9: XSH-867: Use None in DataFrame index/column names for missing headers (Roman Hartig) #169
• 561e96c: XSH-880: Document DataFrame creation from ExecutionDefinition/ResultID (Roman Hartig) #170
• 27b3dd9: Documentation update (hkad98) #171
• 20ff1af: Regenerate clients for upcoming release (hkad98) #172
• aff8268: Comment Greenplum test (hkad98) #172
• 7432a63: Update README.md (iMacho) #173
• dc1dd8c: Update README.md (iMacho) #173
• a73a618: .CN -> .CN&Cloud (iMacho) #173
• 1607c55: Adding Catalog (iMacho) #173
• 1e6e6c5: Bump to 1.2.0 (hkad98) #174
• 2296840: tox.ini dependency fix (hkad98) #174
• 3099907: Docs requirements dependency fix (hkad98) #174

v1.1.0

Release notes

These release notes summarize changes contained in the Python SDK 1.1 release. Please ensure you are using the latest version of GoodData.CN (2.1) or GoodData Cloud before trying these out.

Improvements to working with entities:

• Added support for dependent entities graph. Dependent entities graph is a directed graph containing information on entity (dataset, metric, insight) dependency. We can further utilize this object with the NetworkX package.

Support for managing declarative layouts.

• Workspace
  You can receive, change, store (in your local storage), and load the workspace layout from your local storage.

Other changes:

• Documentation on pypi.org now points to the relevant documentation.
• For every imported foreign table that was imported using gooddata-fdw, a corresponding view is automatically created. This change prevents issues in some tools, such as PowerBI, that do not support foreign tables.
• GoodPandas now supports subtotals and grandtotals.
• GoodPandas now supports the creation of DataFrames using an ExecutionDefinition and respecting the dimensionality specified in the ExecutionDefinition.

Commits

• f36a5c1: NAS-4150 set AIO in docker compose to supported version (Pavel Cerny) #123
• 22d0f64: NAS-4150 support test-ci target against local AIO (Pavel Cerny) #123
• 87bdad6: NAS-4150 fix load and put workspaces test (Pavel Cerny) #123
• b385508: TNT-939 Update fixture for pop date item according to api specification (Petr Benes) #124
• ba3b695: TNT-940 Fix sorts in layout fixture (Petr Benes) #124
• 7b42b82: Recreate cassettes after fixture change (Petr Benes) #124
• 5a5c0ea: XSH-711 Allow building alpha-versions of the repo (Dominik Sauer) #125
• 955c52e: XSH-711 Create github workflow to publish master as alpha version (Dominik Sauer) #128
• 4b5680c: Updated the way TOC is defined for Python SDK Services page in docs (Andy Chumak) #129
• 80a5682: Fix docstring annotations for better rendering online (Andy Chumak) #131
• 9124e73: XSH-733: Enhance exec response and result (Lubo Slivka) #130
• b6d9902: XSH-733: Include totals in execution definition (Lubo Slivka) #130
• f8a5d8c: XSH-733: Add factory to create data frames from raw exec definition (Lubo Slivka) #130
• 0bb45e0: XSH-733: Regenerate afm-client to allow fetching ResultCacheMetadata (Roman Hartig) #130
• 602c159: XSH-733: Get dimension indexes from ExecutionResponse (Roman Hartig) #130
• 20e8895: XSH-733: Construct dataframe using execution result ID (Roman Hartig) #130
• 5ba5c00: XSH-733: Explain ExecutionResponse parsing TODOs (Roman Hartig) #130
• b7a8b28: XSH-733: Add dimension labels into Dataframe (Roman Hartig) #130
• 395d19e: XSH-733: Add label overrides argument to dataframe creation flow (Roman Hartig) #130
• b8af7bb: XSH-733: Polish convertor and execution codebase (Roman Hartig) #130
• b29899e: XSH-733: Use dev_latest in docker-compose (Roman Hartig) #130
• extend list of classes exported from SDK init #132 (Jacek)
• 92e6f06: NAS-4244 OAPI generator version upgrade (hkad98) #133
• e7e6238: NAS-4244 generated clients (hkad98) #133
• 0bafcea: NAS-4244 wrapper fix (hkad98) #133
• 19b965d: NAS-4244 fixtures and expected behaviour update (hkad98) #133
• 12c8ed2: NAS-4254 fixed default values for immutable attributes (hkad98) #134
• f7f1ace: NAS-4254 place CatalogWorkspaceContentService to separate file (hkad98) #134
• sonar fix #135 (hkad98)
• dual sonar setup #136 (Pavel Cerny)
• 2f28a79: NAS-4254 manage dependent entities graph (hkad98) #134
• 45662ae: NAS-4254 test support (hkad98) #134
• 4be0e46: NAS-4268 create view related to foreign table (hkad98) #138
• 1ecc615: NAS-4110 make documentation point to related version (hkad98) #139
• a7cbe00: XSH-752 Limit the result size before downloading whole result (Dominik Sauer) #140
• f275cb7: XSH-752 Don't use mutable defaults for label_overrides (Dominik Sauer) #140
• b34db48: regenerate_clients (hkad98) #142
• 415a122: NAS-4284 documentation update + minor changes (hkad98) #141
• 5b6455e: XSH-783 Export type for label_overrides (Dominik Sauer) #143
• 403f808: NAS-4305 fix creat VIEW custom_schema (hkad98) #144
• eaa6683: NAS-4246 tests support package (hkad98) #145
• 6bdf68c: NAS-4246 upgrade dependencies version (hkad98) #145
• e452190: NAS-4246 change (de)serialization for cassettes (hkad98) #145
• 8c68567: NAS-4246 fixtures (hkad98) #145
• 72aee3e: Regenerate clients (hkad98) #146
• f01af7e: Fix classes (hkad98) #146
• 8af11bb: Updated cassettes (hkad98) #146
• 5a5aef1: FIX documentation url (hkad98) #147
• 1cff88f: Bump to 1.1.0 (hkad98) #148

v1.0.0

Release notes

These release notes summarize changes contained in the Python SDK 1.0 release. Please ensure you are using the latest version of GoodData.CN (2.0) or GoodData Cloud before trying these out.

Improvements to working with entities:

• Added support for CRUD operations that reproduce user and user group entity API functionality.
• Added support for the organization for managing OIDC settings and changing the organization name.

Support for managing declarative layouts.

• We have added a series of functions that let you work with:

  • Workspace data filter layout
    You can receive a workspace data filter layout, change the data filter layout, store the layout in your local storage, and load the layout from your local storage.
  • User layout
    You can receive user metadata, change user layout, store layout in your local storage, and load layout from your local storage.
  • User group layout
    You can receive user group metadata, change user group layouts, store layouts in your local storage, and load layouts from your local storage.
  • User and user group layout
    For a better user experience, you can work with both user and user groups simultaneously.
  • Permission layout (related to workspaces)
    You can receive permissions information, change permission layouts, store layouts in your local storage, and load layouts from your local storage.

• Other changes:

  • We started using popular Python libraries attrs and cattrs for the layer between the user and generated OAPI clients. The libraries are used in declarative layouts and some entity classes at the moment. This should make for a more enjoyable and efficient development experience. We want to extend the use of third-party libraries as much as possible.
  • We added support for Python 3.10.

Commits

• 5e1c227: NAS-3695 minor fixes (hkad98) #101
• 7a0172f: NAS-3695 updated test layout with short IDs and extended analytics model (hkad98) #101
• 3f5f37d: NAS-3695 updated fixtures and files for testing (hkad98) #101
• 8ef6547: NAS-3793: Bump latest python version to 3.10 (Jacek) #102
• 64939b0: NAS-3782 reimplemented declarative classes with attrs and cattrs (hkad98) #103
• cf06280: NAS-3743 extended tests-support (hkad98) #104
• 6a286ba: NAS-3743 added user service (hkad98) #104
• 5e1e572: NAS-3743 user service test support (hkad98) #104
• relax version of PyYAML library #105 (Jacek)
• 9443af4: NAS-3276 fixed future warning in GoodPandas (hkad98) #106
• b8c5686: NAS-2884 fixed empty dataframe (hkad98) #107
• 5fc4640: NAS-3868 extend user and organization service (hkad98) #108
• 3947909: NAS-3868 test support for implementation (hkad98) #108
• f3c8abd: NAS-3911 generator and docker image version update (hkad98) #109
• f2f60bb: NAS-3911 updated client modules (hkad98) #109
• 2140cd2: NAS-3911 updated tests-support (hkad98) #109
• e4edecb: NAS-3911 updated entity/declarative classes (hkad98) #109
• 9f3114d: NAS-3911 updated test files (hkad98) #109
• 5043d6e: NAS-3911 updated fixtures and additional files for tests (hkad98) #109
• b97bfb3: NAS-3996 control implementation (hkad98) #110
• 5a5a0de: NAS-3996 test support (hkad98) #110
• e7ee1bf: NAS-4011 update clients (hkad98) #111
• 0ead7be: NAS-3893 add permission service (hkad98) #112
• de520d0: NAS-3749 fix table_prefix ignored (hkad98) #113
• 5638e5a: NAS-4024 fix minor inconsistency (hkad98) #114
• b1da9f0: NAS-4034 add UsersAndUserGroups support (hkad98) #116
• 4d2402c: NAS-3912 fix add classes (hkad98) #115
• 35e8ef5: NAS-3912 base doc changes (hkad98) #115
• fe115dd: NAS-3912 new features + fix (hkad98) #115
• 037c4eb: NAS-3912 changed development status (hkad98) #115
• f706cb7: NAS-4076 update license files for release 1.0.0 (hkad98) #118
• 7c0168b: NAS-4105 extend import from the gooddata_sdk (hkad98) #119
• 002773b: Bump to 1.0.0 (hkad98) #120

v0.8.0

Release notes

These release notes summarize changes contained in the Python SDK 0.8 release. Please ensure you are using the latest version of GoodData.CN (1.7) before trying these out.

Improvements to working with entities:

• Added support for CRUD operations that reproduce entity API functionality for workspace and data source entities.
• You can now get lists of workspace content such as facts, metrics, and attributes.
• Added methods for scanning data sources and generating the physical and logical data models.
• Added support for call upload notification API (invalidate caches when new ETL finishes).

Support for managing declarative layouts:

• We have added a series of functions that let you work with:
  • Workspace layouts. This includes workspaces, workspace data filters, analytics models, and logical data models.
  • Workspace content layouts. This includes the analytics and logical data models. You have an option to replace data source ID in an analytical data model easily.
  • Data source layouts. This includes the physical data model and management of credentials, and it also contains support for testing data sources (test API).
• You are able to store declarative layouts in your local storage. Stored layouts are saved into a directory hierarchy reflecting the real hierarchy of the metadata objects.
• Added a new method for collecting organization ID, which is part of the directory structure. This enables working with multiple organizations.

Other changes:

• Added SupportService for checking if GoodData.CN metadata APIs are available.

v0.7.0

Merge pull request #65 from mira01/release070

Bump to 0.7.0

Reviewed-by: https://github.com/pcerny