FeatureManagement 1.0.0b1__tar.gz

featuremanagement-1.0.0b1/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Release History
+
+## 1.0.0b1 (05/22/2024)
+
+New Feature Management library.
+
+Provides the ability to manage feature flags in a project. Enables:
+
+* Loading of feature flags from a file, see: https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureManagement.v2.0.0.schema.json
+* Loading of feature flags from Azure App Configuration.
+* Checking if a feature is enabled.
+* Default feature filters: TimeWindowFilter, TargetingFilter.
+* Custom feature filters.

featuremanagement-1.0.0b1/CODE_OF_CONDUCT.md

@@ -0,0 +1,9 @@
+# Microsoft Open Source Code of Conduct
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+
+Resources:
+
+- [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/)
+- [Microsoft Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
+- Contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with questions or concerns

featuremanagement-1.0.0b1/FeatureManagement.egg-info/PKG-INFO

@@ -0,0 +1,340 @@
+Metadata-Version: 2.1
+Name: FeatureManagement
+Version: 1.0.0b1
+Summary: A library for enabling/disabling features at runtime.
+Home-page: https://github.com/Azure/azure-sdk-for-python/tree/main/sdk/appconfiguration/feature-management
+Author: Microsoft Corporation
+Author-email: Microsoft Corporation <appconfig@microsoft.com>
+License:     MIT License
+        
+            Copyright (c) Microsoft Corporation.
+        
+            Permission is hereby granted, free of charge, to any person obtaining a copy
+            of this software and associated documentation files (the "Software"), to deal
+            in the Software without restriction, including without limitation the rights
+            to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+            copies of the Software, and to permit persons to whom the Software is
+            furnished to do so, subject to the following conditions:
+        
+            The above copyright notice and this permission notice shall be included in all
+            copies or substantial portions of the Software.
+        
+            THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+            IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+            FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+            AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+            LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+            OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+            SOFTWARE
+        
+Project-URL: Homepage, https://github.com/microsoft/FeatureManagement-Python
+Project-URL: Issues, https://github.com/microsoft/FeatureManagement-Python/issues
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.6
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: appinsights
+Requires-Dist: azure-monitor-opentelemetry<2.0.0,>=1.3.0; extra == "appinsights"
+Requires-Dist: azure-monitor-events-extension<2.0.0; extra == "appinsights"
+
+# Microsoft Feature Management for Python
+
+Feature Management is a library for enabling/disabling features at runtime. Developers can use feature flags in simple use cases like conditional statement to more advanced scenarios like conditionally adding routes.
+
+## Getting started
+
+### Prerequisites
+
+* Python 3.7 or later is required to use this package.
+
+### Install the package
+
+Install the Python feature management client library for Python with [pip][pip]:
+
+```bash
+pip install microsoft-featuremanagement
+```
+
+## Usage
+
+You can use feature flags from the Azure App Configuration service, a json file, or a dictionary.
+
+### Use feature flags from Azure App Configuration
+
+```python
+from featuremanagement import FeatureManager
+from azure.appconfiguration.provider import load
+from azure.identity import DefaultAzureCredential
+import os
+
+endpoint = os.environ.get("APPCONFIGURATION_ENDPOINT_STRING")
+
+# If no setting selector is set then feature flags with no label are loaded.
+selects = {SettingSelector(key_filter=".appconfig.featureflag*")}
+
+config = load(endpoint=endpoint, credential=DefaultAzureCredential(), selects=selects)
+
+feature_manager = FeatureManager(config)
+
+# Prints the value of the feature flag Alpha
+print("Alpha is ", feature_manager.is_enabled("Alpha"))
+```
+
+### Use feature flags from a json file
+
+A Json file with the following format can be used to load feature flags.
+
+```json
+{
+    "feature_management": {
+        "feature_flags": [
+            {
+                "id": "Alpha",
+                "description": "",
+                "enabled": "true",
+                "conditions": {
+                    "client_filters": []
+                }
+            }
+        ]
+    }
+ }
+```
+
+Load feature flags from a json file.
+
+```python
+from featuremanagement import FeatureManager
+import json
+import os
+import sys
+
+script_directory = os.path.dirname(os.path.abspath(sys.argv[0]))
+
+f = open(script_directory + "/my_json_file.json", "r")
+
+feature_flags = json.load(f)
+
+feature_manager = FeatureManager(feature_flags)
+
+# Returns the value of Alpha, based on the result of the feature filter
+print("Alpha is ", feature_manager.is_enabled("Alpha"))
+```
+
+### Use feature flags from a dictionary
+
+```python
+from featuremanagement import FeatureManager
+
+feature_flags = {
+    "feature_management": {
+        "feature_flags": [
+            {
+                "id": "Alpha",
+                "description": "",
+                "enabled": "true",
+                "conditions": {
+                    "client_filters": []
+                }
+            }
+        ]
+    }
+}
+
+feature_manager = FeatureManager(feature_flags)
+
+# Is always true
+print("Alpha is ", feature_manager.is_enabled("Alpha"))
+```
+
+## Key concepts
+
+### FeatureManager
+
+The `FeatureManager` is the main entry point for using feature flags. It is initialized with a dictionary of feature flags, and optional feature filters. The `FeatureManager` can then be used to check if a feature is enabled or disabled.
+
+### Feature Flags
+
+Feature Flags are objects that define how Feature Management enables/disables a feature. It contains an `id` and `enabled` property. The `id` is a string that uniquely identifies the feature flag. The `enabled` property is a boolean that indicates if the feature flag is enabled or disabled. The `conditions` object contains a property `client_filters` which is a list of `FeatureFilter` objects that are used to determine if the feature flag is enabled or disabled. The Feature Filters only run if the feature flag is enabled.
+
+The full schema for a feature Flag can be found [here](https://github.com/Azure/AppConfiguration/blob/main/docs/FeatureManagement/FeatureFlag.v1.1.0.schema.json).
+
+```javascript
+{
+    "id": "Alpha",
+    "enabled": "true",
+    "conditions": {
+        "client_filters": [
+            {
+                "name": "MyFilter",
+                "parameters": {
+                    ...
+                }
+            }
+        ]
+    }
+}
+```
+
+This object is passed into the `FeatureManager` when it is initialized.
+
+### Feature Filters
+
+Feature filters enable dynamic evaluation of feature flags. The Python feature management library includes two built-in filters:
+
+- `Microsoft.TimeWindow` - Enables a feature flag based on a time window.
+- `Microsoft.Targeting` - Enables a feature flag based on a list of users, groups, or rollout percentages.
+
+#### Time Window Filter
+
+The Time Window Filter enables a feature flag based on a time window. It has two parameters:
+
+- `Start` - The start time of the time window.
+- `End` - The end time of the time window.
+
+```json
+{
+    "name": "Microsoft.TimeWindow",
+    "parameters": {
+        "Start": "2020-01-01T00:00:00Z",
+        "End": "2020-12-31T00:00:00Z"
+    }
+}
+```
+
+Both parameters are optional, but at least one is required. The time window filter is enabled after the start time and before the end time. If the start time is not specified, it is enabled immediately. If the end time is not specified, it will remain enabled after the start time.
+
+#### Targeting Filter
+
+Targeting is a feature management strategy that enables developers to progressively roll out new features to their user base. The strategy is built on the concept of targeting a set of users known as the target audience. An audience is made up of specific users, groups, excluded users/groups, and a designated percentage of the entire user base. The groups that are included in the audience can be broken down further into percentages of their total members.
+
+The following steps demonstrate an example of a progressive rollout for a new 'Beta' feature:
+
+1. Individual users Jeff and Alicia are granted access to the Beta
+1. Another user, Mark, asks to opt-in and is included.
+1. Twenty percent of a group known as "Ring1" users are included in the Beta.
+1. The number of "Ring1" users included in the beta is bumped up to 100 percent.
+1. Five percent of the user base is included in the beta.
+1. The rollout percentage is bumped up to 100 percent and the feature is completely rolled out.
+
+This strategy for rolling out a feature is built in to the library through the included Microsoft.Targeting feature filter.
+
+##### Defining a Targeting Feature Filter
+
+The Targeting Filter provides the capability to enable a feature for a target audience. The filter parameters include an `Audience` object which describes users, groups, excluded users/groups, and a default percentage of the user base that should have access to the feature. The `Audience` object contains the following fields:
+
+- `Users` - A list of users that the feature flag is enabled for.
+- `Groups` - A list of groups that the feature flag is enabled for and a rollout percentage for each group.
+  - `Name` - The name of the group.
+  - `RolloutPercentage` - A percentage value that the feature flag is enabled for in the given group.
+- `DefaultRolloutPercentage` - A percentage value that the feature flag is enabled for.
+- `Exclusion` - An object that contains a list of users and groups that the feature flag is disabled for.
+  - `Users` - A list of users that the feature flag is disabled for.
+  - `Groups` - A list of groups that the feature flag is disabled for.
+
+```json
+{
+    "name": "Microsoft.Targeting",
+    "parameters": {
+        "Audience": {
+            "Users": ["user1", "user2"],
+            "Groups": [
+                {
+                    "Name": "group1",
+                    "RolloutPercentage": 100
+                }
+            ],
+            "DefaultRolloutPercentage": 50,
+            "Exclusion": {
+                "Users": ["user3"],
+                "Groups": ["group2"]
+            }
+        }
+    }
+}
+```
+
+##### Using Targeting Feature Filter
+
+You can provide the current user info through `kwargs` when calling `isEnabled`.
+
+```python
+from featuremanagement import FeatureManager, TargetingContext
+
+# Returns true, because user1 is in the Users list
+feature_manager.is_enabled("Beta", TargetingContext(user_id="user1", groups=["group1"]))
+
+# Returns false, because group2 is in the Exclusion.Groups list
+feature_manager.is_enabled("Beta", TargetingContext(user_id="user1", groups=["group2"]))
+
+# Has a 50% chance of returning true, but will be conisistent for the same user
+feature_manager.is_enabled("Beta", TargetingContext(user_id="user4"))
+```
+
+#### Custom Filters
+
+You can also create your own feature filters by implementing the `FeatureFilter` interface.
+
+```python
+class MyCustomFilter(FeatureFilter):
+
+    def evaluate(self, context, **kwargs):
+        ...
+        return True
+```
+
+They can then be passed into the `FeatureManager` when it is initialized. By default, the name of a feature filter is the name of the class. You can override this by setting a class attribute `alias` to the modified class name.
+
+```python
+
+feature_manager = FeatureManager(feature_flags, feature_filters={MyCustomFilter(), MyOtherFilter()})
+```
+
+The `evaluate` method is called when checking if a feature flag is enabled. The `context` parameter contains information about the feature filter from the `parameters` field of the feature filter. Any additional parameters can be passed in as keyword arguments when calling `is_enabled`.
+
+```javascript
+{
+    "name": "CustomFilter",
+    "parameters": {
+        ...
+    }
+}
+```
+
+You can modify the name of a feature flag by using the `@FeatureFilter.alias` decorator. The alias overrides the name of the feature filter and needs to match the name of the feature filter in the feature flag json.
+
+```python
+@FeatureFilter.alias("AliasFilter")
+class MyCustomFilter(FeatureFilter):
+    ...
+```
+
+## Contributing
+
+This project welcomes contributions and suggestions.  Most contributions require you to agree to a
+Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
+the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
+
+When you submit a pull request, a CLA bot will automatically determine whether you need to provide
+a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions
+provided by the bot. You will only need to do this once across all repos using our CLA.
+
+This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
+For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
+contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
+
+## Trademarks
+
+This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft 
+trademarks or logos is subject to and must follow 
+[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
+Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
+Any use of third-party trademarks or logos are subject to those third-party's policies.

featuremanagement-1.0.0b1/FeatureManagement.egg-info/SOURCES.txt

@@ -0,0 +1,41 @@
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE
+MANIFEST.in
+README.md
+SECURITY.md
+SUPPORT.md
+pyproject.toml
+setup.py
+FeatureManagement.egg-info/PKG-INFO
+FeatureManagement.egg-info/SOURCES.txt
+FeatureManagement.egg-info/dependency_links.txt
+FeatureManagement.egg-info/not-zip-safe
+FeatureManagement.egg-info/requires.txt
+FeatureManagement.egg-info/top_level.txt
+featuremanagement/__init__.py
+featuremanagement/_defaultfilters.py
+featuremanagement/_featurefilters.py
+featuremanagement/_featuremanager.py
+featuremanagement/_version.py
+featuremanagement/py.typed
+featuremanagement/_models/__init__.py
+featuremanagement/_models/_constants.py
+featuremanagement/_models/_evaluation_event.py
+featuremanagement/_models/_feature_conditions.py
+featuremanagement/_models/_feature_flag.py
+featuremanagement/_models/_targeting_context.py
+featuremanagement/aio/__init__.py
+featuremanagement/aio/_defaultfilters.py
+featuremanagement/aio/_featurefilters.py
+featuremanagement/aio/_featuremanager.py
+samples/feature_flag_sample.py
+samples/feature_flag_with_azure_app_configuration_sample.py
+samples/formatted_feature_flags.json
+samples/random_filter.py
+tests/test_default_feature_flags.py
+tests/test_default_feature_flags_async.py
+tests/test_feature_manager.py
+tests/test_feature_manager_async.py
+tests/test_feature_manager_refresh.py
+tests/validation_tests/test_json_validations.py

featuremanagement-1.0.0b1/FeatureManagement.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

featuremanagement-1.0.0b1/FeatureManagement.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

featuremanagement-1.0.0b1/FeatureManagement.egg-info/requires.txt

@@ -0,0 +1,4 @@
+
+[AppInsights]
+azure-monitor-opentelemetry<2.0.0,>=1.3.0
+azure-monitor-events-extension<2.0.0

featuremanagement-1.0.0b1/FeatureManagement.egg-info/top_level.txt

@@ -0,0 +1 @@
+featuremanagement

featuremanagement-1.0.0b1/LICENSE

@@ -0,0 +1,21 @@
+    MIT License
+
+    Copyright (c) Microsoft Corporation.
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to deal
+    in the Software without restriction, including without limitation the rights
+    to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+    copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+
+    The above copyright notice and this permission notice shall be included in all
+    copies or substantial portions of the Software.
+
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+    AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+    LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+    OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+    SOFTWARE

featuremanagement-1.0.0b1/MANIFEST.in

@@ -0,0 +1,6 @@
+recursive-include tests *.py
+include *.md
+include LICENSE
+include featuremanagement/*.py
+include featuremanagement/aio/*.py
+recursive-include samples *.py *.json