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
|
%global _empty_manifest_terminate_build 0
Name: python-carbon-black-cloud-sdk
Version: 1.4.2
Release: 1
Summary: VMware Carbon Black Cloud Python SDK
License: MIT
URL: https://github.com/carbonblack/carbon-black-cloud-sdk-python
Source0: https://mirrors.nju.edu.cn/pypi/web/packages/51/78/dcb221254eaf7b3dc1cdf190c610a2b3cb89398fb1468c3ab4dff094345b/carbon-black-cloud-sdk-1.4.2.tar.gz
BuildArch: noarch
Requires: python3-requests
Requires: python3-pyyaml
Requires: python3-dateutil
Requires: python3-schema
Requires: python3-solrq
Requires: python3-validators
Requires: python3-jsonschema
Requires: python3-boto3
Requires: python3-keyring
Requires: python3-pytest
Requires: python3-pymox
Requires: python3-coverage
Requires: python3-coveralls
Requires: python3-flake8
Requires: python3-flake8-colors
Requires: python3-flake8-docstrings
Requires: python3-pre-commit
Requires: python3-requests-mock
%description
# VMware Carbon Black Cloud Python SDK
**Latest Version:** 1.4.2
<br>
**Release Date:** March 22, 2023
[](https://coveralls.io/github/carbonblack/carbon-black-cloud-sdk-python)
[](https://app.codeship.com/projects/402767)
## Recent updates
View the latest release notes [here](https://github.com/carbonblack/carbon-black-cloud-sdk-python/releases).
## License
Use of the Carbon Black Cloud Python SDK is governed by the license found in [LICENSE](https://github.com/carbonblack/carbon-black-cloud-sdk-python/blob/develop/LICENSE).
## Support
1. View all API and integration offerings on the [Developer Network](https://developer.carbonblack.com) along with reference documentation, video tutorials, and how-to guides.
2. Use the [Developer Community Forum](https://community.carbonblack.com/) to discuss issues and get answers from other API developers in the Carbon Black Community.
3. Create a github issue for bugs and change requests or create a ticket with [Carbon Black Support](http://carbonblack.com/resources/support/).
## Documentation
Visit [ReadTheDocs](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/) for this project's documentation.
## Requirements
The Carbon Black Cloud Python SDK is design to work on Python 3.7 and above.
All requirements are installed as part of `pip install carbon-black-cloud-sdk`. If you're planning on pushing changes to the Carbon Black Cloud Python SDK, the following can be used after cloning the repo `pip install -r requirements.txt`
### Carbon Black Cloud
At least one Carbon Black Cloud product is required to use this SDK:
* [Platform](https://developer.carbonblack.com/reference/carbon-black-cloud/platform-apis/)
* [Endpoint Standard](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-defense/)
* [Audit and Remediation](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-liveops/)
* [Enterprise EDR](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-threathunter/)
* [Workload](https://developer.carbonblack.com/reference/carbon-black-cloud/workload-protection/)
### Python Packages
- requests
- pyyaml
- python-dateutil
- schema
- solrq
- jsonschema
- validators
- keyring (for MacOS)
If developing the SDK, you also need:
- pytest==5.4.2
- pymox==0.7.8
- coverage==5.1
- coveralls==2.0.0
- flake8==3.8.1
- flake8-colors==0.1.6
- flake8-docstrings==1.5.0
- pre-commit>=2.15.0
## Getting Started
Visit the [Getting Started Guide](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started) for an example of authenticating and making an API call using the SDK.
### Setting the User-Agent
The SDK supports custom User-Agent's when making API calls. This allows you to identify yourself when using the SDK. See [Setting the User-Agent](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started#setting-the-user-agent) section of the documentation for more information.
## Developing Improvements for the Carbon Black Cloud Python SDK
Use the following steps if you want to provide additional examples, fix a bug, or add a feature to the SDK.
### Installing for SDK development
You will need to fork the repo in order to create pull requests when submitting code for review. For details on forking a repo, see [here](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).
```
git clone https://github.com/{fork-name}/carbon-black-cloud-sdk-python
cd carbon-black-cloud-sdk-python
pip install -r requirements.txt
```
**Note: Before contributing any code please make sure to read the [CONTRIBUTING](CONTRIBUTING.md) page.**
If you want to test/execute the example scripts from the repo then install the SDK with the following command. This will install the SDK in editable mode so changes to the repo modify the installed package.
```
pip install -e .
```
**Note: The above command needs to be run from the base folder of the repo**
### Running the SDK tests
From the parent directory `carbon-black-cloud-sdk-python`, run the command `pytest`.
### Building the documentation
#### Locally
ReadTheDocs hosts [the documentation for the SDK](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/). If you make changes to the SDK that require an update to the documentation, first install the documentation packages from pip:
```
pip install sphinxcontrib-apidoc sphinx_rtd_theme sphinx-copybutton
```
Then, build the docs locally with the following commands:
```
sphinx-apidoc -f -o docs src/cbc_sdk
cd docs
make html
```
The documentation is built in `docs/_build/html`.
**N.B.:** If your documentation pages appear to generate incorrectly, check to see if you received the warning message
`No module named 'cbc_sdk'`. If so, set your `PYTHONPATH` to include the `src/` subdirectory of the SDK project
directory before running `make html`, or the equivalent command `sphinx-build -M html . _build`.
#### Pull-Requests
The webhook with readthedocs will create a build of the branch and report on the status of the build to the GitHub pull request
#### Using Docker
Build the documentation by running:
```shell
$ docker run -p 7000:7000 -it $(docker build -f ./docker/docs/Dockerfile . -q) make livehtml
```
### Development Flow
To begin a code change, start by creating a branch off of the develop branch.
```
git checkout develop
git checkout -b {branch-name}
```
When the feature or bug fix is finished you will need to create a pull request to the CarbonBlack repo, the following will push your changes to Github.
```
git push {remote} {branch-name}
```
If your branch is behind the develop branch, you will need to rebase.
```
git checkout {branch-name}
git rebase develop
```
**Note:** if your develop branch is out of sync with the Carbon Black repo then you will need to sync your fork. For information on syncing your fork, see [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).
%package -n python3-carbon-black-cloud-sdk
Summary: VMware Carbon Black Cloud Python SDK
Provides: python-carbon-black-cloud-sdk
BuildRequires: python3-devel
BuildRequires: python3-setuptools
BuildRequires: python3-pip
%description -n python3-carbon-black-cloud-sdk
# VMware Carbon Black Cloud Python SDK
**Latest Version:** 1.4.2
<br>
**Release Date:** March 22, 2023
[](https://coveralls.io/github/carbonblack/carbon-black-cloud-sdk-python)
[](https://app.codeship.com/projects/402767)
## Recent updates
View the latest release notes [here](https://github.com/carbonblack/carbon-black-cloud-sdk-python/releases).
## License
Use of the Carbon Black Cloud Python SDK is governed by the license found in [LICENSE](https://github.com/carbonblack/carbon-black-cloud-sdk-python/blob/develop/LICENSE).
## Support
1. View all API and integration offerings on the [Developer Network](https://developer.carbonblack.com) along with reference documentation, video tutorials, and how-to guides.
2. Use the [Developer Community Forum](https://community.carbonblack.com/) to discuss issues and get answers from other API developers in the Carbon Black Community.
3. Create a github issue for bugs and change requests or create a ticket with [Carbon Black Support](http://carbonblack.com/resources/support/).
## Documentation
Visit [ReadTheDocs](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/) for this project's documentation.
## Requirements
The Carbon Black Cloud Python SDK is design to work on Python 3.7 and above.
All requirements are installed as part of `pip install carbon-black-cloud-sdk`. If you're planning on pushing changes to the Carbon Black Cloud Python SDK, the following can be used after cloning the repo `pip install -r requirements.txt`
### Carbon Black Cloud
At least one Carbon Black Cloud product is required to use this SDK:
* [Platform](https://developer.carbonblack.com/reference/carbon-black-cloud/platform-apis/)
* [Endpoint Standard](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-defense/)
* [Audit and Remediation](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-liveops/)
* [Enterprise EDR](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-threathunter/)
* [Workload](https://developer.carbonblack.com/reference/carbon-black-cloud/workload-protection/)
### Python Packages
- requests
- pyyaml
- python-dateutil
- schema
- solrq
- jsonschema
- validators
- keyring (for MacOS)
If developing the SDK, you also need:
- pytest==5.4.2
- pymox==0.7.8
- coverage==5.1
- coveralls==2.0.0
- flake8==3.8.1
- flake8-colors==0.1.6
- flake8-docstrings==1.5.0
- pre-commit>=2.15.0
## Getting Started
Visit the [Getting Started Guide](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started) for an example of authenticating and making an API call using the SDK.
### Setting the User-Agent
The SDK supports custom User-Agent's when making API calls. This allows you to identify yourself when using the SDK. See [Setting the User-Agent](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started#setting-the-user-agent) section of the documentation for more information.
## Developing Improvements for the Carbon Black Cloud Python SDK
Use the following steps if you want to provide additional examples, fix a bug, or add a feature to the SDK.
### Installing for SDK development
You will need to fork the repo in order to create pull requests when submitting code for review. For details on forking a repo, see [here](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).
```
git clone https://github.com/{fork-name}/carbon-black-cloud-sdk-python
cd carbon-black-cloud-sdk-python
pip install -r requirements.txt
```
**Note: Before contributing any code please make sure to read the [CONTRIBUTING](CONTRIBUTING.md) page.**
If you want to test/execute the example scripts from the repo then install the SDK with the following command. This will install the SDK in editable mode so changes to the repo modify the installed package.
```
pip install -e .
```
**Note: The above command needs to be run from the base folder of the repo**
### Running the SDK tests
From the parent directory `carbon-black-cloud-sdk-python`, run the command `pytest`.
### Building the documentation
#### Locally
ReadTheDocs hosts [the documentation for the SDK](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/). If you make changes to the SDK that require an update to the documentation, first install the documentation packages from pip:
```
pip install sphinxcontrib-apidoc sphinx_rtd_theme sphinx-copybutton
```
Then, build the docs locally with the following commands:
```
sphinx-apidoc -f -o docs src/cbc_sdk
cd docs
make html
```
The documentation is built in `docs/_build/html`.
**N.B.:** If your documentation pages appear to generate incorrectly, check to see if you received the warning message
`No module named 'cbc_sdk'`. If so, set your `PYTHONPATH` to include the `src/` subdirectory of the SDK project
directory before running `make html`, or the equivalent command `sphinx-build -M html . _build`.
#### Pull-Requests
The webhook with readthedocs will create a build of the branch and report on the status of the build to the GitHub pull request
#### Using Docker
Build the documentation by running:
```shell
$ docker run -p 7000:7000 -it $(docker build -f ./docker/docs/Dockerfile . -q) make livehtml
```
### Development Flow
To begin a code change, start by creating a branch off of the develop branch.
```
git checkout develop
git checkout -b {branch-name}
```
When the feature or bug fix is finished you will need to create a pull request to the CarbonBlack repo, the following will push your changes to Github.
```
git push {remote} {branch-name}
```
If your branch is behind the develop branch, you will need to rebase.
```
git checkout {branch-name}
git rebase develop
```
**Note:** if your develop branch is out of sync with the Carbon Black repo then you will need to sync your fork. For information on syncing your fork, see [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).
%package help
Summary: Development documents and examples for carbon-black-cloud-sdk
Provides: python3-carbon-black-cloud-sdk-doc
%description help
# VMware Carbon Black Cloud Python SDK
**Latest Version:** 1.4.2
<br>
**Release Date:** March 22, 2023
[](https://coveralls.io/github/carbonblack/carbon-black-cloud-sdk-python)
[](https://app.codeship.com/projects/402767)
## Recent updates
View the latest release notes [here](https://github.com/carbonblack/carbon-black-cloud-sdk-python/releases).
## License
Use of the Carbon Black Cloud Python SDK is governed by the license found in [LICENSE](https://github.com/carbonblack/carbon-black-cloud-sdk-python/blob/develop/LICENSE).
## Support
1. View all API and integration offerings on the [Developer Network](https://developer.carbonblack.com) along with reference documentation, video tutorials, and how-to guides.
2. Use the [Developer Community Forum](https://community.carbonblack.com/) to discuss issues and get answers from other API developers in the Carbon Black Community.
3. Create a github issue for bugs and change requests or create a ticket with [Carbon Black Support](http://carbonblack.com/resources/support/).
## Documentation
Visit [ReadTheDocs](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/) for this project's documentation.
## Requirements
The Carbon Black Cloud Python SDK is design to work on Python 3.7 and above.
All requirements are installed as part of `pip install carbon-black-cloud-sdk`. If you're planning on pushing changes to the Carbon Black Cloud Python SDK, the following can be used after cloning the repo `pip install -r requirements.txt`
### Carbon Black Cloud
At least one Carbon Black Cloud product is required to use this SDK:
* [Platform](https://developer.carbonblack.com/reference/carbon-black-cloud/platform-apis/)
* [Endpoint Standard](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-defense/)
* [Audit and Remediation](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-liveops/)
* [Enterprise EDR](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-threathunter/)
* [Workload](https://developer.carbonblack.com/reference/carbon-black-cloud/workload-protection/)
### Python Packages
- requests
- pyyaml
- python-dateutil
- schema
- solrq
- jsonschema
- validators
- keyring (for MacOS)
If developing the SDK, you also need:
- pytest==5.4.2
- pymox==0.7.8
- coverage==5.1
- coveralls==2.0.0
- flake8==3.8.1
- flake8-colors==0.1.6
- flake8-docstrings==1.5.0
- pre-commit>=2.15.0
## Getting Started
Visit the [Getting Started Guide](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started) for an example of authenticating and making an API call using the SDK.
### Setting the User-Agent
The SDK supports custom User-Agent's when making API calls. This allows you to identify yourself when using the SDK. See [Setting the User-Agent](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started#setting-the-user-agent) section of the documentation for more information.
## Developing Improvements for the Carbon Black Cloud Python SDK
Use the following steps if you want to provide additional examples, fix a bug, or add a feature to the SDK.
### Installing for SDK development
You will need to fork the repo in order to create pull requests when submitting code for review. For details on forking a repo, see [here](https://help.github.com/en/github/getting-started-with-github/fork-a-repo).
```
git clone https://github.com/{fork-name}/carbon-black-cloud-sdk-python
cd carbon-black-cloud-sdk-python
pip install -r requirements.txt
```
**Note: Before contributing any code please make sure to read the [CONTRIBUTING](CONTRIBUTING.md) page.**
If you want to test/execute the example scripts from the repo then install the SDK with the following command. This will install the SDK in editable mode so changes to the repo modify the installed package.
```
pip install -e .
```
**Note: The above command needs to be run from the base folder of the repo**
### Running the SDK tests
From the parent directory `carbon-black-cloud-sdk-python`, run the command `pytest`.
### Building the documentation
#### Locally
ReadTheDocs hosts [the documentation for the SDK](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/). If you make changes to the SDK that require an update to the documentation, first install the documentation packages from pip:
```
pip install sphinxcontrib-apidoc sphinx_rtd_theme sphinx-copybutton
```
Then, build the docs locally with the following commands:
```
sphinx-apidoc -f -o docs src/cbc_sdk
cd docs
make html
```
The documentation is built in `docs/_build/html`.
**N.B.:** If your documentation pages appear to generate incorrectly, check to see if you received the warning message
`No module named 'cbc_sdk'`. If so, set your `PYTHONPATH` to include the `src/` subdirectory of the SDK project
directory before running `make html`, or the equivalent command `sphinx-build -M html . _build`.
#### Pull-Requests
The webhook with readthedocs will create a build of the branch and report on the status of the build to the GitHub pull request
#### Using Docker
Build the documentation by running:
```shell
$ docker run -p 7000:7000 -it $(docker build -f ./docker/docs/Dockerfile . -q) make livehtml
```
### Development Flow
To begin a code change, start by creating a branch off of the develop branch.
```
git checkout develop
git checkout -b {branch-name}
```
When the feature or bug fix is finished you will need to create a pull request to the CarbonBlack repo, the following will push your changes to Github.
```
git push {remote} {branch-name}
```
If your branch is behind the develop branch, you will need to rebase.
```
git checkout {branch-name}
git rebase develop
```
**Note:** if your develop branch is out of sync with the Carbon Black repo then you will need to sync your fork. For information on syncing your fork, see [here](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork).
%prep
%autosetup -n carbon-black-cloud-sdk-1.4.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-carbon-black-cloud-sdk -f filelist.lst
%dir %{python3_sitelib}/*
%files help -f doclist.lst
%{_docdir}/*
%changelog
* Sun Apr 23 2023 Python_Bot <Python_Bot@openeuler.org> - 1.4.2-1
- Package Spec generated
|
