sap-cloud-sdk 0.0.1__tar.gz

sap_cloud_sdk-0.0.1/.commitlintrc

@@ -0,0 +1,3 @@
+{
+  "extends": ["@commitlint/config-conventional"]
+}

sap_cloud_sdk-0.0.1/.env_integration_tests.example

@@ -0,0 +1,15 @@
+CLOUD_SDK_OTEL_DISABLED=true
+
+CLOUD_SDK_CFG_AUDITLOG_DEFAULT_URL=https://your-auditlog-api-url-here
+CLOUD_SDK_CFG_AUDITLOG_DEFAULT_UAA='{"url":"https://your-auth-url","clientid":"your-client-id","clientsecret":"your-client-secret"}'
+
+CLOUD_SDK_CFG_OBJECTSTORE_DEFAULT_HOST=your-objectstore-host-here
+CLOUD_SDK_CFG_OBJECTSTORE_DEFAULT_ACCESS_KEY_ID=your-access-key-id-here
+CLOUD_SDK_CFG_OBJECTSTORE_DEFAULT_SECRET_ACCESS_KEY=your-secret-access-key-here
+CLOUD_SDK_CFG_OBJECTSTORE_DEFAULT_BUCKET=your-bucket-name-here
+
+CLOUD_SDK_CFG_DESTINATION_DEFAULT_CLIENTID=your-destination-client-id-here
+CLOUD_SDK_CFG_DESTINATION_DEFAULT_CLIENTSECRET=your-destination-client-secret-here
+CLOUD_SDK_CFG_DESTINATION_DEFAULT_URL=https://your-destination-auth-url-here
+CLOUD_SDK_CFG_DESTINATION_DEFAULT_URI=https://your-destination-configuration-uri-here
+CLOUD_SDK_CFG_DESTINATION_DEFAULT_IDENTITYZONE=your-identity-zone-here

sap_cloud_sdk-0.0.1/.github/CODEOWNERS

@@ -0,0 +1 @@
+*   @SAP/cloud-sdk-python-team

sap_cloud_sdk-0.0.1/.github/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,107 @@
+name: Bug Report
+description: Released feature does not work as expected in the SAP Cloud SDK for Python.
+labels:
+  - bug
+body:
+  - type: textarea
+    attributes:
+      label: "Describe the Bug"
+      description: "A clear and concise description of what the bug is."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Steps to Reproduce"
+      description: "Steps to reproduce the behavior."
+      placeholder: |
+        1. Set up ...
+        2. Execute ...
+        3. Confirm ...
+        4. See error
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Expected Behavior"
+      description: "A clear and concise description of what you expected to happen. In case of HTTP requests, a working Postman (or similar) request is very helpful."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Screenshots"
+      description: "Add screenshots to help explain your problem."
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: "Used Versions"
+      description: "Provide versions used in the project."
+      value: |
+        - Python version via `python --version`: ...
+        - SAP Cloud SDK for Python version: ...
+        - Framework version (if applicable, e.g., Flask, FastAPI): ...
+        
+        <details><summary>Installed packages via <code>pip list</code> or <code>uv pip list</code></summary>
+            
+        ```
+        Package list here
+        ```
+        </details>
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Code Examples"
+      description: "Add code snippets as examples to help explain your problem. Please remove sensitive information."
+      value: |
+        ```python
+        # Your code here
+        ```
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: "Stack Trace"
+      description: "Add your stack trace here. Please remove sensitive information."
+    validations:
+      required: false
+  - type: textarea
+    attributes:
+      label: "Log File"
+      description: "Add your log file or related error message. Please remove sensitive information."
+      value: |
+        <details><summary>Log file</summary>
+        ...
+        </details>
+    validations:
+      required: false
+  - type: dropdown
+    attributes:
+      label: "Affected Development Phase"
+      description: "Choose the development phase affected by this issue."
+      multiple: false
+      options:
+        - Getting Started
+        - Development
+        - Release
+        - Production
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: "Impact"
+      description: "Choose the impact severity."
+      multiple: false
+      options:
+        - No Impact
+        - Inconvenience
+        - Impaired
+        - Blocked
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Timeline"
+      description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
+    validations:
+      required: false

sap_cloud_sdk-0.0.1/.github/ISSUE_TEMPLATE/feature-request.yml

@@ -0,0 +1,53 @@
+name: Feature Request
+description: Request a new feature to help your project using the SAP Cloud SDK for Python.
+labels:
+  - feature request
+body:
+  - type: textarea
+    attributes:
+      label: "Describe the Problem"
+      description: "A clear and concise description of what the missing feature is"
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Propose a Solution"
+      description: "A clear and concise description of what you want to happen. In case of HTTP requests, a working Postman (or similar) request is very helpful."
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Describe Alternatives"
+      description: "A clear and concise description of any alternative solutions or features you've considered."
+    validations:
+      required: false
+  - type: dropdown
+    attributes:
+      label: "Affected Development Phase"
+      description: "Choose the development phase affected by this issue."
+      multiple: false
+      options:
+        - Getting Started
+        - Development
+        - Release
+        - Production
+    validations:
+      required: true
+  - type: dropdown
+    attributes:
+      label: "Impact"
+      description: "Choose the impact severity."
+      multiple: false
+      options:
+        - No Impact
+        - Inconvenience
+        - Impaired
+        - Blocked
+    validations:
+      required: true
+  - type: textarea
+    attributes:
+      label: "Timeline"
+      description: "Please briefly state your timeline, e.g., Go-Live in 12 weeks."
+    validations:
+      required: false

sap_cloud_sdk-0.0.1/.github/ISSUE_TEMPLATE/question.yml

@@ -0,0 +1,11 @@
+name: Question
+description: Ask a question about the SAP Cloud SDK for Python.
+labels:
+  - question
+body:
+  - type: textarea
+    attributes:
+      label: "Ask the Question"
+      description: Give  a clear and concise description.
+    validations:
+      required: true

sap_cloud_sdk-0.0.1/.github/codeql/codeql-config.yml

@@ -0,0 +1,6 @@
+paths:
+  - src
+  - tests
+paths-ignore:
+  - docs
+  - .github

sap_cloud_sdk-0.0.1/.github/dependabot.yml

@@ -0,0 +1,35 @@
+version: 2
+updates:
+  # Enable version updates for Python pip dependencies
+  - package-ecosystem: "pip"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+      day: "monday"
+      time: "09:00"
+   
+    # Commit message configuration
+    commit-message:
+      prefix: "chore"
+      prefix-development: "chore"
+      include: "scope"
+    # Pull request configuration
+    pull-request-branch-name:
+      separator: "/"
+    rebase-strategy: "auto"
+    # Target branch for updates
+    target-branch: "main"
+  
+  # Enable version updates for GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+      day: "monday"
+      time: "09:00"
+    labels:
+      - "dependencies"
+      - "github-actions"
+    commit-message:
+      prefix: "chore"
+      include: "scope"

sap_cloud_sdk-0.0.1/.github/pull_request_template.md

@@ -0,0 +1,54 @@
+## Description
+
+Provide a clear description of your changes here.
+
+## Related Issue
+
+Closes #<issue_number>
+
+(Link to the GitHub issue this PR addresses)
+
+## Type of Change
+
+Please check the relevant option:
+
+- [ ] Bug fix (non-breaking change that fixes an issue)
+- [ ] New feature (non-breaking change that adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+- [ ] Documentation update
+- [ ] Code refactoring
+- [ ] Dependency update
+
+## How to Test
+
+Describe how reviewers can test your changes:
+
+1. Step 1
+2. Step 2
+3. Expected result
+
+## Checklist
+
+Before submitting your PR, please review and check the following:
+
+- [ ] I have read the [Contributing Guidelines](../CONTRIBUTING.md)
+- [ ] I have verified that my changes solve the issue
+- [ ] I have added/updated automated tests to cover my changes
+- [ ] All tests pass locally
+- [ ] I have verified that my code follows the [Code Guidelines](../docs/GUIDELINES.md)
+- [ ] I have updated documentation (if applicable)
+- [ ] I have added type hints for all public APIs
+- [ ] My code does not contain sensitive information (credentials, tokens, etc.)
+- [ ] I have followed [Conventional Commits](https://www.conventionalcommits.org/) for commit messages
+
+## Breaking Changes
+
+If this PR introduces breaking changes, please describe:
+
+- What breaks
+- Migration path for users
+- Alternative approaches considered
+
+## Additional Notes
+
+Add any additional context, screenshots, or information that would help reviewers.

sap_cloud_sdk-0.0.1/.github/workflows/build.yaml

@@ -0,0 +1,159 @@
+name: Build
+
+on:
+  pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+
+env:
+  PYTHON_VERSION: "3.11"
+  SDK_DIST_NAME: "sap_cloud_sdk"
+  COVERAGE_THRESHOLD: "80"
+
+jobs:
+  build:
+    name: Build SDK
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      pull-requests: write
+    steps:
+      - name: "Checkout Repository"
+        uses: actions/checkout@v4
+        with:
+          ref: ${{ github.event.pull_request.head.sha || github.sha }}
+          fetch-depth: 0
+
+      - name: "Install uv"
+        uses: astral-sh/setup-uv@v4
+        with:
+          version: "latest"
+          enable-cache: true
+
+      - name: "Set up Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ env.PYTHON_VERSION }}
+
+      - name: "Run Ruff Linter"
+        run: uv run ruff check --output-format=github .
+
+      - name: "Run Ruff Formatter Check"
+        run: uv run ruff format --check --diff .
+
+      - name: "Run ty Type Check"
+        run: uv run ty check --output-format github --python-version ${{ env.PYTHON_VERSION }} .
+
+      - name: "Run Unit Tests with Coverage"
+        run: uv run pytest -m "not integration" --cov=src/sap_cloud_sdk --cov-report=xml --cov-report=html --cov-report=term-missing
+
+      - name: "Upload Coverage Report"
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: |
+            coverage.xml
+            htmlcov/
+          retention-days: 30
+
+      - name: "Coverage Report Summary"
+        run: |
+          echo "## 📊 Coverage Report" >> $GITHUB_STEP_SUMMARY
+          echo "" >> $GITHUB_STEP_SUMMARY
+          uv run coverage report --format=markdown --skip-empty >> $GITHUB_STEP_SUMMARY
+
+      - name: "Post Coverage Comment on PR"
+        if: github.event_name == 'pull_request'
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          # Extract unique module paths from changed files
+          MODULE_PATHS=$(git diff --name-only "${{ github.event.pull_request.base.sha }}" "${{ github.event.pull_request.head.sha }}" \
+            | grep -E '^src/sap_cloud_sdk/[^/]+/.*\.py$' \
+            | grep -vE '__pycache__' \
+            | sed -E -e 's|^(src/sap_cloud_sdk/core)/.*|\1|' -e 't' -e 's|^(src/sap_cloud_sdk/[^/]+)/.*|\1|' \
+            | sort -u)
+          
+          if [ -z "$MODULE_PATHS" ]; then
+            echo "No module-level Python files changed, skipping coverage report"
+            exit 0
+          fi
+          
+          # Initialize tracking
+          FAILED_MODULES=()
+          COMMENT_BODY="## 📊 Coverage Report by Module"$'\n\n'
+          
+          # Process each module
+          while IFS= read -r module_path; do
+            echo "Checking coverage for $module_path..."
+            
+            # Generate coverage report
+            MODULE_COVERAGE=$(uv run coverage report \
+              --include="$module_path/*.py,$module_path/**/*.py" \
+              --format=markdown \
+              --skip-empty \
+              --skip-covered 2>/dev/null || echo "No coverage data for $module_path")
+            
+            # Check if coverage meets threshold
+            if uv run coverage report \
+              --include="$module_path/*.py,$module_path/**/*.py" \
+              --skip-empty \
+              --fail-under=${{ env.COVERAGE_THRESHOLD }} >/dev/null 2>&1; then
+              COMMENT_BODY+="### \`$module_path\` ✅"$'\n\n'"$MODULE_COVERAGE"$'\n\n'
+            else
+              COMMENT_BODY+="### \`$module_path\` ❌"$'\n\n'"$MODULE_COVERAGE"$'\n\n'
+              FAILED_MODULES+=("$module_path")
+            fi
+          done <<< "$MODULE_PATHS"
+          
+          # Add overall status
+          COMMENT_BODY+="---"$'\n\n'
+          if [ ${#FAILED_MODULES[@]} -eq 0 ]; then
+            COMMENT_BODY+="✅ **All changed modules meet the ${{ env.COVERAGE_THRESHOLD }}% coverage threshold!**"
+          else
+            COMMENT_BODY+="❌ **Coverage check failed!** The following modules are below ${{ env.COVERAGE_THRESHOLD }}% coverage: \`$(IFS=', '; echo "${FAILED_MODULES[*]}")\`"
+          fi
+          
+          COMMENT_BODY+=$'\n\n'"---"$'\n'"*Coverage report from commit [\`${GITHUB_SHA:0:7}\`](${{ github.event.pull_request.head.repo.html_url }}/commit/${{ github.event.pull_request.head.sha }})*"
+          
+          # Post comment on PR
+          echo "$COMMENT_BODY" | gh pr comment ${{ github.event.pull_request.number }} --body-file -
+          
+          # Exit with failure if any module failed
+          [ ${#FAILED_MODULES[@]} -eq 0 ] || exit 1
+
+      - name: "Build Packages"
+        run: uv build
+
+      - name: "List Build Artifacts"
+        run: |
+          echo "Build artifacts:"
+          ls -lh dist/
+
+      - name: "Verify Build Artifacts"
+        run: |
+          # Check that both wheel and source distribution were created
+          wheel_count=$(ls -1 dist/*.whl 2>/dev/null | wc -l)
+          tar_count=$(ls -1 dist/*.tar.gz 2>/dev/null | wc -l)
+          
+          if [ "$wheel_count" -eq 0 ]; then
+            echo "ERROR: No wheel file found"
+            exit 1
+          fi
+          
+          if [ "$tar_count" -eq 0 ]; then
+            echo "ERROR: No source distribution found"
+            exit 1
+          fi
+          
+          echo "✓ Build artifacts verified: $wheel_count wheel(s), $tar_count source distribution(s)"
+
+      - name: "Upload Build Artifacts"
+        uses: actions/upload-artifact@v4
+        with:
+          name: ${{ env.SDK_DIST_NAME }}
+          path: dist/
+          retention-days: 7

sap_cloud_sdk-0.0.1/.github/workflows/codeql.yaml

@@ -0,0 +1,43 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '19 2 * * 4'
+
+jobs:
+  analyze:
+    name: Analyze (${{ matrix.language }})
+    runs-on: ubuntu-latest
+    timeout-minutes: 360
+    permissions:
+      security-events: write
+      packages: read
+      actions: read
+      contents: read
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+        - language: python
+          build-mode: none
+        
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v6
+
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v4
+      with:
+        languages: ${{ matrix.language }}
+        build-mode: ${{ matrix.build-mode }}
+        config-file: ./.github/codeql/codeql-config.yml
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v4
+      with:
+        category: "/language:${{matrix.language}}"

sap_cloud_sdk-0.0.1/.github/workflows/commit-validation.yaml

@@ -0,0 +1,34 @@
+name: Commit Validation
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  commit-validation:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Setup node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install commitlint
+        run: npm install -g @commitlint/cli @commitlint/config-conventional
+
+      - name: Validate current commit (last commit)
+        if: ${{ github.event_name == 'push' }}
+        run: npx commitlint --last --verbose
+
+      - name: Validate PR title
+        if: ${{ github.event_name == 'pull_request' }}
+        run: echo "${{ github.event.pull_request.title }}" | npx commitlint --verbose

sap_cloud_sdk-0.0.1/.github/workflows/integration-tests.yml

@@ -0,0 +1,59 @@
+name: Integration Tests
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - '.github/workflows/integration-tests.yml'
+      - 'src/**/*.py'
+      - 'tests/**/*.py'
+      - 'pyproject.toml'
+  push:
+    branches: [main]
+    paths:
+      - '.github/workflows/integration-tests.yml'
+      - 'src/**/*.py'
+      - 'tests/**/*.py'
+      - 'pyproject.toml'
+
+jobs:
+  integration-tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+
+      - name: Install dependencies
+        run: uv sync --dev
+
+      - name: Set up integration test environment
+        run: |
+          echo "Setting up environment variables for integration tests..."
+          
+          # Process GitHub secrets (all configuration stored as secrets)
+          echo '${{ toJSON(secrets) }}' | jq -r 'to_entries[] | select(.key | startswith("CLOUD_SDK_CFG_")) | "\(.key)=\(.value)"' | while read line; do
+            echo "$line" >> $GITHUB_ENV
+            var_name=$(echo "$line" | cut -d= -f1)
+            echo "Set secret: $var_name"
+          done
+          
+          # Process GitHub variables (all configuration stored as variables)
+          echo '${{ toJSON(vars) }}' | jq -r 'to_entries[] | select(.key | startswith("CLOUD_SDK_CFG_")) | "\(.key)=\(.value)"' | while read line; do
+            echo "$line" >> $GITHUB_ENV
+            var_name=$(echo "$line" | cut -d= -f1)
+            echo "Set variable: $var_name"
+          done
+          
+          echo "Environment setup complete - automatically configured all CLOUD_SDK_CFG_* environment variables and secrets"
+
+      - name: Run integration tests
+        run: uv run pytest tests/*/integration/ -v --tb=short

sap_cloud_sdk-0.0.1/.github/workflows/release.yml

@@ -0,0 +1,60 @@
+name: Publish Package to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    permissions:
+      contents: read
+      id-token: write
+    name: Publish to PyPI
+    runs-on: ubuntu-latest
+    environment: 'pypi:sap-cloud-sdk'
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+      
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.11"
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v4
+        with:
+          enable-cache: true
+
+      - name: Read package name and version from pyproject.toml
+        id: metadata
+        run: |
+          pip install toml
+          PKG_NAME=$(python -c "import toml; print(toml.load('pyproject.toml')['project']['name'])")
+          VERSION=$(python -c "import toml; print(toml.load('pyproject.toml')['project']['version'])")
+          echo "Publishing $PKG_NAME version $VERSION to PyPI"
+          echo "name=$PKG_NAME" >> $GITHUB_OUTPUT
+          echo "version=$VERSION" >> $GITHUB_OUTPUT
+
+      - name: Check if version already exists on PyPI
+        run: |
+          PKG_NAME="${{ steps.metadata.outputs.name }}"
+          VERSION="${{ steps.metadata.outputs.version }}"
+          
+          echo "Checking if $PKG_NAME version $VERSION exists on PyPI..."
+          
+          HTTP_STATUS=$(curl -s -o /dev/null -w "%{http_code}" "https://pypi.org/pypi/$PKG_NAME/$VERSION/json")
+          
+          if [ "$HTTP_STATUS" = "200" ]; then
+            echo "ERROR: Version $VERSION of $PKG_NAME already exists on PyPI!"
+            echo "Please increment the version in pyproject.toml before publishing."
+            exit 1
+          else
+            echo "Version $VERSION is available for upload to PyPI"
+          fi
+
+      - name: Build release distribution
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@v1.13.0

sap_cloud_sdk-0.0.1/.github/workflows/reuse.yaml

@@ -0,0 +1,18 @@
+name: REUSE Compliance Check
+
+on:
+  push:
+    branches: 
+      - "main"
+  pull_request:
+    branches: 
+      - "main"
+
+jobs:
+  check-reuse-compliance:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: REUSE Compliance Check
+      uses: fsfe/reuse-action@v6.0.0