Task/add initial files

.github/workflows/build-and-publish.yml

@@ -0,0 +1,37 @@
+name: Build & Publish
+
+on:
+  workflow_call:
+    secrets:
+      PYPI_TOKEN:
+          required: true
+
+jobs:
+
+  cd-job:
+    name: Continues Delivery
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+
+      - name: Build Artifacts
+        run: poetry build
+
+      - name: PyPi Release
+        env:
+          POETRY_HTTP_BASIC_PYPI_USERNAME: "__token__"
+          POETRY_HTTP_BASIC_PYPI_PASSWORD: "${{ secrets.PYPI_TOKEN }}"
+        run: poetry publish
+
+      - name: GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: >
+          gh release create ${GITHUB_REF_NAME}
+          --title ${GITHUB_REF_NAME}
+          dist/*

.github/workflows/check-release-tag.yml

@@ -0,0 +1,21 @@
+name: Check Release Tag
+
+on: workflow_call
+
+jobs:
+
+  check-tag-version-job:
+
+    name: Check Tag Version
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+
+      - name: Check Tag Version
+        # make sure the pushed/created tag matched the project version
+        run: "[[ `poetry version --short` == ${{ github.ref_name }} ]]"

.github/workflows/checks.yml

@@ -0,0 +1,113 @@
+name: Checks
+
+on: workflow_call
+
+jobs:
+
+  version-check-job:
+    name: Version Check
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+
+      - name: Check Version(s)
+        run: poetry run version-check version.py
+
+  build-documentation-job:
+    name: Build Documentation
+    needs: [version-check-job]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+
+      - name: Build Documentation
+        run: |
+          poetry run python -m nox -s build-docs
+
+  lint-job:
+    name: Linting (Python-${{ matrix.python-version }})
+    needs: [version-check-job]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Tests
+        run: poetry run nox -s lint
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: .lint.txt
+          path: .lint.txt
+
+  type-check-job:
+    name: Type Checking (Python-${{ matrix.python-version }})
+    needs: [version-check-job]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Run Tests
+        run: poetry run nox -s type-check
+
+  tests-job:
+    name: Tests (Python-${{ matrix.python-version }}, Exasol-${{ matrix.exasol-version}})
+    needs: [build-documentation-job, lint-job, type-check-job]
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10"]
+        exasol-version: ["7.1.9"]
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Calculate Test Coverage
+        run: poetry run nox -s coverage -- -- --db-version ${{ matrix.exasol-version }}
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: .coverage
+          path: .coverage

.github/workflows/ci-cd.yml

@@ -0,0 +1,28 @@
+name: CI/CD
+
+on:
+  push:
+    tags:
+      - '**'
+
+jobs:
+
+  check-tag-version-job:
+    name: Check Release Tag
+    uses: ./.github/workflows/check-release-tag.yml
+
+  ci-job:
+    name: Checks
+    needs: [ check-tag-version-job ]
+    uses: ./.github/workflows/checks.yml
+
+  cd-job:
+    name: Continues Delivery
+    needs: [ ci-job ]
+    uses: ./.github/workflows/build-and-publish.yml
+    secrets:
+      PYPI_TOKEN: ${{ secrets.PYPI_TOKEN }}
+
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml

.github/workflows/ci.yml

@@ -0,0 +1,24 @@
+name: CI
+
+on:
+  push:
+    branches-ignore:
+      - "github-pages/*"
+      - "gh-pages/*"
+      - "main"
+      - "master"
+  pull_request:
+    types: [opened, reopened]
+  schedule:
+    # “At 00:00 on every 7th day-of-month from 1 through 31.” (https://crontab.guru)
+    - cron: "0 0 1/7 * *"
+
+jobs:
+
+  ci-job:
+    name: Checks
+    uses: ./.github/workflows/checks.yml
+
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml

.github/workflows/gh-pages.yml

@@ -0,0 +1,27 @@
+name: Publish Documentation
+
+on: workflow_call
+
+jobs:
+
+  documentation-job:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+
+      - name: Build Documentation
+        run: |
+          poetry run python -m nox -s build-docs
+
+      - name: Deploy
+        uses: JamesIves/[email protected]
+        with:
+          branch: gh-pages
+          folder: .html-documentation
+          git-config-name: Github Action
+          git-config-email: [email protected]

.github/workflows/pr-merge.yml

@@ -0,0 +1,21 @@
+name: PR-Merge
+
+on:
+  push:
+    branches:
+      - 'main'
+      - 'master'
+
+jobs:
+
+  ci-job:
+    name: Checks
+    uses: ./.github/workflows/checks.yml
+
+  publish-docs:
+    name: Publish Documentation
+    uses: ./.github/workflows/gh-pages.yml
+
+  metrics:
+    needs: [ ci-job ]
+    uses: ./.github/workflows/report.yml

.github/workflows/report.yml

@@ -0,0 +1,57 @@
+name: Status Report
+
+on:
+  workflow_call:
+    secrets:
+      ALTERNATIVE_GITHUB_TOKEN:
+        required: false
+
+jobs:
+
+  report:
+    name: Generate Status Report
+    # currently report fails with error message
+    # subprocess.CalledProcessError: Command '['coverage', 'json',
+    # '--data-file=.coverage', '-o', '/tmp/tmpm01u0nf3/coverage.json']'
+    # returned non-zero exit status 2.
+    if: "contains(github.event.head_commit.message, '[generate-code-metrics-report]')"
+    runs-on: ubuntu-latest
+    env:
+      GITHUB_TOKEN: ${{ secrets.ALTERNATIVE_GITHUB_TOKEN ||  secrets.GITHUB_TOKEN }}
+
+    steps:
+      - name: SCM Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup Python & Poetry Environment
+        uses: exasol/python-toolbox/.github/actions/[email protected]
+
+      - name: Download Artifacts
+        uses: actions/download-artifact@v3
+        with:
+          path: ./artifacts
+
+      - name: Copy Artifacts into Root Folder
+        run: |
+          cp ./artifacts/.coverage/.coverage ./
+          cp ./artifacts/.lint.txt/.lint.txt ./
+
+      - name: Generate Report
+        run: poetry run nox -s report -- -- --format json | tee metrics.json
+
+      - name: Upload Artifacts
+        uses: actions/upload-artifact@v3
+        with:
+          name: metrics.json
+          path: metrics.json
+
+      - name: Generate GitHub Summary
+        run: |
+          echo -e "# Summary\n" >> $GITHUB_STEP_SUMMARY
+          poetry run nox -s report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
+          echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
+          poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
+          echo  -e "\n\n# Static Code Analysis\n" >> $GITHUB_STEP_SUMMARY
+          cat .lint.txt >> $GITHUB_STEP_SUMMARY

.gitignore

@@ -0,0 +1,7 @@
+.html-documentation
+/__pycache__
+/metrics.json
+/.lint.txt
+/.lint.json
+/.coverage
+TAGS

README.md

@@ -1,2 +1,4 @@
-# saas-api-python
-API to enable python applications connecting to Exasol database SaaS instances and using their SaaS services
+# SaaS API for Python
+
+API enabling Python applications connecting to Exasol database SaaS instances and using their SaaS services.
+

doc/changes/changelog.md

@@ -0,0 +1,12 @@
+# Changes
+
+* [0.1.0](changes_0.1.0.md)
+
+<!--- This MyST Parser Sphinx directive is necessary to keep Sphinx happy. We need list here all release letters again, because release droid and other scripts assume Markdown --->
+```{toctree}
+---
+hidden:
+---
+changes_0.1.0
+
+```

doc/changes/changes_0.1.0.md

@@ -0,0 +1,9 @@
+# Saas API Python 0.1.0, released <TBD>
+
+## Summary
+
+This is the initial release of the Exasol SaaS API for Python enabling Python applications connecting to Exasol database SaaS instances and using their SaaS services.
+
+## Changes
+
+n/a

doc/user_guide/user-guide.md

@@ -0,0 +1 @@
+# SaaS API for Python User Guide

error_code_config.yml

@@ -0,0 +1,3 @@
+error-tags:
+  SAPIPY:
+    highest-index: 0