Skip to content

Commit f52e50d

Browse files
[FSSDK-8954] docs: change full stack to feature experimentation (#420)
* change full stack to feature experimentation
1 parent f000c6e commit f52e50d

File tree

2 files changed

+59
-34
lines changed

2 files changed

+59
-34
lines changed

README.md

+54-30
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,25 @@
33
[![PyPI version](https://badge.fury.io/py/optimizely-sdk.svg)](https://pypi.org/project/optimizely-sdk)
44
[![Build Status](https://github.com/optimizely/python-sdk/actions/workflows/python.yml/badge.svg?branch=master)](https://github.com/optimizely/python-sdk/actions/workflows/python.yml?query=branch%3Amaster)
55
[![Coverage Status](https://coveralls.io/repos/github/optimizely/python-sdk/badge.svg)](https://coveralls.io/github/optimizely/python-sdk)
6-
[![Documentation Status](https://readthedocs.org/projects/optimizely-python-sdk/badge/?version=latest)](https://optimizely-python-sdk.readthedocs.io/en/latest/?badge=latest)
76
[![Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
87

9-
This repository houses the official Python SDK for use with Optimizely
10-
Full Stack and Optimizely Rollouts.
8+
This repository houses the Python SDK for use with Optimizely Feature Experimentation and Optimizely Full Stack (legacy).
119

12-
Optimizely Full Stack is A/B testing and feature flag management for
13-
product development teams. Experiment in any application. Make every
14-
feature on your roadmap an opportunity to learn. Learn more at
15-
<https://www.optimizely.com/platform/full-stack/>, or see the [Full
16-
Stack
17-
documentation](https://docs.developers.optimizely.com/full-stack/docs).
10+
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).
1811

19-
Optimizely Rollouts is free feature flags for development teams. Easily
20-
roll out and roll back features in any application without code deploys.
21-
Mitigate risk for every feature on your roadmap. Learn more at
22-
<https://www.optimizely.com/rollouts/>, or see the [Rollouts
23-
documentation](https://docs.developers.optimizely.com/rollouts/docs).
12+
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.
2413

25-
## Getting Started
14+
## Get Started
15+
16+
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.
2617

2718
### Requirements
2819

2920
Version `4.0+`: Python 3.7+, PyPy 3.7+
3021

3122
Version `3.0+`: Python 2.7+, PyPy 3.4+
3223

33-
### Installing the SDK
24+
### Install the SDK
3425

3526
The SDK is available through [PyPi](https://pypi.python.org/pypi?name=optimizely-sdk&:action=display).
3627

@@ -41,9 +32,11 @@ To install:
4132
### Feature Management Access
4233

4334
To access the Feature Management configuration in the Optimizely
44-
dashboard, please contact your Optimizely account executive.
35+
dashboard, please contact your Optimizely customer success manager.
36+
37+
## Use the Python SDK
4538

46-
### Using the SDK
39+
### Initialization
4740

4841
You can initialize the Optimizely instance in three ways: with a datafile, by providing an sdk_key, or by providing an implementation of
4942
[BaseConfigManager](https://github.com/optimizely/python-sdk/tree/master/optimizely/config_manager.py#L32).
@@ -85,7 +78,7 @@ Each method is described below.
8578
config_manager=custom_config_manager
8679
)
8780

88-
#### PollingConfigManager
81+
### PollingConfigManager
8982

9083
The [PollingConfigManager](https://github.com/optimizely/python-sdk/blob/master/optimizely/config_manager.py#L150) asynchronously polls for
9184
datafiles from a specified URL at regular intervals by making HTTP requests.
@@ -126,7 +119,7 @@ used to form the target URL.
126119
You may also provide your own logger, error_handler, or
127120
notification_center.
128121

129-
#### AuthDatafilePollingConfigManager
122+
### AuthDatafilePollingConfigManager
130123

131124
The [AuthDatafilePollingConfigManager](https://github.com/optimizely/python-sdk/blob/master/optimizely/config_manager.py#L375)
132125
implements `PollingConfigManager` and asynchronously polls for authenticated datafiles from a specified URL at regular intervals
@@ -143,7 +136,7 @@ your project and generate an access token for your datafile.
143136

144137
**datafile_access_token** The datafile_access_token is attached to the outbound HTTP request header to authorize the request and fetch the datafile.
145138

146-
#### Advanced configuration
139+
### Advanced configuration
147140

148141
The following properties can be set to override the default
149142
configurations for [PollingConfigManager](#pollingconfigmanager) and [AuthDatafilePollingConfigManager](#authdatafilepollingconfigmanager).
@@ -164,18 +157,18 @@ notifications, use:
164157
notification_center.add_notification_listener(NotificationTypes.OPTIMIZELY_CONFIG_UPDATE, update_callback)
165158
```
166159

167-
For Further details see the Optimizely [Full Stack documentation](https://docs.developers.optimizely.com/full-stack/docs)
160+
For Further details see the Optimizely [Feature Experimentation documentation](https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome)
168161
to learn how to set up your first Python project and use the SDK.
169162

170-
## Development
163+
## SDK Development
171164

172165
### Building the SDK
173166

174167
Build and install the SDK with pip, using the following command:
175168

176169
pip install -e .
177170

178-
### Unit tests
171+
### Unit Tests
179172

180173
#### Running all tests
181174

@@ -226,9 +219,40 @@ would be:
226219

227220
Please see [CONTRIBUTING](https://github.com/optimizely/python-sdk/blob/master/CONTRIBUTING.md).
228221

229-
### Additional Code
230-
This software incorporates code from the following open source repos:
231-
requests (Apache-2.0 License: https://github.com/psf/requests/blob/master/LICENSE)
232-
pyOpenSSL (Apache-2.0 License https://github.com/pyca/pyopenssl/blob/main/LICENSE)
233-
cryptography (Apache-2.0 https://github.com/pyca/cryptography/blob/main/LICENSE.APACHE)
234-
idna (BSD 3-Clause License https://github.com/kjd/idna/blob/master/LICENSE.md)
222+
### Credits
223+
224+
This software incorporates code from the following open source projects:
225+
226+
requests (Apache-2.0 License: https://github.com/psf/requests/blob/master/LICENSE)
227+
228+
pyOpenSSL (Apache-2.0 License https://github.com/pyca/pyopenssl/blob/main/LICENSE)
229+
230+
cryptography (Apache-2.0 https://github.com/pyca/cryptography/blob/main/LICENSE.APACHE)
231+
232+
idna (BSD 3-Clause License https://github.com/kjd/idna/blob/master/LICENSE.md)
233+
234+
### Other Optimizely SDKs
235+
236+
- Agent - https://github.com/optimizely/agent
237+
238+
- Android - https://github.com/optimizely/android-sdk
239+
240+
- C# - https://github.com/optimizely/csharp-sdk
241+
242+
- Flutter - https://github.com/optimizely/optimizely-flutter-sdk
243+
244+
- Go - https://github.com/optimizely/go-sdk
245+
246+
- Java - https://github.com/optimizely/java-sdk
247+
248+
- JavaScript - https://github.com/optimizely/javascript-sdk
249+
250+
- PHP - https://github.com/optimizely/php-sdk
251+
252+
- Python - https://github.com/optimizely/python-sdk
253+
254+
- React - https://github.com/optimizely/react-sdk
255+
256+
- Ruby - https://github.com/optimizely/ruby-sdk
257+
258+
- Swift - https://github.com/optimizely/swift-sdk

setup.py

+5-4
Original file line numberDiff line numberDiff line change
@@ -24,16 +24,17 @@
2424
CHANGELOG = _file.read()
2525

2626
about_text = (
27-
'Optimizely X Full Stack is A/B testing and feature management for product development teams. '
27+
'Optimizely Feature Experimentation is A/B testing and feature management for product development teams. '
2828
'Experiment in any application. Make every feature on your roadmap an opportunity to learn. '
29-
'Learn more at https://www.optimizely.com/products/full-stack/ or see our documentation at '
30-
'https://docs.developers.optimizely.com/full-stack/docs. '
29+
'Learn more at https://www.optimizely.com/products/experiment/feature-experimentation/ or see our documentation at '
30+
'https://docs.developers.optimizely.com/experimentation/v4.0.0-full-stack/docs/welcome. '
3131
)
3232

3333
setup(
3434
name='optimizely-sdk',
3535
version=__version__,
36-
description='Python SDK for Optimizely X Full Stack.',
36+
description='Python SDK for Optimizely Feature Experimentation, Optimizely Full Stack (legacy), '
37+
'and Optimizely Rollouts.',
3738
long_description=about_text + README + CHANGELOG,
3839
long_description_content_type='text/markdown',
3940
author='Optimizely',

0 commit comments

Comments
 (0)