harness-featureflags 1.1.5

Feature flag server SDK for python

Python SDK For Harness Feature Flags

Table of Contents

Intro
Requirements
Quickstart
Further Reading
Build Instructions

Intro

Use this README to get started with our Feature Flags (FF) SDK for Python. This guide outlines the basics of getting started with the SDK and provides a full code sample for you to try out. This sample doesn’t include configuration options, for in depth steps and configuring the SDK, for example, disabling streaming or using our Relay Proxy, see the Python SDK Reference.

For a sample FF Python SDK project, see our test test python project.

Requirements

Python 3.7 or newer (python --version)
pip

For Mac users if you don't already have pyenv or something similar installed for managing python version

Quickstart

To follow along with our test code sample, make sure you’ve:

• Created a Feature Flag on the Harness Platform called harnessappdemodarkmode
• Created a server SDK key and made a copy of it

Install the SDK

Install the python SDK using pip

python -m pip install harness-featureflags

Code Sample

The following is a complete code example that you can use to test the harnessappdemodarkmode Flag you created on the Harness Platform. When you run the code it will:

• Connect to the FF service.
• Report the value of the Flag every 10 seconds until the connection is closed. Every time the harnessappdemodarkmode Flag is toggled on or off on the Harness Platform, the updated value is reported.
• Close the SDK.

from featureflags.client import CfClient
from featureflags.config import *
from featureflags.evaluations.auth_target import Target
from featureflags.util import log
import os
import time

# API Key
apiKey = os.getenv('FF_API_KEY', "changeme")

# Flag Name
flagName = os.getenv('FF_FLAG_NAME', "harnessappdemodarkmode")

def main():    
    # Create a Feature Flag Client
    client = CfClient(apiKey)

    # Create a target (different targets can get different results based on rules.  This include a custom attribute 'location')
    target = Target(identifier='pythonSDK', name="PythonSDK", attributes={"location": "emea"})

    # Loop forever reporting the state of the flag
    while True:
        result = client.bool_variation(flagName, target, False)
        log.info("Flag variation %s", result)
        time.sleep(10)

    close()


if __name__ == "__main__":
    main()

Running the example

$ export FF_API_KEY=<your key here>
$ python3 examples/getting_started/getting_started.py

Running the example with Docker

If you dont have the right version of python installed locally, or dont want to install the dependancies you can use docker to quickly get started

# Install the package
docker run -v $(pwd):/app -w /app python:3.7-slim python -m pip install -t ./local  harness-featureflags

# Run the script
docker run  -e PYTHONPATH=/app/local -e FF_API_KEY=$FF_API_KEY -v $(pwd):/app -w /app python:3.7-slim python examples/getting_started/getting_started.py

Additional Reading

For further examples and config options, see the Python SDK Reference.

For more information about Feature Flags, see our Feature Flags documentation.

---

Harness is a feature management platform that helps teams to build better software and to test features quicker.

---

======= History

1.0.1 (2021-07-07)

• First release on PyPI.