Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Unleash/unleash-client-python
Unleash client SDK for Python 💡💡💡
https://github.com/Unleash/unleash-client-python
client-library feature-flags feature-management feature-toggles hacktoberfest unleash unleash-server
Last synced: 30 days ago
JSON representation
Unleash client SDK for Python 💡💡💡
- Host: GitHub
- URL: https://github.com/Unleash/unleash-client-python
- Owner: Unleash
- License: mit
- Created: 2018-10-26T11:47:02.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T20:39:30.000Z (8 months ago)
- Last Synced: 2024-04-14T06:00:04.600Z (8 months ago)
- Topics: client-library, feature-flags, feature-management, feature-toggles, hacktoberfest, unleash, unleash-server
- Language: Python
- Homepage: http://unleash.github.io/unleash-client-python
- Size: 6.52 MB
- Stars: 78
- Watchers: 8
- Forks: 56
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# unleash-client-python
 [](https://coveralls.io/github/Unleash/unleash-client-python?branch=main) [](https://badge.fury.io/py/UnleashClient)  [](https://opensource.org/licenses/MIT)
This is the Python client for [Unleash](https://github.com/unleash/unleash). It implements [Client Specifications 1.0](https://docs.getunleash.io/client-specification) and checks compliance based on spec in [unleash/client-specifications](https://github.com/Unleash/client-specification)
What it supports:
* Default activation strategies using 32-bit [Murmurhash3](https://en.wikipedia.org/wiki/MurmurHash)
* Custom strategies
* Full client lifecycle:
* Client registers with Unleash server
* Client periodically fetches feature toggles and stores to on-disk cache
* Client periodically sends metrics to Unleash Server
* Tested on Linux (Ubuntu), OSX, and Windows
Check out the [project documentation](https://unleash.github.io/unleash-client-python/) and the [changelog](https://docs.getunleash.io/unleash-client-python/changelog.html).
## Installation
Check out the package on [Pypi](https://pypi.org/project/UnleashClient/)!
```bash
pip install UnleashClient
```
## Usage
### Initialization
```python
from UnleashClient import UnleashClient
client = UnleashClient(
url="https://unleash.herokuapp.com",
app_name="my-python-app",
custom_headers={'Authorization': ''})
client.initialize_client()
```
For more information about configuring `UnleashClient`, check out the [project reference docs](https://docs.getunleash.io/unleash-client-python/unleashclient.html)!
### Checking if a feature is enabled
A check of a simple toggle:
```python
client.is_enabled("my_toggle")
```
To supply application context, use the second positional argument:
```python
app_context = {"userId": "[email protected]"}
client.is_enabled("user_id_toggle", app_context)
```
#### Fallback function and default values
You can specify a fallback function for cases where the client doesn't recognize the toggle by using the `fallback_function` keyword argument:
```python
def custom_fallback(feature_name: str, context: dict) -> bool:
return True
client.is_enabled("my_toggle", fallback_function=custom_fallback)
```
You can also use the `fallback_function` argument to replace the obsolete `default_value` keyword argument by using a lambda that ignores its inputs. Whatever the lambda returns will be used as the default value.
```python
client.is_enabled("my_toggle", fallback_function=lambda feature_name, context: True)
```
The fallback function **must** accept the feature name and context as positional arguments in that order.
The client will evaluate the fallback function only if an exception occurs when calling the `is_enabled()` method. This happens when the client can't find the feature flag. The client _may_ also throw other, general exceptions.
For more information about usage, see the [Usage documentation](https://docs.getunleash.io/unleash-client-python/usage.html).
### Getting a variant
Checking for a variant:
```python
context = {'userId': '2'} # Context must have userId, sessionId, or remoteAddr. If none are present, distribution will be random.
variant = client.get_variant("variant_toggle", context)
print(variant)
> {
> "name": "variant1",
> "payload": {
> "type": "string",
> "value": "val1"
> },
> "enabled": True
> }
```
For more information about variants, see the [Variant documentation](https://docs.getunleash.io/advanced/toggle_variants).
## Developing
For development, you'll need to setup the environment to run the tests. This repository is using
tox to run the test suite to test against multiple versions of Python. Running the tests is as simple as running this command in the makefile:
```
tox -e py311
```
This command will take care of downloading the client specifications and putting them in the correct place in the repository, and install all the dependencies you need.
However, there are some caveats to this method. There is no easy way to run a single test, and running the entire test suite can be slow.
### Manual setup
First, make sure you have pip or pip3 installed.
Then setup your viritual environment:
Linux & Mac:
```
python3 -m venv venv
source venv/bin/activate
```
Windows + cmd:
```
python -m venv venv
venv\Scripts\activate.bat
```
Powershell:
```
python -m venv venv
venv\Scripts\activate.bat
```
Once you've done your setup, run:
```
pip install -r requirements.txt
```
Run the get-spec script to download the client specifications tests:
```
./scripts/get-spec.sh
```
Now you can run the tests by running `pytest` in the root directory.
In order to run a single test, run the following command:
```
pytest testfile.py::function_name
# example: pytest tests/unit_tests/test_client.py::test_consistent_results
```
### Linting
In order to lint all the files you can run the following command:
```
make fmt
```