smartlyq 0.1.2__tar.gz

smartlyq-0.1.2/.githooks/pre-commit

@@ -0,0 +1,35 @@
+#!/usr/bin/env bash
+# Pre-commit secret scan for this PUBLIC repo.
+#
+# Enable once per clone:
+#   git config core.hooksPath .githooks
+#
+# Uses gitleaks when installed (full ruleset); otherwise falls back to a
+# lightweight grep so the gate still works without extra tooling.
+set -euo pipefail
+
+if command -v gitleaks >/dev/null 2>&1; then
+  if ! gitleaks protect --staged --redact --no-banner --config .gitleaks.toml; then
+    echo ""
+    echo "✖ gitleaks flagged a potential secret in your staged changes. Commit blocked."
+    echo "  Remove the value (use a placeholder like YOUR_API_KEY) and re-commit."
+    exit 1
+  fi
+  exit 0
+fi
+
+# --- Fallback: grep staged additions for high-signal secret patterns ---------
+staged="$(git diff --cached --name-only --diff-filter=ACM)"
+[ -z "$staged" ] && exit 0
+
+patterns='sqk_(live|test)_[A-Za-z0-9]{12,}|AKIA[0-9A-Z]{16}|-----BEGIN [A-Z ]*PRIVATE KEY-----|xox[baprs]-[0-9A-Za-z-]{10,}|gh[pousr]_[0-9A-Za-z]{30,}|AIza[0-9A-Za-z_-]{30,}'
+allow='x{8,}|YOUR_|example|placeholder|redacted|changeme'
+
+hits="$(git diff --cached -U0 -- $staged | grep '^+' | grep -vE '^\+\+\+' | grep -EI "$patterns" | grep -viE "$allow" || true)"
+if [ -n "$hits" ]; then
+  echo "✖ Potential secret detected in staged changes (install gitleaks for a full scan):"
+  echo "$hits"
+  echo "Commit blocked. Replace the value with a placeholder and re-commit."
+  exit 1
+fi
+exit 0

smartlyq-0.1.2/.github/workflows/ci.yml

@@ -0,0 +1,26 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python: ['3.9', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install dependencies
+        run: pip install httpx pytest
+
+      - name: Run tests
+        run: python -m pytest -q

smartlyq-0.1.2/.github/workflows/generate.yml

@@ -0,0 +1,141 @@
+name: Regenerate
+
+on:
+  # Fired by the docs repository when openapi.json changes
+  repository_dispatch:
+    types: [openapi-updated]
+  workflow_dispatch:
+    inputs:
+      force_publish:
+        description: 'Bump and publish even if the spec is unchanged'
+        type: boolean
+        default: false
+  schedule:
+    # Daily safety net in case a dispatch is missed
+    - cron: '35 4 * * *'
+
+concurrency:
+  group: regenerate-sdk
+  cancel-in-progress: false
+
+jobs:
+  generate:
+    name: Regenerate from OpenAPI
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      # Lets PyPI verify publishes via Trusted Publishing (OIDC) - no token needed
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          fetch-depth: 0
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: pip install httpx pytest build
+
+      - name: Fetch latest OpenAPI spec
+        run: curl -f --retry 5 --retry-delay 2 --retry-all-errors --max-time 60 -o openapi.json https://docs.smartlyq.com/openapi.json
+
+      - name: Generate SDK
+        run: python scripts/generate_client.py
+
+      - name: Generate README reference
+        run: python scripts/generate_readme.py
+
+      - name: Generate endpoint tests
+        run: python scripts/generate_tests.py
+
+      - name: Run tests
+        run: python -m pytest -q
+
+      - name: Check for changes
+        id: changes
+        run: |
+          git add -A
+          if ! git diff --staged --quiet || [ "${{ inputs.force_publish }}" = "true" ]; then
+            echo "has_changes=true" >> $GITHUB_OUTPUT
+          else
+            echo "has_changes=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Bump version and commit
+        if: steps.changes.outputs.has_changes == 'true'
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "github-actions[bot]@users.noreply.github.com"
+
+          python - <<'EOF'
+          import re
+          path = "smartlyq/_version.py"
+          src = open(path).read()
+          m = re.search(r'"(\d+)\.(\d+)\.(\d+)"', src)
+          major, minor, patch = map(int, m.groups())
+          open(path, "w").write(f'__version__ = "{major}.{minor}.{patch + 1}"\n')
+          EOF
+
+          NEW_VERSION=$(python -c "import re;print(re.search(r'\"(.+)\"', open('smartlyq/_version.py').read()).group(1))")
+          echo "NEW_VERSION=$NEW_VERSION" >> $GITHUB_ENV
+
+          git add -A
+          git commit -m "chore: regenerate from OpenAPI spec
+
+          Auto-generated SDK update (v$NEW_VERSION)"
+
+          # Retry with rebase to survive concurrent dispatches
+          for attempt in 1 2 3; do
+            if git push; then break; fi
+            echo "Push attempt $attempt failed; rebasing and retrying..."
+            git pull --rebase origin main
+            sleep $((attempt * 5))
+          done
+
+      # Runs unconditionally so a version that never reached PyPI publishes on
+      # the next run; already-published versions skip cleanly.
+      - name: Check if version already published
+        id: check_published
+        run: |
+          CURRENT_VERSION=$(python -c "import re;print(re.search(r'\"(.+)\"', open('smartlyq/_version.py').read()).group(1))")
+          echo "version=${CURRENT_VERSION}" >> $GITHUB_OUTPUT
+          if curl -sf "https://pypi.org/pypi/smartlyq/${CURRENT_VERSION}/json" >/dev/null; then
+            echo "skip=true" >> $GITHUB_OUTPUT
+            echo "Version ${CURRENT_VERSION} already on PyPI, skipping publish."
+          else
+            echo "skip=false" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Build distribution
+        if: steps.check_published.outputs.skip != 'true'
+        run: python -m build
+
+      # Publishes via PyPI Trusted Publishing (OIDC) - no token secret involved.
+      # NOTE: no continue-on-error. A failed publish must fail the run loudly.
+      - name: Publish to PyPI
+        if: steps.check_published.outputs.skip != 'true'
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+      - name: Create GitHub Release
+        if: steps.check_published.outputs.skip != 'true'
+        uses: softprops/action-gh-release@v1
+        with:
+          tag_name: v${{ steps.check_published.outputs.version }}
+          name: v${{ steps.check_published.outputs.version }}
+          generate_release_notes: true
+          body: |
+            ## Auto-generated SDK update
+
+            This release was generated from the latest OpenAPI spec.
+
+            ```bash
+            pip install smartlyq==${{ steps.check_published.outputs.version }}
+            ```
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

smartlyq-0.1.2/.github/workflows/secret-scan.yml

@@ -0,0 +1,26 @@
+name: Secret scan
+
+# Blocks secrets from landing in this public repo. Runs on every push and PR,
+# scanning the full history of the pushed range against .gitleaks.toml.
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch: {}
+
+permissions:
+  contents: read
+
+jobs:
+  gitleaks:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0   # full history so newly-pushed commits are scanned
+      # Runs the gitleaks CLI directly: the wrapper action requires a license
+      # key on organization-owned repos; the CLI itself is free (MIT).
+      - name: Run gitleaks
+        run: |
+          curl -sSfL https://github.com/gitleaks/gitleaks/releases/download/v8.30.1/gitleaks_8.30.1_linux_x64.tar.gz | tar -xz gitleaks
+          ./gitleaks git --config .gitleaks.toml --redact --no-banner --verbose .

smartlyq-0.1.2/.gitignore

@@ -0,0 +1,13 @@
+.venv/
+__pycache__/
+dist/
+*.egg-info/
+.pytest_cache/
+*.log
+.DS_Store
+
+# Never commit local env or key material
+.env
+.env.*
+*.pem
+*.key

smartlyq-0.1.2/.gitleaks.toml

@@ -0,0 +1,37 @@
+# Secret-scan config for this PUBLIC repo (used by the pre-commit hook and CI).
+# Extends gitleaks' built-in ruleset (AWS keys, private keys, GitHub/Slack/Stripe
+# tokens, generic high-entropy strings, etc.) with SmartlyQ-specific rules.
+title = "SmartlyQ public-repo secret scan"
+
+[extend]
+useDefault = true
+
+# --- SmartlyQ API keys -------------------------------------------------------
+[[rules]]
+id = "smartlyq-api-key"
+description = "SmartlyQ API key (sqk_live_ / sqk_test_)"
+regex = '''sqk_(live|test)_[A-Za-z0-9]{12,}'''
+keywords = ["sqk_live_", "sqk_test_"]
+  [rules.allowlist]
+  description = "Documentation placeholders (e.g. sqk_live_xxxxxxxxxxxx)"
+  regexes = ['''sqk_(live|test)_[xX]+''']
+
+# --- Internal-only hostnames -------------------------------------------------
+# Catch internal/staging hosts. Public docs should only reference the public
+# *.smartlyq.com surface. Tune the allowlist if a new public host is added.
+[[rules]]
+id = "internal-host"
+description = "Possible internal/staging host or raw IP in a public file"
+regex = '''(?i)\b((staging|internal|admin|dev|db|sql|redis|mariadb)[-.][a-z0-9.-]*smartlyq\.com|(\d{1,3}\.){3}\d{1,3}:\d{2,5})\b'''
+keywords = ["staging", "internal", "admin", "mariadb"]
+
+# --- Global allowlist for obvious doc placeholders ---------------------------
+[allowlist]
+description = "Placeholders that are never real secrets"
+regexTarget = "line"
+regexes = [
+  '''(?i)YOUR_(API_KEY|TOKEN|SECRET)''',
+  '''(?i)\b(example|placeholder|changeme|redacted)\b''',
+  '''x{8,}''',
+  '''whsec_a1b2c3d4e5f6''',
+]

smartlyq-0.1.2/CONTRIBUTING.md

@@ -0,0 +1,31 @@
+# Contributing
+
+Thanks for your interest in the SmartlyQ Python SDK!
+
+## How this repo works
+
+Most of this SDK is **generated** from the [SmartlyQ OpenAPI spec](https://docs.smartlyq.com):
+
+- `smartlyq/resources.py` - emitted by `scripts/generate_client.py`. Never edit by hand.
+- `tests/test_endpoints_gen.py` - emitted by `scripts/generate_tests.py`. Never edit by hand.
+- The README's API Reference section - emitted by `scripts/generate_readme.py`.
+
+Hand-written code lives in `smartlyq/_core.py`, `smartlyq/__init__.py`, `scripts/`, and `tests/test_core.py`. Fixes to generated output belong in the generator scripts, or in the OpenAPI spec itself.
+
+```bash
+pip install httpx pytest build
+python scripts/generate_client.py && python scripts/generate_readme.py && python scripts/generate_tests.py
+python -m pytest
+```
+
+## Never commit secrets
+
+This is a **public** repository. Never commit real API keys (`sqk_live_...` / `sqk_test_...`), credentials, tokens, internal hostnames, or customer data. Use placeholders like `sqk_live_xxxxxxxxxxxx` or `YOUR_API_KEY` in examples.
+
+Enable the local pre-commit scan once per clone:
+
+```bash
+git config core.hooksPath .githooks
+```
+
+CI also runs a gitleaks scan on every push and pull request. If you believe a secret has been exposed, rotate it immediately in your Developer Dashboard.

smartlyq-0.1.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SmartlyQ
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.