Package: carbon-black-cloud-sdk
VMware Carbon Black Cloud Python SDKLatest Version:1.5.1Release Date:January 30, 2024Recent updatesView the latest release noteshere.LicenseUse of the Carbon Black Cloud Python SDK is governed by the license found inLICENSE.SupportView all API and integration offerings on theDeveloper Networkalong with reference documentation, video tutorials, and how-to guides.Use theDeveloper Community Forumto discuss issues and get answers from other API developers in the Carbon Black Community.Create a github issue for bugs and change requests or create a ticket withCarbon Black Support.DocumentationVisitReadTheDocsfor this project's documentation.RequirementsThe Carbon Black Cloud Python SDK is design to work on Python 3.8 and above.All requirements are installed as part ofpip 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 repopip install -r requirements.txtCarbon Black CloudAt least one Carbon Black Cloud product is required to use this SDK:PlatformEndpoint StandardAudit and RemediationEnterprise EDRWorkloadPython Packagesrequestspyyamlpython-dateutilschemasolrqjsonschemavalidatorskeyring (for MacOS)If developing the SDK, you also need:pytest==5.4.2pymox==1.0.0coverage==5.1coveralls==2.0.0flake8==3.8.1flake8-colors==0.1.6flake8-docstrings==1.5.0pre-commit>=2.15.0Getting StartedVisit theGetting Started Guidefor an example of authenticating and making an API call using the SDK.Setting the User-AgentThe SDK supports custom User-Agent's when making API calls. This allows you to identify yourself when using the SDK. SeeSetting the User-Agentsection of the documentation for more information.Developing Improvements for the Carbon Black Cloud Python SDKUse the following steps if you want to provide additional examples, fix a bug, or add a feature to the SDK.Installing for SDK developmentYou will need to fork the repo in order to create pull requests when submitting code for review. For details on forking a repo, seehere.git clone https://github.com/{fork-name}/carbon-black-cloud-sdk-python
cd carbon-black-cloud-sdk-python
pip install -r requirements.txtNote: Before contributing any code please make sure to read theCONTRIBUTINGpage.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 repoRunning the SDK testsFrom the parent directorycarbon-black-cloud-sdk-python, run the commandpytest.Building the documentationLocallyReadTheDocs hoststhe documentation for the SDK. 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-copybuttonThen, build the docs locally with the following commands:cd docs
make htmlNote that the module rst files such asdocs/cbc_sdk.platform.rstare 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_sdkThe documentation is built indocs/_build/html.N.B.:If your documentation pages appear to generate incorrectly, check to see if you received the warning messageNo module named 'cbc_sdk'.  If so, set yourPYTHONPATHto include thesrc/subdirectory of the SDK project
directory before runningmake html, or the equivalent commandsphinx-build -M html . _build.Pull-RequestsThe webhook with readthedocs will create a build of the branch and report on the status of the build to the GitHub pull requestUsing DockerBuild the documentation by running:$dockerrun-p7000:7000-it$(dockerbuild-f./docker/docs/Dockerfile.-q)makelivehtmlDevelopment FlowTo 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 developNote: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, seehere.