1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
|
%global _empty_manifest_terminate_build 0
Name: python-UnleashClient
Version: 5.6.0
Release: 1
Summary: Python client for the Unleash feature toggle system!
License: MIT License
URL: https://github.com/Unleash/unleash-client-python
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/45/54/990c1faabd40bb0a089847ffea291720c71c3b7710462312c7a566ebac9d/UnleashClient-5.6.0.tar.gz
BuildArch: noarch
Requires: python3-requests
Requires: python3-fcache
Requires: python3-mmhash3
Requires: python3-apscheduler
Requires: python3-importlib-metadata
Requires: python3-dateutil
Requires: python3-semver
%description
# 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://github.com/Unleash/unleash/blob/main/docs/client-specification.md) 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
```
## For Flask Users
If you're looking into running Unleash from Flask, you might want to take a look at [_Flask-Unleash_, the Unleash Flask extension](https://github.com/Unleash/Flask-Unleash). The extension builds upon this SDK to reduce the amount of boilerplate code you need to write to integrate with Flask. Of course, if you'd rather use this package directly, that will work too.
## Usage
### Initialization
```python
from UnleashClient import UnleashClient
client = UnleashClient(
url="https://unleash.herokuapp.com",
app_name="my-python-app",
custom_headers={'Authorization': '<API token>'})
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": "test@email.com"}
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).
%package -n python3-UnleashClient
Summary: Python client for the Unleash feature toggle system!
Provides: python-UnleashClient
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-UnleashClient
# 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://github.com/Unleash/unleash/blob/main/docs/client-specification.md) 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
```
## For Flask Users
If you're looking into running Unleash from Flask, you might want to take a look at [_Flask-Unleash_, the Unleash Flask extension](https://github.com/Unleash/Flask-Unleash). The extension builds upon this SDK to reduce the amount of boilerplate code you need to write to integrate with Flask. Of course, if you'd rather use this package directly, that will work too.
## Usage
### Initialization
```python
from UnleashClient import UnleashClient
client = UnleashClient(
url="https://unleash.herokuapp.com",
app_name="my-python-app",
custom_headers={'Authorization': '<API token>'})
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": "test@email.com"}
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).
%package help
Summary: Development documents and examples for UnleashClient
Provides: python3-UnleashClient-doc
%description help
# 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://github.com/Unleash/unleash/blob/main/docs/client-specification.md) 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
```
## For Flask Users
If you're looking into running Unleash from Flask, you might want to take a look at [_Flask-Unleash_, the Unleash Flask extension](https://github.com/Unleash/Flask-Unleash). The extension builds upon this SDK to reduce the amount of boilerplate code you need to write to integrate with Flask. Of course, if you'd rather use this package directly, that will work too.
## Usage
### Initialization
```python
from UnleashClient import UnleashClient
client = UnleashClient(
url="https://unleash.herokuapp.com",
app_name="my-python-app",
custom_headers={'Authorization': '<API token>'})
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": "test@email.com"}
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).
%prep
%autosetup -n UnleashClient-5.6.0
%build
%py3_build
%install
%py3_install
install -d -m755 %{buildroot}/%{_pkgdocdir}
if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi
if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi
if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi
if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi
pushd %{buildroot}
if [ -d usr/lib ]; then
find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/lib64 ]; then
find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/bin ]; then
find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst
fi
if [ -d usr/sbin ]; then
find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst
fi
touch doclist.lst
if [ -d usr/share/man ]; then
find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst
fi
popd
mv %{buildroot}/filelist.lst .
mv %{buildroot}/doclist.lst .
%files -n python3-UnleashClient -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 5.6.0-1
- Package Spec generated
|
