Merge pull request #19 from soda480/0.3.1

build: add ability to build against all targeted Python versions

Author: soda480

.github/workflows/main.yml

@@ -9,23 +9,48 @@ on:
     branches:
       - main
 jobs:
-  build:
+  build-images:
+    strategy:
+      matrix:
+        version: ['3.7', '3.8', '3.9', '3.10']
+    name: Build Python Docker images
     runs-on: ubuntu-20.04
     steps:
-    - uses: actions/checkout@v2
-
-    - name: Build Docker image
-      run: |
-        docker image build --target build-image -t github3api:latest .
-
-    - name: Prepare coverage
-      run: |
-        ID=$(docker create github3api)
-        docker cp $ID:/code/target/reports/github3api_coverage.xml github3api_coverage.xml
-        sed -i -e 's,filename="github3api/,filename="src/main/python/github3api/,g' github3api_coverage.xml
-
-    - name: Upload coverage to Codecov
-      uses: codecov/codecov-action@v1
-      with:
-        token: ${{ secrets.CODECOV_TOKEN }}
-        file: github3api_coverage.xml
+      - uses: actions/checkout@v3
+      - name: build github3api ${{ matrix.version }} image
+        run:
+          docker image build --target build-image --build-arg PYTHON_VERSION=${{ matrix.version }} -t github3api:${{ matrix.version }} .
+      - name: save github3api ${{ matrix.version }} image
+        if: ${{ matrix.version == '3.9' }}
+        run: |
+          mkdir -p images
+          docker save --output images/github3api-${{ matrix.version }}.tar github3api:${{ matrix.version }}
+      - name: upload github3api ${{ matrix.version }} image artifact
+        if: ${{ matrix.version == '3.9' }}
+        uses: actions/upload-artifact@v2
+        with:
+          name: image
+          path: images/github3api-${{ matrix.version }}.tar
+  coverage:
+    name: Publish Code Coverage Report
+    needs: build-images
+    runs-on: ubuntu-20.04
+    steps:
+      - name: download image artifact
+        uses: actions/download-artifact@v2
+        with:
+          name: image
+          path: images/
+      - name: load image
+        run:
+          docker load --input images/github3api-3.9.tar
+      - name: prepare report
+        run: |
+          ID=$(docker create github3api:3.9)
+          docker cp $ID:/code/target/reports/github3api_coverage.xml github3api_coverage.xml
+          sed -i -e 's,filename="github3api/,filename="src/main/python/github3api/,g' github3api_coverage.xml
+      - name: upload report
+        uses: codecov/codecov-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          file: github3api_coverage.xml

Dockerfile

@@ -13,14 +13,15 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 #
-FROM python:3.9-slim AS build-image
+ARG PYTHON_VERSION=3.9
+FROM python:${PYTHON_VERSION}-slim AS build-image
 ENV PYTHONDONTWRITEBYTECODE 1
 WORKDIR /code
 COPY . /code/
-RUN pip install pybuilder
-RUN pyb install
+RUN pip install --upgrade pip && pip install pybuilder
+RUN pyb -X && pyb install
 
-FROM python:3.9-alpine
+FROM python:${PYTHON_VERSION}-slim
 ENV PYTHONDONTWRITEBYTECODE 1
 WORKDIR /opt/github3api
 COPY --from=build-image /code/target/dist/github3api-*/dist/github3api-*.tar.gz /opt/github3api

README.md

@@ -1,22 +1,22 @@
-# github3api #
+# github3api
 [![GitHub Workflow Status](https://github.com/soda480/github3api/workflows/build/badge.svg)](https://github.com/soda480/github3api/actions)
 [![Code Coverage](https://codecov.io/gh/soda480/github3api/branch/master/graph/badge.svg)](https://codecov.io/gh/soda480/github3api)
 [![Code Grade](https://api.codiga.io/project/13337/status/svg)](https://frontend.code-inspector.com/project/13337/dashboard)
 [![vulnerabilities](https://img.shields.io/badge/vulnerabilities-None-brightgreen)](https://pypi.org/project/bandit/)
 [![PyPI version](https://badge.fury.io/py/github3api.svg)](https://app.codiga.io/public/project/13337/github3api/dashboard)
-[![python](https://img.shields.io/badge/python-3.9-teal)](https://www.python.org/downloads/)
+[![python](https://img.shields.io/badge/python-3.7%20%7C%203.8%20%7C%203.9%20%7C%203.10-teal)](https://www.python.org/downloads/)
 
 An advanced REST client for the GitHub API. It is a subclass of [rest3client](https://pypi.org/project/rest3client/) tailored for the GitHub API with special optional directives for GET requests that can return all pages from an endpoint or return a generator that can be iterated over (for paged requests). By default all requests will be retried if ratelimit request limit is reached.
 
 Support for executing Graphql queries including paging; Graphql queries are also retried if Graphql rate limiting occurs.
 
 
-### Installation ###
+### Installation
 ```bash
 pip install github3api
 ```
 
-### Example Usage ###
+### Example Usage
 
 ```python
 >>> from github3api import GitHubAPI
@@ -132,7 +132,7 @@ For Graphql paged queries:
 - the keys method argument is a dot annotated string that is used to access the resulting dictionary response object
 - the query is retried every 60 seconds (for up to an hour) if a ratelimit occur
 
-### Projects using `github3api` ###
+### Projects using `github3api`
 
 * [edgexfoundry/sync-github-labels](https://github.com/edgexfoundry/cd-management/tree/git-label-sync) A script that synchronizes GitHub labels and milestones
 
@@ -146,7 +146,7 @@ For Graphql paged queries:
 
 * [edgexfoundry/edgex-dev-badge](https://github.com/edgexfoundry/edgex-dev-badge) Rules based GitHub badge scanner
 
-### Development ###
+### Development
 
 Ensure the latest version of Docker is installed on your development server. Fork and clone the repository.
 
@@ -169,7 +169,7 @@ docker container run \
 -e https_proxy \
 -v $PWD:/code \
 github3api:latest \
-/bin/bash
+bash
 ```
 
 Execute the build:

build.py

@@ -30,7 +30,7 @@
 authors = [Author('Emilio Reyes', 'emilio.reyes@intel.com')]
 summary = 'An advanced REST client for the GitHub API'
 url = 'https://github.com/soda480/github3api'
-version = '0.3.0'
+version = '0.3.1'
 default_task = [
     'clean',
     'analyze',
@@ -65,10 +65,10 @@ def set_properties(project):
         'License :: OSI Approved :: Apache Software License',
         'Operating System :: POSIX :: Linux',
         'Programming Language :: Python',
-        'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
         'Topic :: Software Development :: Libraries',
         'Topic :: Software Development :: Libraries :: Python Modules',
         'Topic :: System :: Networking',
@@ -77,4 +77,3 @@ def set_properties(project):
     project.set_property('radon_break_build_complexity_threshold', 14)
     project.set_property('bandit_break_build', True)
     project.set_property('anybadge_exclude', 'coverage, complexity')
-    project.set_property('anybadge_use_shields', True)

build.sh

@@ -0,0 +1,5 @@
+versions=( '3.7' '3.8' '3.9' '3.10' )
+for version in "${versions[@]}";
+do
+    docker image build --build-arg PYTHON_VERSION=$version -t github3api:$version .
+done

pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["pybuilder>=0.12.0"]
+build-backend = "pybuilder.pep517"