summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCoprDistGit <infra@openeuler.org>2023-04-11 08:59:17 +0000
committerCoprDistGit <infra@openeuler.org>2023-04-11 08:59:17 +0000
commit93cef32a33061fa47e21d323b2c2238d6393e852 (patch)
tree2a8f4b1fc23e51c85a137bec027467a285978bcf
parent27552a0d0b783fbfd9e4954587880198a01e2299 (diff)
automatic import of python-carbon-black-cloud-sdk
-rw-r--r--.gitignore1
-rw-r--r--python-carbon-black-cloud-sdk.spec576
-rw-r--r--sources1
3 files changed, 578 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index e69de29..65772fb 100644
--- a/.gitignore
+++ b/.gitignore
@@ -0,0 +1 @@
+/carbon-black-cloud-sdk-1.4.2.tar.gz
diff --git a/python-carbon-black-cloud-sdk.spec b/python-carbon-black-cloud-sdk.spec
new file mode 100644
index 0000000..52e0c9c
--- /dev/null
+++ b/python-carbon-black-cloud-sdk.spec
@@ -0,0 +1,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
+
+[![Coverage Status](https://coveralls.io/repos/github/carbonblack/carbon-black-cloud-sdk-python/badge.svg?t=Id6Baf)](https://coveralls.io/github/carbonblack/carbon-black-cloud-sdk-python)
+[![Codeship Status for carbonblack/carbon-black-cloud-sdk-python](https://app.codeship.com/projects/9e55a370-a772-0138-aae4-129773225755/status?branch=develop)](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
+
+[![Coverage Status](https://coveralls.io/repos/github/carbonblack/carbon-black-cloud-sdk-python/badge.svg?t=Id6Baf)](https://coveralls.io/github/carbonblack/carbon-black-cloud-sdk-python)
+[![Codeship Status for carbonblack/carbon-black-cloud-sdk-python](https://app.codeship.com/projects/9e55a370-a772-0138-aae4-129773225755/status?branch=develop)](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
+
+[![Coverage Status](https://coveralls.io/repos/github/carbonblack/carbon-black-cloud-sdk-python/badge.svg?t=Id6Baf)](https://coveralls.io/github/carbonblack/carbon-black-cloud-sdk-python)
+[![Codeship Status for carbonblack/carbon-black-cloud-sdk-python](https://app.codeship.com/projects/9e55a370-a772-0138-aae4-129773225755/status?branch=develop)](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
+* Tue Apr 11 2023 Python_Bot <Python_Bot@openeuler.org> - 1.4.2-1
+- Package Spec generated
diff --git a/sources b/sources
new file mode 100644
index 0000000..56b4e60
--- /dev/null
+++ b/sources
@@ -0,0 +1 @@
+11a9a237268c38e6fc36a00213829030 carbon-black-cloud-sdk-1.4.2.tar.gz