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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
|
%global _empty_manifest_terminate_build 0
Name: python-nanowire-service-py
Version: 3.0.2
Release: 1
Summary: Wrapper for interacting with Nanowire platform
License: MIT
URL: https://github.com/SpotlightData/nanowire-service-py
Source0: https://mirrors.aliyun.com/pypi/web/packages/95/61/7a6a65eecf46a684cb1bdd200bada897de31d03df79f53f4e1a54de79af6/nanowire-service-py-3.0.2.tar.gz
BuildArch: noarch
Requires: python3-pydantic
Requires: python3-loguru
Requires: python3-dapr
%description
# nanowire-service-py
<div align="center">
[](https://github.com/SpotlightData/nanowire-service-py/actions?query=workflow%3Abuild)
[](https://pypi.org/project/nanowire-service-py/)
[](https://github.com/SpotlightData/nanowire-service-py/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/psf/black)
[](https://github.com/PyCQA/bandit)
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/.pre-commit-config.yaml)
[](https://github.com/SpotlightData/nanowire-service-py/releases)
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE)
Wrapper for interacting with Nanowire platform
</div>
## Usage
Install the library via `pip install nanowire-service-py`, or by adding it to requirements file and running `pip install -r requirements.txt`
This library is designed for tight integration with Nanowire platform (created by Spotlight Data).
The library does not have a hardcode requirement for a specific web server, so a another framework like django or flask could be utilised, however, I'd recommend using [fastapi](https://fastapi.tiangolo.com/) due to it's simplicity and speed
### Environment
The following environment variables need to be supplied:
```python
class Environment(BaseModel):
# Dapr spect
DAPR_HTTP_PORT: int
DAPR_APP_ID: str
PUB_SUB: str
# Where /pending requests get made
SCHEDULER_PUB_SUB: str
# Dapr related properties
# Whether we should wait for DAPR server to be active before loading
NO_WAIT: bool = False
# Whether the service should publish to schduler
# This shouldn't be done if we have an "executor" worker
NO_PUBLISH: bool = False
LOG_LEVEL: Union[str, int] = "DEBUG"
# Postgres connection details
POSTGRES_URL: str
POSTGRES_SCHEMA: str
# Utilised for healthchecks and identifying the pod
SERVICE_ID: str = str(uuid.uuid4())
```
This will be verified on service startup.
### Entrypoint
The primary code logic should be placed in a sub-class of `BaseHandler`. User is expected to implement `validate_args` as well as `handle_body` methods:
```python
import os
from dotenv import load_dotenv
from fastapi import FastAPI, Response
from pydantic import BaseModel, validator
from typing import Any, List, Optional
import pandas as pd
from nanowire_service_py import BaseHandler, create, TaskBody
from toolbox import ClusterTool
load_dotenv()
allowed_methods = ["HDBSCAN", "DBSCAN"]
# pydantic used to verify function body
class Arguments(BaseModel):
contentUrl: str
textCol: str
indexCol: str
clusterSize: float = 0.2
nLabels: int = 10
method: str = "DBSCAN"
customStops: Optional[List[str]] = []
maxVocab: int = 5000
memSave: bool = False
withAnomalous: bool = False
@validator('method')
def method_check(cls, method):
if method not in allowed_methods:
raise ValueError("Method has to be one of: {}, received: {}".format(",".join(allowed_methods), method))
return method
# Our custom handler
class MyHandler(BaseHandler):
def __init__(self, *args):
super().__init__(*args)
self.cluster_tool = ClusterTool(self.logger)
def validate_args(self, args: Any, task_id: str) -> Arguments:
return Arguments(**args)
def handle_body(self, args: Arguments, meta: Any, task_id: str):
df = pd.read_csv(args.contentUrl, dtype='unicode')
if args.textCol not in df.columns:
raise RuntimeError("Could not find text column '{}' in CSV".format(args.textCol), { "origin": "CSV"})
if args.indexCol not in df.columns:
raise RuntimeError("Could not find index column '{}' in CSV".format(args.indexCol), { "origin": "CSV"})
result = self.cluster_tool.main(df, args)
return (result, meta)
# Always handled by the library, pass environment directly
executor = create(os.environ, MyHandler)
app = FastAPI()
# Let's DAPR know which topics should be subscribed to
@app.get("/dapr/subscribe")
def subscribe():
return executor.subscriptions
# Primary endpoint, where request will be delivered to
# TaskBody type here verifies the post body
@app.post("/subscription")
def subscription(body: TaskBody, response: Response):
status = executor.handle_request(body.data.id)
response.status_code = status
# Return empty body so dapr doesn't freak out
return {}
# Start heartbeat thread, which will periodically send updates to database
executor.heartbeat()
```
Assuming the filename is `main.py` the server can then be started via `uvicorn main:app`
### Handling failure
The primary validation happens within `validate_args` function by `pydantic` models. This is where anything related to input should be checked.
If at any point you want the current task to fail, raise `RuntimeError` or `Exception`. This will indicate the library, that we should fail and not retry again. For example:
- CSV missing columns or having incorrect text format
- Not enough data passed
Anything else that raises for a retryable error, should be raised via `RetryError`.
## Versioning
Versioning is based on [semver](https://semver.org/), however, it primarily applies to the `create` function exposed by the package.
If you're using any of the internal system parts, make sure to validate before updating the version.
## Contributing
Read [CONTRIBUTING.md](CONTRIBUTING.md)
## 🛡 License
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE) for more details.
## Credits
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template).
%package -n python3-nanowire-service-py
Summary: Wrapper for interacting with Nanowire platform
Provides: python-nanowire-service-py
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-nanowire-service-py
# nanowire-service-py
<div align="center">
[](https://github.com/SpotlightData/nanowire-service-py/actions?query=workflow%3Abuild)
[](https://pypi.org/project/nanowire-service-py/)
[](https://github.com/SpotlightData/nanowire-service-py/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/psf/black)
[](https://github.com/PyCQA/bandit)
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/.pre-commit-config.yaml)
[](https://github.com/SpotlightData/nanowire-service-py/releases)
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE)
Wrapper for interacting with Nanowire platform
</div>
## Usage
Install the library via `pip install nanowire-service-py`, or by adding it to requirements file and running `pip install -r requirements.txt`
This library is designed for tight integration with Nanowire platform (created by Spotlight Data).
The library does not have a hardcode requirement for a specific web server, so a another framework like django or flask could be utilised, however, I'd recommend using [fastapi](https://fastapi.tiangolo.com/) due to it's simplicity and speed
### Environment
The following environment variables need to be supplied:
```python
class Environment(BaseModel):
# Dapr spect
DAPR_HTTP_PORT: int
DAPR_APP_ID: str
PUB_SUB: str
# Where /pending requests get made
SCHEDULER_PUB_SUB: str
# Dapr related properties
# Whether we should wait for DAPR server to be active before loading
NO_WAIT: bool = False
# Whether the service should publish to schduler
# This shouldn't be done if we have an "executor" worker
NO_PUBLISH: bool = False
LOG_LEVEL: Union[str, int] = "DEBUG"
# Postgres connection details
POSTGRES_URL: str
POSTGRES_SCHEMA: str
# Utilised for healthchecks and identifying the pod
SERVICE_ID: str = str(uuid.uuid4())
```
This will be verified on service startup.
### Entrypoint
The primary code logic should be placed in a sub-class of `BaseHandler`. User is expected to implement `validate_args` as well as `handle_body` methods:
```python
import os
from dotenv import load_dotenv
from fastapi import FastAPI, Response
from pydantic import BaseModel, validator
from typing import Any, List, Optional
import pandas as pd
from nanowire_service_py import BaseHandler, create, TaskBody
from toolbox import ClusterTool
load_dotenv()
allowed_methods = ["HDBSCAN", "DBSCAN"]
# pydantic used to verify function body
class Arguments(BaseModel):
contentUrl: str
textCol: str
indexCol: str
clusterSize: float = 0.2
nLabels: int = 10
method: str = "DBSCAN"
customStops: Optional[List[str]] = []
maxVocab: int = 5000
memSave: bool = False
withAnomalous: bool = False
@validator('method')
def method_check(cls, method):
if method not in allowed_methods:
raise ValueError("Method has to be one of: {}, received: {}".format(",".join(allowed_methods), method))
return method
# Our custom handler
class MyHandler(BaseHandler):
def __init__(self, *args):
super().__init__(*args)
self.cluster_tool = ClusterTool(self.logger)
def validate_args(self, args: Any, task_id: str) -> Arguments:
return Arguments(**args)
def handle_body(self, args: Arguments, meta: Any, task_id: str):
df = pd.read_csv(args.contentUrl, dtype='unicode')
if args.textCol not in df.columns:
raise RuntimeError("Could not find text column '{}' in CSV".format(args.textCol), { "origin": "CSV"})
if args.indexCol not in df.columns:
raise RuntimeError("Could not find index column '{}' in CSV".format(args.indexCol), { "origin": "CSV"})
result = self.cluster_tool.main(df, args)
return (result, meta)
# Always handled by the library, pass environment directly
executor = create(os.environ, MyHandler)
app = FastAPI()
# Let's DAPR know which topics should be subscribed to
@app.get("/dapr/subscribe")
def subscribe():
return executor.subscriptions
# Primary endpoint, where request will be delivered to
# TaskBody type here verifies the post body
@app.post("/subscription")
def subscription(body: TaskBody, response: Response):
status = executor.handle_request(body.data.id)
response.status_code = status
# Return empty body so dapr doesn't freak out
return {}
# Start heartbeat thread, which will periodically send updates to database
executor.heartbeat()
```
Assuming the filename is `main.py` the server can then be started via `uvicorn main:app`
### Handling failure
The primary validation happens within `validate_args` function by `pydantic` models. This is where anything related to input should be checked.
If at any point you want the current task to fail, raise `RuntimeError` or `Exception`. This will indicate the library, that we should fail and not retry again. For example:
- CSV missing columns or having incorrect text format
- Not enough data passed
Anything else that raises for a retryable error, should be raised via `RetryError`.
## Versioning
Versioning is based on [semver](https://semver.org/), however, it primarily applies to the `create` function exposed by the package.
If you're using any of the internal system parts, make sure to validate before updating the version.
## Contributing
Read [CONTRIBUTING.md](CONTRIBUTING.md)
## 🛡 License
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE) for more details.
## Credits
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template).
%package help
Summary: Development documents and examples for nanowire-service-py
Provides: python3-nanowire-service-py-doc
%description help
# nanowire-service-py
<div align="center">
[](https://github.com/SpotlightData/nanowire-service-py/actions?query=workflow%3Abuild)
[](https://pypi.org/project/nanowire-service-py/)
[](https://github.com/SpotlightData/nanowire-service-py/pulls?utf8=%E2%9C%93&q=is%3Apr%20author%3Aapp%2Fdependabot)
[](https://github.com/psf/black)
[](https://github.com/PyCQA/bandit)
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/.pre-commit-config.yaml)
[](https://github.com/SpotlightData/nanowire-service-py/releases)
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE)
Wrapper for interacting with Nanowire platform
</div>
## Usage
Install the library via `pip install nanowire-service-py`, or by adding it to requirements file and running `pip install -r requirements.txt`
This library is designed for tight integration with Nanowire platform (created by Spotlight Data).
The library does not have a hardcode requirement for a specific web server, so a another framework like django or flask could be utilised, however, I'd recommend using [fastapi](https://fastapi.tiangolo.com/) due to it's simplicity and speed
### Environment
The following environment variables need to be supplied:
```python
class Environment(BaseModel):
# Dapr spect
DAPR_HTTP_PORT: int
DAPR_APP_ID: str
PUB_SUB: str
# Where /pending requests get made
SCHEDULER_PUB_SUB: str
# Dapr related properties
# Whether we should wait for DAPR server to be active before loading
NO_WAIT: bool = False
# Whether the service should publish to schduler
# This shouldn't be done if we have an "executor" worker
NO_PUBLISH: bool = False
LOG_LEVEL: Union[str, int] = "DEBUG"
# Postgres connection details
POSTGRES_URL: str
POSTGRES_SCHEMA: str
# Utilised for healthchecks and identifying the pod
SERVICE_ID: str = str(uuid.uuid4())
```
This will be verified on service startup.
### Entrypoint
The primary code logic should be placed in a sub-class of `BaseHandler`. User is expected to implement `validate_args` as well as `handle_body` methods:
```python
import os
from dotenv import load_dotenv
from fastapi import FastAPI, Response
from pydantic import BaseModel, validator
from typing import Any, List, Optional
import pandas as pd
from nanowire_service_py import BaseHandler, create, TaskBody
from toolbox import ClusterTool
load_dotenv()
allowed_methods = ["HDBSCAN", "DBSCAN"]
# pydantic used to verify function body
class Arguments(BaseModel):
contentUrl: str
textCol: str
indexCol: str
clusterSize: float = 0.2
nLabels: int = 10
method: str = "DBSCAN"
customStops: Optional[List[str]] = []
maxVocab: int = 5000
memSave: bool = False
withAnomalous: bool = False
@validator('method')
def method_check(cls, method):
if method not in allowed_methods:
raise ValueError("Method has to be one of: {}, received: {}".format(",".join(allowed_methods), method))
return method
# Our custom handler
class MyHandler(BaseHandler):
def __init__(self, *args):
super().__init__(*args)
self.cluster_tool = ClusterTool(self.logger)
def validate_args(self, args: Any, task_id: str) -> Arguments:
return Arguments(**args)
def handle_body(self, args: Arguments, meta: Any, task_id: str):
df = pd.read_csv(args.contentUrl, dtype='unicode')
if args.textCol not in df.columns:
raise RuntimeError("Could not find text column '{}' in CSV".format(args.textCol), { "origin": "CSV"})
if args.indexCol not in df.columns:
raise RuntimeError("Could not find index column '{}' in CSV".format(args.indexCol), { "origin": "CSV"})
result = self.cluster_tool.main(df, args)
return (result, meta)
# Always handled by the library, pass environment directly
executor = create(os.environ, MyHandler)
app = FastAPI()
# Let's DAPR know which topics should be subscribed to
@app.get("/dapr/subscribe")
def subscribe():
return executor.subscriptions
# Primary endpoint, where request will be delivered to
# TaskBody type here verifies the post body
@app.post("/subscription")
def subscription(body: TaskBody, response: Response):
status = executor.handle_request(body.data.id)
response.status_code = status
# Return empty body so dapr doesn't freak out
return {}
# Start heartbeat thread, which will periodically send updates to database
executor.heartbeat()
```
Assuming the filename is `main.py` the server can then be started via `uvicorn main:app`
### Handling failure
The primary validation happens within `validate_args` function by `pydantic` models. This is where anything related to input should be checked.
If at any point you want the current task to fail, raise `RuntimeError` or `Exception`. This will indicate the library, that we should fail and not retry again. For example:
- CSV missing columns or having incorrect text format
- Not enough data passed
Anything else that raises for a retryable error, should be raised via `RetryError`.
## Versioning
Versioning is based on [semver](https://semver.org/), however, it primarily applies to the `create` function exposed by the package.
If you're using any of the internal system parts, make sure to validate before updating the version.
## Contributing
Read [CONTRIBUTING.md](CONTRIBUTING.md)
## 🛡 License
[](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE)
This project is licensed under the terms of the `MIT` license. See [LICENSE](https://github.com/SpotlightData/nanowire-service-py/blob/master/LICENSE) for more details.
## Credits
This project was generated with [`python-package-template`](https://github.com/TezRomacH/python-package-template).
%prep
%autosetup -n nanowire-service-py-3.0.2
%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-nanowire-service-py -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Fri Jun 09 2023 Python_Bot <Python_Bot@openeuler.org> - 3.0.2-1
- Package Spec generated
|
