Merge v1.0.1 release

carbonblack · Dec 17, 2020 · 133ff50 · 133ff50
2 parents 658c1e7 + 6a693f3
commit 133ff50
Show file tree

Hide file tree

Showing 9 changed files with 28 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,8 +1,8 @@
 # VMware Carbon Black Cloud Python SDK
 
-**Latest Version:** 1.0.0
+**Latest Version:** 1.0.1
 <br>
-**Release Date:** 15 December 2020
+**Release Date:** 17 December 2020
 
 [![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)
@@ -16,13 +16,13 @@ View the latest release notes [here](https://github.com/carbonblack/carbon-black
 
 ## License
 
-Use of the Carbon Black Cloud Python SDK is governed by the license found in [LICENSE](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. Formal [Carbon Black Support](http://carbonblack.com/resources/support/) coming with v1.0.
+3. Create a github issue for bugs and change requests or create a ticket with [Carbon Black Support](http://carbonblack.com/resources/support/).
 
 ## Documentation
 
@@ -43,6 +43,7 @@ At least one Carbon Black Cloud product is required to use this SDK:
 * [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/)
 
+_Note: Support for the latest products such as Workloads and Containers are planned for early 2021_
 
 ### Python Packages
 
@@ -70,11 +71,11 @@ If developing the SDK, you also need:
 
 ## Getting Started
 
-Visit the [Getting Started Guide](https://carbon-black-cloud-python-sdk.readthedocs.io/en/latest/getting-started.html) for an example of authenticating and making an API call using the SDK.
+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.html#setting-the-user-agent) section of the documentation for more information.
+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
 
@@ -141,4 +142,4 @@ git checkout {branch-name}
 git rebase develop
 ```
 
-**Note:** if your develop branch is out of sync with the CarbonBlack 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).
+**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).
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-1.0.0
+1.0.1
diff --git a/docs/cbc_sdk.rst b/docs/cbc_sdk.rst
@@ -52,7 +52,7 @@ cbc\_sdk.errors module
 cbc\_sdk.example\_helpers module
 --------------------------------
 
-.. automodule:: cbc_sdk.example_helpers
+.. automodule:: cbc_sdk.helpers
    :members:
    :undoc-members:
    :show-inheritance:

diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -1,6 +1,13 @@
 Changelog
 ================================
 
+CBC SDK 1.0.1 - Released December 17, 2020
+------------------------------------
+
+Bug Fixes
+
+* Fix readme links
+* Few ReadTheDocs fixes
 
 CBC SDK 1.0.0 - Released December 16, 2020
 ------------------------------------

diff --git a/docs/concepts.rst b/docs/concepts.rst
@@ -275,7 +275,7 @@ Modules not yet Supported for Criteria
 :mod:`RunHistory <cbc_sdk.audit_remediation.base.RunHistory>`
 
 
-Asynchronous queries
+Asynchronous Queries
 --------------------
 
 A number of queries allow for asynchronous mode of operation. Those utilize python futures and the request itself is performed in a separate worker thread.

diff --git a/docs/conf.py b/docs/conf.py
@@ -23,7 +23,7 @@
 author = 'Developer Relations'
 
 # The full version, including alpha/beta/rc tags
-release = '1.0.0'
+release = '1.0.1'
 
 
 # -- General configuration ---------------------------------------------------

diff --git a/docs/index.rst b/docs/index.rst
@@ -39,10 +39,10 @@ which is explained in the `Developer Network Authentication Guide
 The SDK manages your API credentials for you. There are multiple ways to supply the SDK
 with your API credentials, which is explained in :ref:`authentication`.
 
-User Guide
-----------
+Getting Started
+---------------
 
-Get started with Carbon Black Cloud Python SDK here. For detailed information on the objects and methods exposed by Carbon Black Cloud Python SDK, see the full API Documentation below.
+Get started with Carbon Black Cloud Python SDK here. For detailed information on the objects and methods exposed by Carbon Black Cloud Python SDK, see the full SDK Documentation below.
 
 .. toctree::
    :caption: User Guide
@@ -57,8 +57,10 @@ Get started with Carbon Black Cloud Python SDK here. For detailed information on
    os_functional_testing
    changelog
 
-SDK Documentation
------------------
+Full SDK Documentation
+----------------------
+
+See detailed information on the objects and methods exposed by the Carbon Black Cloud Python SDK here.
 
 .. toctree::
    :caption: SDK Documentation

diff --git a/docs/porting-guide.rst b/docs/porting-guide.rst
@@ -2,7 +2,7 @@ Porting Applications from CBAPI to Carbon Black Cloud SDK
 =========================================================
 This guide will help you migrate from CBAPI to the Carbon Black Cloud Python SDK.
 
-Note: CBAPI applications using Carbon Black EDR (Protection) or Carbon Black App Control (Response) cannot be ported, as support for on-premise products is not present in
+Note: CBAPI applications using Carbon Black EDR (Response) or Carbon Black App Control (Protection) cannot be ported, as support for on-premise products is not present in
 the CBC SDK. Continue to use CBAPI for these applications.
 
 Overview

diff --git a/src/cbc_sdk/__init__.py b/src/cbc_sdk/__init__.py
@@ -4,7 +4,7 @@
 __author__ = 'Carbon Black Developer Network'
 __license__ = 'MIT'
 __copyright__ = 'Copyright 2020-2021 VMware Carbon Black'
-__version__ = '1.0.0'
+__version__ = '1.0.1'
 
 from .rest_api import CBCloudAPI
 from .base import UnrefreshableModel