From 9ae0dedbd2fac2597e803efbd4b56772e2c51d46 Mon Sep 17 00:00:00 2001 From: CoprDistGit Date: Tue, 11 Apr 2023 05:44:20 +0000 Subject: automatic import of python-optimizely-sdk --- .gitignore | 1 + python-optimizely-sdk.spec | 2073 ++++++++++++++++++++++++++++++++++++++++++++ sources | 1 + 3 files changed, 2075 insertions(+) create mode 100644 python-optimizely-sdk.spec create mode 100644 sources diff --git a/.gitignore b/.gitignore index e69de29..918be82 100644 --- a/.gitignore +++ b/.gitignore @@ -0,0 +1 @@ +/optimizely-sdk-4.1.1.tar.gz diff --git a/python-optimizely-sdk.spec b/python-optimizely-sdk.spec new file mode 100644 index 0000000..e6e019e --- /dev/null +++ b/python-optimizely-sdk.spec @@ -0,0 +1,2073 @@ +%global _empty_manifest_terminate_build 0 +Name: python-optimizely-sdk +Version: 4.1.1 +Release: 1 +Summary: Python SDK for Optimizely Feature Experimentation, Optimizely Full Stack (legacy), and Optimizely Rollouts. +License: Apache Software License +URL: https://github.com/optimizely/python-sdk +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/c5/a2/19a449d3bd52f2dc97224b78a1ccc16e8e6e46a9b87ef70243a91d0ab486/optimizely-sdk-4.1.1.tar.gz +BuildArch: noarch + +Requires: python3-jsonschema +Requires: python3-pyrsistent +Requires: python3-requests +Requires: python3-pyOpenSSL +Requires: python3-cryptography +Requires: python3-idna +Requires: python3-six +Requires: python3-cryptography +Requires: python3-pyrsistent +Requires: python3-pyOpenSSL +Requires: python3-requests +Requires: python3-six +Requires: python3-funcsigs +Requires: python3-pytest-cov +Requires: python3-pytest +Requires: python3-coveralls +Requires: python3-coverage +Requires: python3-flake8 +Requires: python3-mock +Requires: python3-jsonschema +Requires: python3-idna + +%description +Optimizely Feature Experimentation is A/B testing and feature management for product development teams. Experiment in any application. Make every feature on your roadmap an opportunity to learn. Learn more at https://www.optimizely.com/products/experiment/feature-experimentation/ or see our documentation at https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome. # Optimizely Python SDK + +[![PyPI version](https://badge.fury.io/py/optimizely-sdk.svg)](https://pypi.org/project/optimizely-sdk) +[![Build Status](https://travis-ci.org/optimizely/python-sdk.svg?branch=master)](https://travis-ci.org/optimizely/python-sdk) +[![Coverage Status](https://coveralls.io/repos/github/optimizely/python-sdk/badge.svg)](https://coveralls.io/github/optimizely/python-sdk) +[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0) + +This repository houses the Python SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy). + +Optimizely Feature Experimentation is an A/B testing and feature management tool for product development teams that enables you to experiment at every step. Using Optimizely Feature Experimentation allows for every feature on your roadmap to be an opportunity to discover hidden insights. Learn more at [Optimizely.com](https://www.optimizely.com/products/experiment/feature-experimentation/), or see the [developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome). + +Optimizely Rollouts is [free feature flags](https://www.optimizely.com/free-feature-flagging/) for development teams. You can easily roll out and roll back features in any application without code deploys, mitigating risk for every feature on your roadmap. + +## Get Started + +Refer to the [Python SDK's developer documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/python-sdk) for detailed instructions on getting started with using the SDK. + +### Requirements + +Version `4.0+`: Python 3.7+, PyPy 3.7+ + +Version `3.0+`: Python 2.7+, PyPy 3.4+ + +### Install the SDK + +The SDK is available through [PyPi](https://pypi.python.org/pypi?name=optimizely-sdk&:action=display). + +To install: + + pip install optimizely-sdk + +### Feature Management Access + +To access the Feature Management configuration in the Optimizely +dashboard, please contact your Optimizely customer success manager. + +## Use the Python SDK + +### Initialization + +You can initialize the Optimizely instance in three ways: with a datafile, by providing an sdk_key, or by providing an implementation of +[BaseConfigManager](https://github.com/optimizely/python-sdk/tree/master/optimizely/config_manager.py#L32). +Each method is described below. + +1. Initialize Optimizely with a datafile. This datafile will be used as + the source of ProjectConfig throughout the life of Optimizely instance: + + optimizely.Optimizely( + datafile + ) + +2. Initialize Optimizely by providing an \'sdk_key\'. This will + initialize a PollingConfigManager that makes an HTTP GET request to + the URL (formed using your provided sdk key and the + default datafile CDN URL template) to asynchronously download the + project datafile at regular intervals and update ProjectConfig when + a new datafile is received. A hard-coded datafile can also be + provided along with the sdk_key that will be used + initially before any update: + + optimizely.Optimizely( + sdk_key='put_your_sdk_key_here' + ) + + If providing a datafile, the initialization will look like: + + optimizely.Optimizely( + datafile=datafile, + sdk_key='put_your_sdk_key_here' + ) + +3. Initialize Optimizely by providing a ConfigManager that implements + [BaseConfigManager](https://github.com/optimizely/python-sdk/tree/master/optimizely/config_manager.py#L34). + You may use our [PollingConfigManager](https://github.com/optimizely/python-sdk/blob/master/optimizely/config_manager.py#L150) or + [AuthDatafilePollingConfigManager](https://github.com/optimizely/python-sdk/blob/master/optimizely/config_manager.py#L375) as needed: + + optimizely.Optimizely( + config_manager=custom_config_manager + ) + +### PollingConfigManager + +The [PollingConfigManager](https://github.com/optimizely/python-sdk/blob/master/optimizely/config_manager.py#L150) asynchronously polls for +datafiles from a specified URL at regular intervals by making HTTP requests. + + polling_config_manager = PollingConfigManager( + sdk_key=None, + datafile=None, + update_interval=None, + url=None, + url_template=None, + logger=None, + error_handler=None, + notification_center=None, + skip_json_validation=False + ) + +**Note**: You must provide either the sdk_key or URL. If +you provide both, the URL takes precedence. + +**sdk_key** The sdk_key is used to compose the outbound +HTTP request to the default datafile location on the Optimizely CDN. + +**datafile** You can provide an initial datafile to bootstrap the +`ProjectConfigManager` so that it can be used immediately. The initial +datafile also serves as a fallback datafile if HTTP connection cannot be +established. The initial datafile will be discarded after the first +successful datafile poll. + +**update_interval** The update_interval is used to specify a fixed +delay in seconds between consecutive HTTP requests for the datafile. + +**url** The target URL from which to request the datafile. + +**url_template** A string with placeholder `{sdk_key}` can be provided +so that this template along with the provided sdk key is +used to form the target URL. + +You may also provide your own logger, error_handler, or +notification_center. + +### AuthDatafilePollingConfigManager + +The [AuthDatafilePollingConfigManager](https://github.com/optimizely/python-sdk/blob/master/optimizely/config_manager.py#L375) +implements `PollingConfigManager` and asynchronously polls for authenticated datafiles from a specified URL at regular intervals +by making HTTP requests. + + auth_datafile_polling_config_manager = AuthDatafilePollingConfigManager( + datafile_access_token, + *args, + **kwargs + ) + +**Note**: To use [AuthDatafilePollingConfigManager](#authdatafilepollingconfigmanager), you must create a secure environment for +your project and generate an access token for your datafile. + +**datafile_access_token** The datafile_access_token is attached to the outbound HTTP request header to authorize the request and fetch the datafile. + +### Advanced configuration + +The following properties can be set to override the default +configurations for [PollingConfigManager](#pollingconfigmanager) and [AuthDatafilePollingConfigManager](#authdatafilepollingconfigmanager). + +| **Property Name** | **Default Value** | **Description** | +| :---------------: | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------: | +| sdk_key | None | Optimizely project SDK key | +| datafile | None | Initial datafile, typically sourced from a local cached source | +| update_interval | 5 minutes | Fixed delay between fetches for the datafile | +| url | None | Custom URL location from which to fetch the datafile | +| url_template | `PollingConfigManager:`
https://cdn.optimizely.com/datafiles/{sdk_key}.json
`AuthDatafilePollingConfigManager:`
https://config.optimizely.com/datafiles/auth/{sdk_key}.json | Parameterized datafile URL by SDK key | + +A notification signal will be triggered whenever a _new_ datafile is +fetched and Project Config is updated. To subscribe to these +notifications, use: + +``` +notification_center.add_notification_listener(NotificationTypes.OPTIMIZELY_CONFIG_UPDATE, update_callback) +``` + +For Further details see the Optimizely [Feature Experimentation documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome) +to learn how to set up your first Python project and use the SDK. + +## SDK Development + +### Building the SDK + +Build and install the SDK with pip, using the following command: + + pip install -e . + +### Unit Tests + +#### Running all tests + +To get test dependencies installed, use a modified version of the +install command: + + pip install -e '.[test]' + +You can run all unit tests with: + + pytest + +#### Running all tests in a file + +To run all tests under a particular test file you can use the following +command: + + pytest tests. + +For example, to run all tests under `test_event_builder`, the command would be: + + pytest tests/test_event_builder.py + +#### Running all tests under a class + +To run all tests under a particular class of tests you can use the +following command: + + pytest tests/::ClassName + +For example, to run all tests under `test_event_builder.EventTest`, the command +would be: + + pytest tests/test_event_builder.py::EventTest + +#### Running a single test + +To run a single test you can use the following command: + + pytest tests/::ClassName::test_name + +For example, to run `test_event_builder.EventTest.test_init`, the command +would be: + + pytest tests/test_event_builder.py::EventTest::test_init + +### Contributing + +Please see [CONTRIBUTING](https://github.com/optimizely/python-sdk/blob/master/CONTRIBUTING.md). + +### Credits + +This software incorporates code from the following open source projects: + +requests (Apache-2.0 License: https://github.com/psf/requests/blob/master/LICENSE) + +pyOpenSSL (Apache-2.0 License https://github.com/pyca/pyopenssl/blob/main/LICENSE) + +cryptography (Apache-2.0 https://github.com/pyca/cryptography/blob/main/LICENSE.APACHE) + +idna (BSD 3-Clause License https://github.com/kjd/idna/blob/master/LICENSE.md) + +### Other Optimizely SDKs + +- Agent - https://github.com/optimizely/agent + +- Android - https://github.com/optimizely/android-sdk + +- C# - https://github.com/optimizely/csharp-sdk + +- Flutter - https://github.com/optimizely/optimizely-flutter-sdk + +- Go - https://github.com/optimizely/go-sdk + +- Java - https://github.com/optimizely/java-sdk + +- JavaScript - https://github.com/optimizely/javascript-sdk + +- PHP - https://github.com/optimizely/php-sdk + +- Python - https://github.com/optimizely/python-sdk + +- React - https://github.com/optimizely/react-sdk + +- Ruby - https://github.com/optimizely/ruby-sdk + +- Swift - https://github.com/optimizely/swift-sdk +# Optimizely Python SDK Changelog + +## 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](https://github.com/optimizely/python-sdk/pull/420)) + +## 4.1.0 +July 7th, 2022 + +### Bug Fixes +* Fix error log formatting for flag key ([#381](https://github.com/optimizely/python-sdk/pull/381)) +* Fix invalid datafile returned from `ProjectConfig.to_datafile` and `OptimizelyConfig.get_datafile` ([#321](https://github.com/optimizely/python-sdk/pull/321), [#384](https://github.com/optimizely/python-sdk/pull/384)) + + +## 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](https://github.com/optimizely/python-sdk/pull/361), [#365](https://github.com/optimizely/python-sdk/pull/365), [#369](https://github.com/optimizely/python-sdk/pull/369)): + - setForcedDecision + - getForcedDecision + - removeForcedDecision + - removeAllForcedDecisions + +* For details, refer to our documentation pages: [OptimizelyUserContext](https://docs.developers.optimizely.com/full-stack/v4.0/docs/optimizelyusercontext-python) and [Forced Decision methods](https://docs.developers.optimizely.com/full-stack/v4.0/docs/forced-decision-methods-python). + +### Breaking Changes: + +* Support for `Python v3.4` has been dropped as of this release due to a security vulnerability with `PyYAML