# Carbon Black Cloud Python SDK
**Latest Version:** 1.5.7
<br>
**Release Date:** July 26, 2024
## 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.8 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==1.0.0
- coverage==5.1
- 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:
```
cd docs
make html
```
Note that the module rst files such as ```docs/cbc_sdk.platform.rst ``` are handcrafted to control layout.
* This command will generate new version, but it is not necessary and changes should not be added to the repository.
* All pull requests will trigger a build of the documentation which can be viewed from Read The Docs --> Builds.
```
sphinx-apidoc -f -o docs src/cbc_sdk
```
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).
Raw data
{
"_id": null,
"home_page": "https://github.com/carbonblack/carbon-black-cloud-sdk-python",
"name": "carbon-black-cloud-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": null,
"author": "Carbon Black",
"author_email": "cb-developer-network@vmware.com",
"download_url": "https://files.pythonhosted.org/packages/18/09/0db5040aa20a8f9fbc2be004272460d4b892305b82c2b153745083f483f1/carbon-black-cloud-sdk-1.5.7.tar.gz",
"platform": "any",
"description": "# Carbon Black Cloud Python SDK\n\n**Latest Version:** 1.5.7\n<br>\n**Release Date:** July 26, 2024\n\n\n## Recent updates\n\nView the latest release notes [here](https://github.com/carbonblack/carbon-black-cloud-sdk-python/releases).\n\n\n## License\n\nUse 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).\n\n## Support\n\n1. View all API and integration offerings on the [Developer Network](https://developer.carbonblack.com) along with reference documentation, video tutorials, and how-to guides.\n2. Use the [Developer Community Forum](https://community.carbonblack.com/) to discuss issues and get answers from other API developers in the Carbon Black Community.\n3. Create a github issue for bugs and change requests or create a ticket with [Carbon Black Support](http://carbonblack.com/resources/support/).\n\n## Documentation\n\nVisit [ReadTheDocs](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/) for this project's documentation.\n\n## Requirements\n\nThe Carbon Black Cloud Python SDK is design to work on Python 3.8 and above.\n\nAll 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`\n\n### Carbon Black Cloud\n\nAt least one Carbon Black Cloud product is required to use this SDK:\n\n* [Platform](https://developer.carbonblack.com/reference/carbon-black-cloud/platform-apis/)\n* [Endpoint Standard](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-defense/)\n* [Audit and Remediation](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-liveops/)\n* [Enterprise EDR](https://developer.carbonblack.com/reference/carbon-black-cloud/cb-threathunter/)\n* [Workload](https://developer.carbonblack.com/reference/carbon-black-cloud/workload-protection/)\n\n### Python Packages\n\n- requests\n- pyyaml\n- python-dateutil\n- schema\n- solrq\n- jsonschema\n- validators\n- keyring (for MacOS)\n\nIf developing the SDK, you also need:\n\n- pytest==5.4.2\n- pymox==1.0.0\n- coverage==5.1\n- flake8==3.8.1\n- flake8-colors==0.1.6\n- flake8-docstrings==1.5.0\n- pre-commit>=2.15.0\n\n\n## Getting Started\n\nVisit 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.\n\n### Setting the User-Agent\n\nThe 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.\n\n## Developing Improvements for the Carbon Black Cloud Python SDK\n\nUse the following steps if you want to provide additional examples, fix a bug, or add a feature to the SDK.\n\n### Installing for SDK development\n\nYou 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).\n\n```\ngit clone https://github.com/{fork-name}/carbon-black-cloud-sdk-python\ncd carbon-black-cloud-sdk-python\npip install -r requirements.txt\n```\n\n**Note: Before contributing any code please make sure to read the [CONTRIBUTING](CONTRIBUTING.md) page.**\n\nIf 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.\n\n```\npip install -e .\n```\n\n**Note: The above command needs to be run from the base folder of the repo**\n\n\n### Running the SDK tests\n\nFrom the parent directory `carbon-black-cloud-sdk-python`, run the command `pytest`.\n\n### Building the documentation\n\n#### Locally\nReadTheDocs 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:\n\n```\npip install sphinxcontrib-apidoc sphinx_rtd_theme sphinx-copybutton\n```\n\nThen, build the docs locally with the following commands:\n\n```\ncd docs\nmake html\n```\n\nNote that the module rst files such as ```docs/cbc_sdk.platform.rst ``` are handcrafted to control layout.\n* This command will generate new version, but it is not necessary and changes should not be added to the repository.\n* All pull requests will trigger a build of the documentation which can be viewed from Read The Docs --> Builds.\n```\nsphinx-apidoc -f -o docs src/cbc_sdk\n```\n\nThe documentation is built in `docs/_build/html`.\n\n**N.B.:** If your documentation pages appear to generate incorrectly, check to see if you received the warning message\n`No module named 'cbc_sdk'`. If so, set your `PYTHONPATH` to include the `src/` subdirectory of the SDK project\ndirectory before running `make html`, or the equivalent command `sphinx-build -M html . _build`.\n\n#### Pull-Requests\n\nThe webhook with readthedocs will create a build of the branch and report on the status of the build to the GitHub pull request\n\n#### Using Docker\n\nBuild the documentation by running:\n```shell\n$ docker run -p 7000:7000 -it $(docker build -f ./docker/docs/Dockerfile . -q) make livehtml\n```\n\n### Development Flow\n\nTo begin a code change, start by creating a branch off of the develop branch.\n```\ngit checkout develop\ngit checkout -b {branch-name}\n```\n\nWhen 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.\n```\ngit push {remote} {branch-name}\n```\n\nIf your branch is behind the develop branch, you will need to rebase.\n```\ngit checkout {branch-name}\ngit rebase develop\n```\n\n**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).\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Carbon Black Cloud Python SDK",
"version": "1.5.7",
"project_urls": {
"Homepage": "https://github.com/carbonblack/carbon-black-cloud-sdk-python"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "07597d792d80e9c9d2414de4ff519e6b7980810cbbc474ff37c330b444083d08",
"md5": "7fa3355c020bd1ec330745e3cee73f1b",
"sha256": "42a31b1826cb2f9f4b328218f62f61b129ecc5fa2a3325825782ea99050f6944"
},
"downloads": -1,
"filename": "carbon_black_cloud_sdk-1.5.7-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7fa3355c020bd1ec330745e3cee73f1b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 333778,
"upload_time": "2024-11-15T17:43:39",
"upload_time_iso_8601": "2024-11-15T17:43:39.848593Z",
"url": "https://files.pythonhosted.org/packages/07/59/7d792d80e9c9d2414de4ff519e6b7980810cbbc474ff37c330b444083d08/carbon_black_cloud_sdk-1.5.7-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "18090db5040aa20a8f9fbc2be004272460d4b892305b82c2b153745083f483f1",
"md5": "486e8217c2f208dd5132c6abca8bc8fa",
"sha256": "412750461579658871c5578ef0b5af3f3b357722c4cb32e7071b8975e9c44707"
},
"downloads": -1,
"filename": "carbon-black-cloud-sdk-1.5.7.tar.gz",
"has_sig": false,
"md5_digest": "486e8217c2f208dd5132c6abca8bc8fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 258744,
"upload_time": "2024-11-15T17:43:42",
"upload_time_iso_8601": "2024-11-15T17:43:42.032633Z",
"url": "https://files.pythonhosted.org/packages/18/09/0db5040aa20a8f9fbc2be004272460d4b892305b82c2b153745083f483f1/carbon-black-cloud-sdk-1.5.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-15 17:43:42",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "carbonblack",
"github_project": "carbon-black-cloud-sdk-python",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "carbon-black-cloud-sdk"
}
JSON
