Release 5.1.0

5.1.0

November 27th, 2024

Added support for batch processing in DecideAll and DecideForKeys, enabling more efficient handling of multiple decisions in the User Profile Service.(#440)

5.0.1

5.0.1

June 26th, 2024

We removed redundant dependencies pyOpenSSL and cryptography (#435, #436).

Release 5.0.0

5.0.0

January 18th, 2024

New Features

The 5.0.0 release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#395, #398, #402, #403, #405).

You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:

• New API added to OptimizelyUserContext:

  • fetchQualifiedSegments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.
  • When an OptimizelyUserContext is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.

• New APIs added to OptimizelyClient:

  • sendOdpEvent(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:

• Advanced Audience Targeting
• Server SDK Support
• Initialize Python SDK
• OptimizelyUserContext Python SDK
• Advanced Audience Targeting segment qualification methods
• Send Optimizely Data Platform data using Advanced Audience Targeting

Logging

• Add warning to polling intervals below 30 seconds (#428)
• Add warning to duplicate experiment keys (#430)

Enhancements

• Added py.typed to enable external usage of mypy type annotations.

Breaking Changes

• Updated minimum supported Python version from 3.7 -> 3.8
• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated.
• BaseConfigManager abstract class now requires a get_sdk_key method. (#413)
• PollingConfigManager requires either the sdk_key parameter or datafile containing an sdkKey. (#413)
• Asynchronous BatchEventProcessor is now the default event processor. (#378)

Release 5.0.0-beta

5.0.0-beta

Apr 28th, 2023

New Features

The 5.0.0-beta release introduces a new primary feature, Advanced Audience Targeting enabled through integration with Optimizely Data Platform (ODP) (#395, #398, #402, #403, #405).

You can use ODP, a high-performance Customer Data Platform (CDP), to easily create complex real-time segments (RTS) using first-party and 50+ third-party data sources out of the box. You can create custom schemas that support the user attributes important for your business, and stitch together user behavior done on different devices to better understand and target your customers for personalized user experiences. ODP can be used as a single source of truth for these segments in any Optimizely or 3rd party tool.

With ODP accounts integrated into Optimizely projects, you can build audiences using segments pre-defined in ODP. The SDK will fetch the segments for given users and make decisions using the segments. For access to ODP audience targeting in your Feature Experimentation account, please contact your Optimizely Customer Success Manager.

This version includes the following changes:

• New API added to OptimizelyUserContext:

  • fetchQualifiedSegments(): this API will retrieve user segments from the ODP server. The fetched segments will be used for audience evaluation. The fetched data will be stored in the local cache to avoid repeated network delays.
  • When an OptimizelyUserContext is created, the SDK will automatically send an identify request to the ODP server to facilitate observing user activities.

• New APIs added to OptimizelyClient:

  • sendOdpEvent(): customers can build/send arbitrary ODP events that will bind user identifiers and data to user profiles in ODP.

For details, refer to our documentation pages:

• Advanced Audience Targeting
• Server SDK Support
• Initialize Python SDK
• OptimizelyUserContext Python SDK
• Advanced Audience Targeting segment qualification methods
• Send Optimizely Data Platform data using Advanced Audience Targeting

Breaking Changes

• ODPManager in the SDK is enabled by default. Unless an ODP account is integrated into the Optimizely projects, most ODPManager functions will be ignored. If needed, ODPManager can be disabled when OptimizelyClient is instantiated.
• BaseConfigManager abstract class now requires a get_sdk_key method. (#413)
• PollingConfigManager requires either the sdk_key parameter or datafile containing an sdkKey. (#413)
• Asynchronous BatchEventProcessor is now the default event processor. (#378)

Release 4.1.1

[4.1.1] - March 10th, 2023

We updated our README.md and other non-functional code to reflect that this SDK supports both Optimizely Feature Experimentation and Optimizely Full Stack. (#420)

Release 4.1.0

[4.1.0] - July 7th, 2022

Bug Fixes

• Fix invalid datafile returned from ProjectConfig.to_datafile and OptimizelyConfig.get_datafile (#321, #384)

Release 4.0.0

[4.0.0] - January 12th, 2022

New Features

• Add a set of new APIs for overriding and managing user-level flag, experiment and delivery rule decisions. These methods can be used for QA and automated testing purposes. They are an extension of the OptimizelyUserContext interface (#361, #365, #369):

  • setForcedDecision
  • getForcedDecision
  • removeForcedDecision
  • removeAllForcedDecisions

• For details, refer to our documentation pages: OptimizelyUserContext and Forced Decision methods.

Breaking Changes:

• Support for Python v3.4 has been dropped as of this release due to a security vulnerability with PyYAML <v5.4. (#366)
• We no longer support Python v2.7, v3.5, and v3.6 including PyPy as of this release. (#377)
• We now support Python v3.7 and above including PyPy3.

Release 3.10.0

[3.10.0] - September 16th, 2021

New Features

• Added new public properties to OptimizelyConfig.

  • sdk_key and environment_key #338
  • attributes and events #339
  • experiment_rules, delivery_rules, audiences and audiences in OptimizelyExperiment #342 #351

• For details please refer to our documentation page:

  • Python-sdk: [https://docs.developers.optimizely.com/full-stack/docs/optimizelyconfig-python]

• OptimizelyFeature.experiments_map of OptimizelyConfig is now deprecated. Please use OptimizelyFeature.experiment_rules and OptimizelyFeature.delivery_rules. #360

Bug Fixes

• Fix event processor negative timeout interval when retrieving events from queue. #356

Release 3.9.1

[3.9.1] - July 15th, 2021

Bug Fixes:

• Fixed issue with serving incorrect variation in projects containing multiple flags with duplicate keys. #347
• Fixed issue with serving incorrect variation in create_impression_event in user_event_factory.py. #350

Release 3.9.0

[3.9.0] - June 1st, 2021

New Features

• Added support for multiple concurrent prioritized experiments per flag. #322