summaryrefslogtreecommitdiff
path: root/python-devo-sdk.spec
blob: c66cb854eae1e41fd5a8311f8672bd7110eec424 (plain)
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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
%global _empty_manifest_terminate_build 0
Name:		python-devo-sdk
Version:	5.1.3
Release:	1
Summary:	Devo Software Development Kit for Python.
License:	MIT
URL:		https://github.com/DevoInc/python-sdk
Source0:	https://mirrors.nju.edu.cn/pypi/web/packages/c7/26/70b29e8a4d7a059e9ecbb5cf4b1757a63e9839f1bbc12c268157766ee915/devo-sdk-5.1.3.tar.gz
BuildArch:	noarch

Requires:	python3-requests
Requires:	python3-click
Requires:	python3-PyYAML
Requires:	python3-pem
Requires:	python3-pyopenssl
Requires:	python3-urllib3
Requires:	python3-pytz
Requires:	python3-cryptography

%description
![License](https://img.shields.io/github/license/DevoInc/python-sdk)
![Wheel](https://img.shields.io/pypi/wheel/devo-sdk)
![Version](https://img.shields.io/pypi/v/devo-sdk)
![Python](https://img.shields.io/pypi/pyversions/devo-sdk) 
![Tests](https://github.com/DevoInc/python-sdk/actions/workflows/python-pull-request.yml/badge.svg)

# Devo Python SDK

This is the SDK to access Devo directly from Python. It can be used to:
* Send events and files to Devo.
* Make queries.
* Manage deferred tasks.

## Requirements

The Devo SDK for Python requires Python 3.7+

## Compatibility 
- Tested compatibility for python 3.7, 3.8 and 3.9

## Quick Start
### Installing the SDK


You can install the Devo SDK by using `easy_install` or `pip`:

    #option 1
    easy_install devo-sdk
    
    #option 2
    pip install devo-sdk


You can use sources files, cloning the project too:

    #option 3
    python setup.py install
    
    #option 4
    pip install .
    
    #option 5 - dev option
    pip install -e .

### Documentation

There is specific documentation in the _[docs](https://github.com/DevoInc/python-sdk/tree/master/docs)_ folder for each part of SDK:
* [Sender](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/sender.md)
    * [Data](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/data.md)
    * [Lookups](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/lookup.md)
* [Common](https://github.com/DevoInc/python-sdk/tree/master/docs/common.md)
* API:
    * [Api query](https://github.com/DevoInc/python-sdk/tree/master/docs/api/api.md)
    * [Api tasks management](https://github.com/DevoInc/python-sdk/tree/master/docs/api/task.md)
        * [Destination: email](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_email.md)
        * [Destination: redis](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_redis.md)
        * [Destination: S3](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_s3.md)


## Contributing
See [PyLibs contributing guide](https://github.com/DevoInc/python-sdk/tree/master/CONTRIBUTING.md).<br/>
Pull and merge requests are welcome ☺

## Endpoints
##### Sender
To send data with Devo SDK, first choose the required endpoint depending on the region your are accessing from:

| Region | Endpoint             | Port |
|--------|----------------------|------|
| USA    | collector-us.devo.io | 443  |
| Canada | collector-ca.devo.io | 443  |
| Europe | collector-eu.devo.io | 443  |
| APAC   | collector-ap.devo.io | 443  |

You have more information in the official documentation of Devo, [Sending data to Devo](https://docs.devo.com/space/latest/94652410/Sending%20data%20to%20Devo).

##### API
To perform a request with API, first choose the required endpoint depending on the region your are accessing from:

| Region | Endpoint                               |
|--------|----------------------------------------|
| USA    | https://apiv2-us.devo.com/search/query |
| Canada | https://apiv2-ca.devo.com/search/query |
| Europe | https://apiv2-eu.devo.com/search/query |
| APAC   | https://api-apac.devo.com/search/query |

You have more information in the official documentation of Devo, [REST API](https://docs.devo.com/space/latest/95128275/Query%20API).

## Credentials
To obtain the access credentials necessary to use this SDK, you must have an account in [DEVO](https://www.devo.com/).<br/>
Check the [security credentials](https://docs.devo.com/space/latest/94763701/Security%20credentials) info for more details. 

##### Certificates
You need use a three files (Cert, key and chain) to secure send data to Devo. 
Administrator users can find them in **Administration** → **Credentials**, in the X.509 tab. 

##### API authorization
You can use a domain API key and API secret to sign the request. These are are a pair of credentials that every 
Devo account owns. Administrator users can find them in **Administration** → **Credentials**, in the Access Keys tab. 

## Launch tests
### run_tests script
You can run tests from the main folder of SDK
To launch this script, you need either the environment variables loaded in the system, or the _environment.env_ file in the root of the SDK with the correct values, since to test all the SDK functionalities it is necessary to connect to Devo for the tests of sending and extracting data. There is an example file called _environment.env.example_

Its normal, by the way, TCP tests fails in clients or not Devo developers systems.

```console
~/projects/devo-python-sdk > python setup.py test 
```

```console
~/projects/devo-python-sdk > python run_tests.py
```

You can add option "Coverage" for create HTML report about tests.

```console
~/projects/devo-python-sdk > python run_tests.py --coverage
```

You can also run the test for just one module. This is a useful feature if you are developing functionality in just one module.

```console
~/projects/devo-python-sdk > python run_tests.py -m SEND_CLI
```

You can also exclude one or several tests with `-M` parameter:

```console
~/projects/devo-python-sdk > python run_tests.py -M SEND_CLI,API_CLI
```

Using the --help flag prints the available modules to use:

```console
~/projects/devo-python-sdk > python run_tests.py --help
usage: run_tests.py [-h] [--coverage [COVERAGE]] [-m [MODULE]]

optional arguments:
  -h, --help            show this help message and exit
  --coverage [COVERAGE]
                        Generate coverage
  -m [MODULES], --modules [MODULES]
                        Run tests for selected modules: API_CLI, API_QUERY, API_TASKS, API_ERRORS, API_PARSER_DATE,
                        API_PROCESSORS, API_KEEPALIVE, COMMON_CONFIGURATION, COMMON_DATE_PARSER, SENDER_CLI, SENDER_CSV,
                        SENDER_NUMBER_LOOKUP, SENDER_SEND_DATA, SENDER_SEND_LOOKUP
  -M [EXCLUDE_MODULES], --exclude-modules [EXCLUDE_MODULES]
                        Exclude tests for modules: API_CLI, API_QUERY, API_TASKS, API_ERRORS, API_PARSER_DATE,
                        API_PROCESSORS, API_KEEPALIVE, COMMON_CONFIGURATION, COMMON_DATE_PARSER, SENDER_CLI, SENDER_CSV,
                        SENDER_NUMBER_LOOKUP, SENDER_SEND_DATA, SENDER_SEND_LOOKUP
```

* API_CLI: API Command-line interface tests.
* API_QUERY: Query API tests.
* API_TASKS: Task API tests.
* API_ERRORS: Managing of API Errors tests.
* API_PARSER_DATE: Parsing of dates in API tests.
* API_PROCESSORS: Response processors in API tests.
* API_KEEPALIVE: Keep Alive functionality in API tests.
* COMMON_CONFIGURATION: Configuration tests.
* COMMON_DATE_PARSER: Date parser tests.
* SENDER_CLI: Lookup command-line interface tests.
* SENDER_CSV: Lookup uploading through CSV tests.
* SENDER_NUMBER_LOOKUP: Numbers in lookup tests
* SENDER_SEND_DATA: Data sending tests.
* SENDER_SEND_LOOKUP: Lookup sending tests.

### Run using Unittest command

You can see references in [unittest documentation](https://docs.python.org/3/library/unittest.html)

For commands like:

```bash
python -m unittest discover -p "*.py" 
```

If you launch this command from the root directory of the SDK, you need to have the environment variables in your 
system for all the tests that require connection to Devo can work, not being able to use the environment.env file 
as in the script.


### Contact Us

You can contact with us at _support@devo.com_.

## License
MIT License

(C) 2022 Devo, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


%package -n python3-devo-sdk
Summary:	Devo Software Development Kit for Python.
Provides:	python-devo-sdk
BuildRequires:	python3-devel
BuildRequires:	python3-setuptools
BuildRequires:	python3-pip
%description -n python3-devo-sdk
![License](https://img.shields.io/github/license/DevoInc/python-sdk)
![Wheel](https://img.shields.io/pypi/wheel/devo-sdk)
![Version](https://img.shields.io/pypi/v/devo-sdk)
![Python](https://img.shields.io/pypi/pyversions/devo-sdk) 
![Tests](https://github.com/DevoInc/python-sdk/actions/workflows/python-pull-request.yml/badge.svg)

# Devo Python SDK

This is the SDK to access Devo directly from Python. It can be used to:
* Send events and files to Devo.
* Make queries.
* Manage deferred tasks.

## Requirements

The Devo SDK for Python requires Python 3.7+

## Compatibility 
- Tested compatibility for python 3.7, 3.8 and 3.9

## Quick Start
### Installing the SDK


You can install the Devo SDK by using `easy_install` or `pip`:

    #option 1
    easy_install devo-sdk
    
    #option 2
    pip install devo-sdk


You can use sources files, cloning the project too:

    #option 3
    python setup.py install
    
    #option 4
    pip install .
    
    #option 5 - dev option
    pip install -e .

### Documentation

There is specific documentation in the _[docs](https://github.com/DevoInc/python-sdk/tree/master/docs)_ folder for each part of SDK:
* [Sender](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/sender.md)
    * [Data](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/data.md)
    * [Lookups](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/lookup.md)
* [Common](https://github.com/DevoInc/python-sdk/tree/master/docs/common.md)
* API:
    * [Api query](https://github.com/DevoInc/python-sdk/tree/master/docs/api/api.md)
    * [Api tasks management](https://github.com/DevoInc/python-sdk/tree/master/docs/api/task.md)
        * [Destination: email](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_email.md)
        * [Destination: redis](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_redis.md)
        * [Destination: S3](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_s3.md)


## Contributing
See [PyLibs contributing guide](https://github.com/DevoInc/python-sdk/tree/master/CONTRIBUTING.md).<br/>
Pull and merge requests are welcome ☺

## Endpoints
##### Sender
To send data with Devo SDK, first choose the required endpoint depending on the region your are accessing from:

| Region | Endpoint             | Port |
|--------|----------------------|------|
| USA    | collector-us.devo.io | 443  |
| Canada | collector-ca.devo.io | 443  |
| Europe | collector-eu.devo.io | 443  |
| APAC   | collector-ap.devo.io | 443  |

You have more information in the official documentation of Devo, [Sending data to Devo](https://docs.devo.com/space/latest/94652410/Sending%20data%20to%20Devo).

##### API
To perform a request with API, first choose the required endpoint depending on the region your are accessing from:

| Region | Endpoint                               |
|--------|----------------------------------------|
| USA    | https://apiv2-us.devo.com/search/query |
| Canada | https://apiv2-ca.devo.com/search/query |
| Europe | https://apiv2-eu.devo.com/search/query |
| APAC   | https://api-apac.devo.com/search/query |

You have more information in the official documentation of Devo, [REST API](https://docs.devo.com/space/latest/95128275/Query%20API).

## Credentials
To obtain the access credentials necessary to use this SDK, you must have an account in [DEVO](https://www.devo.com/).<br/>
Check the [security credentials](https://docs.devo.com/space/latest/94763701/Security%20credentials) info for more details. 

##### Certificates
You need use a three files (Cert, key and chain) to secure send data to Devo. 
Administrator users can find them in **Administration** → **Credentials**, in the X.509 tab. 

##### API authorization
You can use a domain API key and API secret to sign the request. These are are a pair of credentials that every 
Devo account owns. Administrator users can find them in **Administration** → **Credentials**, in the Access Keys tab. 

## Launch tests
### run_tests script
You can run tests from the main folder of SDK
To launch this script, you need either the environment variables loaded in the system, or the _environment.env_ file in the root of the SDK with the correct values, since to test all the SDK functionalities it is necessary to connect to Devo for the tests of sending and extracting data. There is an example file called _environment.env.example_

Its normal, by the way, TCP tests fails in clients or not Devo developers systems.

```console
~/projects/devo-python-sdk > python setup.py test 
```

```console
~/projects/devo-python-sdk > python run_tests.py
```

You can add option "Coverage" for create HTML report about tests.

```console
~/projects/devo-python-sdk > python run_tests.py --coverage
```

You can also run the test for just one module. This is a useful feature if you are developing functionality in just one module.

```console
~/projects/devo-python-sdk > python run_tests.py -m SEND_CLI
```

You can also exclude one or several tests with `-M` parameter:

```console
~/projects/devo-python-sdk > python run_tests.py -M SEND_CLI,API_CLI
```

Using the --help flag prints the available modules to use:

```console
~/projects/devo-python-sdk > python run_tests.py --help
usage: run_tests.py [-h] [--coverage [COVERAGE]] [-m [MODULE]]

optional arguments:
  -h, --help            show this help message and exit
  --coverage [COVERAGE]
                        Generate coverage
  -m [MODULES], --modules [MODULES]
                        Run tests for selected modules: API_CLI, API_QUERY, API_TASKS, API_ERRORS, API_PARSER_DATE,
                        API_PROCESSORS, API_KEEPALIVE, COMMON_CONFIGURATION, COMMON_DATE_PARSER, SENDER_CLI, SENDER_CSV,
                        SENDER_NUMBER_LOOKUP, SENDER_SEND_DATA, SENDER_SEND_LOOKUP
  -M [EXCLUDE_MODULES], --exclude-modules [EXCLUDE_MODULES]
                        Exclude tests for modules: API_CLI, API_QUERY, API_TASKS, API_ERRORS, API_PARSER_DATE,
                        API_PROCESSORS, API_KEEPALIVE, COMMON_CONFIGURATION, COMMON_DATE_PARSER, SENDER_CLI, SENDER_CSV,
                        SENDER_NUMBER_LOOKUP, SENDER_SEND_DATA, SENDER_SEND_LOOKUP
```

* API_CLI: API Command-line interface tests.
* API_QUERY: Query API tests.
* API_TASKS: Task API tests.
* API_ERRORS: Managing of API Errors tests.
* API_PARSER_DATE: Parsing of dates in API tests.
* API_PROCESSORS: Response processors in API tests.
* API_KEEPALIVE: Keep Alive functionality in API tests.
* COMMON_CONFIGURATION: Configuration tests.
* COMMON_DATE_PARSER: Date parser tests.
* SENDER_CLI: Lookup command-line interface tests.
* SENDER_CSV: Lookup uploading through CSV tests.
* SENDER_NUMBER_LOOKUP: Numbers in lookup tests
* SENDER_SEND_DATA: Data sending tests.
* SENDER_SEND_LOOKUP: Lookup sending tests.

### Run using Unittest command

You can see references in [unittest documentation](https://docs.python.org/3/library/unittest.html)

For commands like:

```bash
python -m unittest discover -p "*.py" 
```

If you launch this command from the root directory of the SDK, you need to have the environment variables in your 
system for all the tests that require connection to Devo can work, not being able to use the environment.env file 
as in the script.


### Contact Us

You can contact with us at _support@devo.com_.

## License
MIT License

(C) 2022 Devo, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


%package help
Summary:	Development documents and examples for devo-sdk
Provides:	python3-devo-sdk-doc
%description help
![License](https://img.shields.io/github/license/DevoInc/python-sdk)
![Wheel](https://img.shields.io/pypi/wheel/devo-sdk)
![Version](https://img.shields.io/pypi/v/devo-sdk)
![Python](https://img.shields.io/pypi/pyversions/devo-sdk) 
![Tests](https://github.com/DevoInc/python-sdk/actions/workflows/python-pull-request.yml/badge.svg)

# Devo Python SDK

This is the SDK to access Devo directly from Python. It can be used to:
* Send events and files to Devo.
* Make queries.
* Manage deferred tasks.

## Requirements

The Devo SDK for Python requires Python 3.7+

## Compatibility 
- Tested compatibility for python 3.7, 3.8 and 3.9

## Quick Start
### Installing the SDK


You can install the Devo SDK by using `easy_install` or `pip`:

    #option 1
    easy_install devo-sdk
    
    #option 2
    pip install devo-sdk


You can use sources files, cloning the project too:

    #option 3
    python setup.py install
    
    #option 4
    pip install .
    
    #option 5 - dev option
    pip install -e .

### Documentation

There is specific documentation in the _[docs](https://github.com/DevoInc/python-sdk/tree/master/docs)_ folder for each part of SDK:
* [Sender](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/sender.md)
    * [Data](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/data.md)
    * [Lookups](https://github.com/DevoInc/python-sdk/tree/master/docs/sender/lookup.md)
* [Common](https://github.com/DevoInc/python-sdk/tree/master/docs/common.md)
* API:
    * [Api query](https://github.com/DevoInc/python-sdk/tree/master/docs/api/api.md)
    * [Api tasks management](https://github.com/DevoInc/python-sdk/tree/master/docs/api/task.md)
        * [Destination: email](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_email.md)
        * [Destination: redis](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_redis.md)
        * [Destination: S3](https://github.com/DevoInc/python-sdk/tree/master/docs/api/destination_s3.md)


## Contributing
See [PyLibs contributing guide](https://github.com/DevoInc/python-sdk/tree/master/CONTRIBUTING.md).<br/>
Pull and merge requests are welcome ☺

## Endpoints
##### Sender
To send data with Devo SDK, first choose the required endpoint depending on the region your are accessing from:

| Region | Endpoint             | Port |
|--------|----------------------|------|
| USA    | collector-us.devo.io | 443  |
| Canada | collector-ca.devo.io | 443  |
| Europe | collector-eu.devo.io | 443  |
| APAC   | collector-ap.devo.io | 443  |

You have more information in the official documentation of Devo, [Sending data to Devo](https://docs.devo.com/space/latest/94652410/Sending%20data%20to%20Devo).

##### API
To perform a request with API, first choose the required endpoint depending on the region your are accessing from:

| Region | Endpoint                               |
|--------|----------------------------------------|
| USA    | https://apiv2-us.devo.com/search/query |
| Canada | https://apiv2-ca.devo.com/search/query |
| Europe | https://apiv2-eu.devo.com/search/query |
| APAC   | https://api-apac.devo.com/search/query |

You have more information in the official documentation of Devo, [REST API](https://docs.devo.com/space/latest/95128275/Query%20API).

## Credentials
To obtain the access credentials necessary to use this SDK, you must have an account in [DEVO](https://www.devo.com/).<br/>
Check the [security credentials](https://docs.devo.com/space/latest/94763701/Security%20credentials) info for more details. 

##### Certificates
You need use a three files (Cert, key and chain) to secure send data to Devo. 
Administrator users can find them in **Administration** → **Credentials**, in the X.509 tab. 

##### API authorization
You can use a domain API key and API secret to sign the request. These are are a pair of credentials that every 
Devo account owns. Administrator users can find them in **Administration** → **Credentials**, in the Access Keys tab. 

## Launch tests
### run_tests script
You can run tests from the main folder of SDK
To launch this script, you need either the environment variables loaded in the system, or the _environment.env_ file in the root of the SDK with the correct values, since to test all the SDK functionalities it is necessary to connect to Devo for the tests of sending and extracting data. There is an example file called _environment.env.example_

Its normal, by the way, TCP tests fails in clients or not Devo developers systems.

```console
~/projects/devo-python-sdk > python setup.py test 
```

```console
~/projects/devo-python-sdk > python run_tests.py
```

You can add option "Coverage" for create HTML report about tests.

```console
~/projects/devo-python-sdk > python run_tests.py --coverage
```

You can also run the test for just one module. This is a useful feature if you are developing functionality in just one module.

```console
~/projects/devo-python-sdk > python run_tests.py -m SEND_CLI
```

You can also exclude one or several tests with `-M` parameter:

```console
~/projects/devo-python-sdk > python run_tests.py -M SEND_CLI,API_CLI
```

Using the --help flag prints the available modules to use:

```console
~/projects/devo-python-sdk > python run_tests.py --help
usage: run_tests.py [-h] [--coverage [COVERAGE]] [-m [MODULE]]

optional arguments:
  -h, --help            show this help message and exit
  --coverage [COVERAGE]
                        Generate coverage
  -m [MODULES], --modules [MODULES]
                        Run tests for selected modules: API_CLI, API_QUERY, API_TASKS, API_ERRORS, API_PARSER_DATE,
                        API_PROCESSORS, API_KEEPALIVE, COMMON_CONFIGURATION, COMMON_DATE_PARSER, SENDER_CLI, SENDER_CSV,
                        SENDER_NUMBER_LOOKUP, SENDER_SEND_DATA, SENDER_SEND_LOOKUP
  -M [EXCLUDE_MODULES], --exclude-modules [EXCLUDE_MODULES]
                        Exclude tests for modules: API_CLI, API_QUERY, API_TASKS, API_ERRORS, API_PARSER_DATE,
                        API_PROCESSORS, API_KEEPALIVE, COMMON_CONFIGURATION, COMMON_DATE_PARSER, SENDER_CLI, SENDER_CSV,
                        SENDER_NUMBER_LOOKUP, SENDER_SEND_DATA, SENDER_SEND_LOOKUP
```

* API_CLI: API Command-line interface tests.
* API_QUERY: Query API tests.
* API_TASKS: Task API tests.
* API_ERRORS: Managing of API Errors tests.
* API_PARSER_DATE: Parsing of dates in API tests.
* API_PROCESSORS: Response processors in API tests.
* API_KEEPALIVE: Keep Alive functionality in API tests.
* COMMON_CONFIGURATION: Configuration tests.
* COMMON_DATE_PARSER: Date parser tests.
* SENDER_CLI: Lookup command-line interface tests.
* SENDER_CSV: Lookup uploading through CSV tests.
* SENDER_NUMBER_LOOKUP: Numbers in lookup tests
* SENDER_SEND_DATA: Data sending tests.
* SENDER_SEND_LOOKUP: Lookup sending tests.

### Run using Unittest command

You can see references in [unittest documentation](https://docs.python.org/3/library/unittest.html)

For commands like:

```bash
python -m unittest discover -p "*.py" 
```

If you launch this command from the root directory of the SDK, you need to have the environment variables in your 
system for all the tests that require connection to Devo can work, not being able to use the environment.env file 
as in the script.


### Contact Us

You can contact with us at _support@devo.com_.

## License
MIT License

(C) 2022 Devo, Inc.

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the 'Software'), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.


%prep
%autosetup -n devo-sdk-5.1.3

%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-devo-sdk -f filelist.lst
%dir %{python3_sitelib}/*

%files help -f doclist.lst
%{_docdir}/*

%changelog
* Fri May 05 2023 Python_Bot <Python_Bot@openeuler.org> - 5.1.3-1
- Package Spec generated