Skip to main content

Python server SDK

Project description

IBM Cloud App Configuration Python server SDK

Repository for IBM Cloud App Configuration Python server SDK

Install SDK

To install, use pip or easy_install:

pip install --upgrade ibm-appconfiguration-python-sdk

or

 easy_install --upgrade ibm-appconfiguration-python-sdk

Import the SDK

from ibm_appconfiguration import AppConfiguration, Feature, FeatureType

Initialize SDK

app_config = AppConfiguration.get_instance()
app_config.init(region=AppConfiguration.REGION_US_SOUTH,
               guid='GUID',
               apikey='APIKEY')

## Initialize feature 
app_config.set_collection_id(collection_id='collection_id') 

## set the file or offline feature
app_config.fetch_features_from_file(feature_file='custom/userJson.json', # Add this field if liveFeatureUpdateEnabled false or get features when the device is offline during the first app load.
                                    live_feature_update_enabled=True) # This is for live update from server.
  • region : Region name where the service instance is created. Eg: AppConfiguration.REGION_US_SOUTH
  • guid : GUID of the App Configuration service. Get it from the service credentials section of the dashboard
  • apikey : ApiKey of the App Configuration service. Get it from the service credentials section of the dashboard
  • collection_id : Id of the collection created in App Configuration service instance.
  • feature_file : Path to the JSON file which contains feature details and segment details. r
  • live_feature_update_enabled : Set this value to false if the new feature values shouldn't be fetched from the server. Make sure to provide a proper JSON file in the feature_file path. By default, this value is enabled.

Set listener for feature data changes

def features_update(self):
    print('Get your Feature value NOW')

app_config.register_features_update_listener(features_update)

Get single feature

feature = app_config.get_feature('feature_id')

Get all features

features_dictionary = app_config.get_features()

Evaluate a feature

identity = {
    'city': 'Bangalore',
    'country': 'India'
}
feature_value = feature.get_current_value(identity_id='pvQr45', identity_attributes=identity)

Fetch latest data

app_config.fetch_feature_data()

License

This project is released under the Apache 2.0 license. The license's full text can be found in LICENSE

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

srikanth-test-python-sdk-1.0.1.tar.gz (18.4 kB view hashes)

Uploaded Source

Built Distribution

srikanth_test_python_sdk-1.0.1-py3-none-any.whl (68.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page