Merge pull request #436 from carbonblack/release-1.5.0

CBAPI-4818: Release 1.5.0 Merge to Master

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
     hooks:
     -   id: flake8
         additional_dependencies: [flake8-docstrings]
-        args: ["--docstring-convention", "google"]
+        args: [ "--docstring-convention", "google"]
 -   repo: https://github.com/pre-commit/pre-commit-hooks
     rev: v4.0.1
     hooks:

.readthedocs.yaml

@@ -9,7 +9,7 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.8"
+    python: "3.11"
     # You can also specify other tool versions:
     # nodejs: "19"
     # rust: "1.64"

README.md

@@ -1,8 +1,8 @@
 # VMware Carbon Black Cloud Python SDK
 
-**Latest Version:** 1.4.3
+**Latest Version:** 1.5.0
 <br>
-**Release Date:** June 26, 2023
+**Release Date:** October 24, 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)
@@ -30,7 +30,7 @@ Visit [ReadTheDocs](https://carbon-black-cloud-python-sdk.readthedocs.io/en/late
 
 ## Requirements
 
-The Carbon Black Cloud Python SDK is design to work on Python 3.7 and above.
+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`
 
@@ -116,11 +116,17 @@ 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
 ```
 
+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

VERSION

@@ -1 +1 @@
-1.4.3
+1.5.0

codeship-services.yml

@@ -1,7 +1,3 @@
-testingpython37:
-  build:
-    dockerfile: ./docker/python3.7/Dockerfile
-
 testingpython38:
   build:
     dockerfile: ./docker/python3.8/Dockerfile
@@ -20,6 +16,10 @@ testingpython311:
   build:
     dockerfile: ./docker/python3.11/Dockerfile
 
+testingpython312:
+  build:
+    dockerfile: ./docker/python3.12/Dockerfile
+
 testingrhel:
   build:
     dockerfile: ./docker/rhel/Dockerfile

codeship-steps.yml

@@ -5,9 +5,6 @@
 - name: Tests
   type: parallel
   steps:
-  - name: testing python 3.7
-    service: testingpython37
-    command: pytest
   - name: testing python 3.8
     service: testingpython38
     command: bin/tests_n_reports.sh
@@ -20,6 +17,9 @@
   - name: testing python 3.11
     service: testingpython311
     command: pytest
+  - name: testing python 3.12
+    service: testingpython312
+    command: pytest
   - name: testing red hat
     service: testingrhel
     command: pytest
@@ -31,4 +31,4 @@
     command: pytest
   - name: testing suse
     service: testingsuse
-    command: pytest
+    command: env/bin/python3 -m pytest

docker/amazon/Dockerfile

@@ -1,5 +1,5 @@
-from amazonlinux:latest
-MAINTAINER [email protected]
+FROM amazonlinux:latest
+LABEL org.opencontainers.image.authors="[email protected]"
 
 COPY . /app
 WORKDIR /app

docker/python3.10/Dockerfile

@@ -1,5 +1,5 @@
-from python:3.10
-MAINTAINER [email protected]
+FROM python:3.10
+LABEL org.opencontainers.image.authors="[email protected]"
 
 COPY . /app
 WORKDIR /app

docker/python3.11/Dockerfile

@@ -1,5 +1,5 @@
-from python:3.11
-MAINTAINER [email protected]
+FROM python:3.11
+LABEL org.opencontainers.image.authors="[email protected]"
 
 COPY . /app
 WORKDIR /app

docker/python3.12/Dockerfile

@@ -0,0 +1,7 @@
+FROM python:3.12
+LABEL org.opencontainers.image.authors="[email protected]"
+
+COPY . /app
+WORKDIR /app
+
+RUN pip3 install -r requirements.txt

docker/python3.8/Dockerfile

@@ -1,5 +1,5 @@
-from python:3.8
-MAINTAINER [email protected]
+FROM python:3.8
+LABEL org.opencontainers.image.authors="[email protected]"
 
 COPY . /app
 WORKDIR /app

docker/python3.9/Dockerfile

@@ -1,5 +1,5 @@
-from python:3.9
-MAINTAINER [email protected]
+FROM python:3.9
+LABEL org.opencontainers.image.authors="[email protected]"
 
 COPY . /app
 WORKDIR /app

docker/rhel/Dockerfile

@@ -1,5 +1,5 @@
-from registry.access.redhat.com/ubi8/ubi:latest
-MAINTAINER [email protected]
+FROM registry.access.redhat.com/ubi8/ubi:latest
+LABEL org.opencontainers.image.authors="[email protected]"
 
 COPY . /app
 WORKDIR /app

docker/suse/Dockerfile

@@ -1,11 +1,15 @@
-from opensuse/tumbleweed
-MAINTAINER [email protected]
+FROM opensuse/tumbleweed
+LABEL org.opencontainers.image.authors="[email protected]"
 
 COPY . /app
 WORKDIR /app
 
 RUN zypper --non-interactive install python3-devel
 RUN zypper --non-interactive install python3-pip
 RUN zypper --non-interactive install gcc
-RUN pip3 install -r requirements.txt
-RUN pip3 install .
+
+RUN python3 -m venv env
+RUN source env/bin/activate
+
+RUN env/bin/pip3 install --break-system-packages -r requirements.txt
+RUN env/bin/pip3 install --break-system-packages .

docker/ubuntu/Dockerfile

@@ -1,5 +1,5 @@
-from ubuntu:20.04
-MAINTAINER [email protected]
+FROM ubuntu:20.04
+LABEL org.opencontainers.image.authors="[email protected]"
 
 COPY . /app
 WORKDIR /app