The DevCycle Python SDK used for feature management.
This SDK allows your application to interface with the DevCycle Bucketing API.
- Python 3.7+
pip install devcycle-python-server-sdk(you may need to run pip with root permission: sudo pip install devcycle-python-server-sdk)
The core DevCycle objects are in the devcycle_python_sdk package. To get started, import the DevCycleLocalClient class and the DevCycleLocalOptions class. The DevCycleLocalClient class is used to interact with the DevCycle API. The
94D2
DevCycleLocalOptions class is used to configure the client.
from devcycle_python_sdk import DevCycleLocalClient, DevCycleLocalOptions
from devcycle_python_sdk.models.user import DevCycleUser
options = DevCycleLocalOptions()
# create an instance of the client class
client = DevCycleLocalClient('DEVCYCLE_SERVER_SDK_KEY', options)
user = DevCycleUser(
user_id='test',
email='example@example.ca',
country='CA'
)
value = client.variable_value(user, 'variable-key', 'default-value')The DevCycle client is designed to work as a singleton in your application. You should create a single instance of the client during application initialization
To find usage documentation, visit our docs.
When developing the SDK it is recommended that you have both a 3.7 and 3.11 python interpreter installed in order to verify changes across different versions of python.
To set up dependencies for local development, run:
pip install -r requirements.test.txt
To run the example app against the local version of the API for testing and development, run:
pip install --editable .from the top level of the repo (same level as setup.py). Then run the example app as normal.
Linting checks on PRs are run using ruff, and are configured using .ruff.toml. To run the linter locally, run this command from the top level of the repo:
ruff check .
Ruff can automatically fix simple linting errors (the ones marked with [*]). To do so, run:
ruff check . --fix
Formatting checks on PRs are done using black. To run the formatter locally, run this command from the top level of the repo:
black .
To run the unit tests, run:
pytestTo run the benchmarks, run:
pytest --benchmark-onlyTo generate the protobuf source files run the following from the root of the project. Ensure you have protoc installed.
protoc --proto_path=./protobuf/ --python_out=devcycle_python_sdk/protobuf --pyi_out=devcycle_python_sdk/protobuf variableForUserParams.protoThis will rebuild the variableForUserParams_pb2.py file. DO NOT edit this file directly.