pinbridge-sdk 0.1.4__tar.gz

pinbridge_sdk-0.1.4/.coveragerc

@@ -0,0 +1,14 @@
+[run]
+branch = True
+source =
+    pinbridge_sdk
+omit =
+    */__pycache__/*
+
+[report]
+show_missing = True
+skip_empty = True
+fail_under = 95
+
+[xml]
+output = coverage.xml

pinbridge_sdk-0.1.4/.github/workflows/ci.yml

@@ -0,0 +1,43 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[dev]
+          pip install build twine
+
+      - name: Lint
+        run: |
+          ruff check .
+          black --check .
+
+      - name: Test with coverage
+        run: pytest --cov=pinbridge_sdk --cov-config=.coveragerc --cov-report=xml --cov-report=term-missing
+
+      - name: Build package
+        run: python -m build
+
+      - name: Validate package metadata
+        run: twine check dist/*

pinbridge_sdk-0.1.4/.github/workflows/publish.yml

@@ -0,0 +1,89 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version to publish (e.g. 0.1.0). Must match pyproject version."
+        required: true
+        type: string
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -e .[dev]
+          pip install build twine
+
+      - name: Lint
+        run: |
+          ruff check .
+          black --check .
+
+      - name: Test with coverage
+        run: pytest --cov=pinbridge_sdk --cov-config=.coveragerc --cov-report=xml --cov-report=term-missing
+
+      - name: Build distributions
+        run: python -m build
+
+      - name: Check distributions
+        run: twine check dist/*
+
+      - name: Upload dist artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Verify version matches pyproject on tag push
+        if: startsWith(github.ref, 'refs/tags/v')
+        run: |
+          TAG_VERSION="${GITHUB_REF_NAME#v}"
+          PYPROJECT_VERSION="$(python -c "import pathlib,tomllib;print(tomllib.loads(pathlib.Path('pyproject.toml').read_text())['project']['version'])")"
+          if [ "$TAG_VERSION" != "$PYPROJECT_VERSION" ]; then
+            echo "Tag version ($TAG_VERSION) does not match pyproject version ($PYPROJECT_VERSION)."
+            exit 1
+          fi
+
+      - name: Verify manual version matches pyproject
+        if: github.event_name == 'workflow_dispatch'
+        run: |
+          INPUT_VERSION="${{ github.event.inputs.version }}"
+          PYPROJECT_VERSION="$(python -c "import pathlib,tomllib;print(tomllib.loads(pathlib.Path('pyproject.toml').read_text())['project']['version'])")"
+          if [ "$INPUT_VERSION" != "$PYPROJECT_VERSION" ]; then
+            echo "Manual version input ($INPUT_VERSION) does not match pyproject version ($PYPROJECT_VERSION)."
+            exit 1
+          fi
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    if: startsWith(github.ref, 'refs/tags/v') || github.event_name == 'workflow_dispatch'
+    permissions:
+      id-token: write
+      contents: read
+    environment:
+      name: pypi
+      url: https://pypi.org/p/pinbridge-sdk
+    steps:
+      - name: Download dist artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

pinbridge_sdk-0.1.4/.gitignore

@@ -0,0 +1,207 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

pinbridge_sdk-0.1.4/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 pinbridge
+
+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.

pinbridge_sdk-0.1.4/PKG-INFO

@@ -0,0 +1,324 @@
+Metadata-Version: 2.4
+Name: pinbridge-sdk
+Version: 0.1.4
+Summary: Official Python SDK for the PinBridge API
+Project-URL: Homepage, https://pinbridge.io
+Project-URL: Documentation, https://docs.pinbridge.io
+Project-URL: Repository, https://github.com/pinbridge/python-sdk
+Project-URL: Issues, https://github.com/pinbridge/python-sdk/issues
+Author: PinBridge
+License: MIT License
+        
+        Copyright (c) 2026 pinbridge
+        
+        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.
+License-File: LICENSE
+Keywords: api,pinbridge,pinterest,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27.0
+Requires-Dist: pydantic<3,>=2.6.0
+Provides-Extra: dev
+Requires-Dist: black<25,>=24.0.0; extra == 'dev'
+Requires-Dist: coverage[toml]<8,>=7.0.0; extra == 'dev'
+Requires-Dist: pytest-asyncio<1,>=0.23.0; extra == 'dev'
+Requires-Dist: pytest-cov<6,>=5.0.0; extra == 'dev'
+Requires-Dist: pytest<9,>=8.0.0; extra == 'dev'
+Requires-Dist: ruff<1,>=0.5.0; extra == 'dev'
+Requires-Dist: tomli<3,>=2.0.0; (python_version < '3.11') and extra == 'dev'
+Description-Content-Type: text/markdown
+
+# PinBridge Python SDK
+
+Official Python SDK for the PinBridge API.
+
+## Installation
+
+```bash
+pip install pinbridge-sdk
+```
+
+For local development from this monorepo:
+
+```bash
+pip install -e .[dev]
+```
+
+## Requirements
+
+- Python `>=3.10`
+- PinBridge API URL (default: `https://api.pinbridge.io`)
+- Authentication via API key and/or bearer token
+
+## Client Initialization
+
+```python
+from pinbridge_sdk import PinbridgeClient
+
+client = PinbridgeClient(
+    base_url="https://api.pinbridge.io",  # optional
+    api_key="pb_live_...",                # optional
+    bearer_token=None,                     # optional
+    timeout=30.0,                          # optional
+    headers={"x-request-source": "my-app"},
+)
+```
+
+Use as a context manager to close internal HTTP resources automatically:
+
+```python
+with PinbridgeClient(api_key="pb_live_...") as client:
+    print(client.system.health().status)
+```
+
+## Authentication Patterns
+
+### 1. API key auth
+
+```python
+from pinbridge_sdk import PinbridgeClient
+
+with PinbridgeClient(api_key="pb_live_...") as client:
+    keys = client.api_keys.list()
+```
+
+### 2. Login to bearer token
+
+```python
+from pinbridge_sdk import PinbridgeClient
+from pinbridge_sdk.models import LoginRequest
+
+with PinbridgeClient() as client:
+    auth = client.auth.login(LoginRequest(email="you@example.com", password="super-secret"))
+    client.set_bearer_token(auth.access_token)
+    print(client.auth.me().workspace.name)
+```
+
+### 3. Switching auth at runtime
+
+```python
+client.set_api_key("pb_live_new")
+client.set_bearer_token("new-jwt")
+client.clear_auth()  # removes both
+```
+
+## Async Client
+
+```python
+from pinbridge_sdk import AsyncPinbridgeClient
+
+async def run() -> None:
+    async with AsyncPinbridgeClient(api_key="pb_live_...") as client:
+        pricing = await client.billing.pricing()
+        print(pricing.source)
+```
+
+## Resource Guide
+
+All sync resources are available on `PinbridgeClient`; async equivalents have identical names on `AsyncPinbridgeClient`.
+
+### System (`client.system`)
+
+- `root()`
+- `health()`
+- `stripe_webhook(body, stripe_signature=...)`
+
+```python
+health = client.system.health()
+print(health.status, health.database)
+```
+
+### Auth (`client.auth`)
+
+- `register(RegisterRequest | dict)`
+- `login(LoginRequest | dict)`
+- `me()`
+- `get_profile()`
+- `update_profile(ProfileUpdateRequest | dict)`
+
+### API Keys (`client.api_keys`)
+
+- `create(APIKeyCreate | dict)`
+- `list()`
+- `update(key_id, APIKeyUpdate | dict)`
+- `revoke(key_id)`
+
+### Pinterest (`client.pinterest`)
+
+- `start_oauth()`
+- `oauth_callback(code=..., state=..., follow_redirects=False)`
+- `list_accounts()`
+- `revoke_account(account_id)`
+- `list_boards(account_id)`
+- `create_board(BoardCreateRequest | dict)`
+- `delete_board(board_id, account_id=...)`
+
+```python
+from pinbridge_sdk.models import BoardCreateRequest
+
+accounts = client.pinterest.list_accounts()
+boards = client.pinterest.list_boards(accounts[0].id)
+created = client.pinterest.create_board(
+    BoardCreateRequest(account_id=accounts[0].id, name="SDK Board")
+)
+```
+
+### Pins and Jobs (`client.pins`, `client.jobs`)
+
+- `client.pins.create(PinCreate | dict)`
+- `client.pins.get(pin_id)`
+- `client.pins.list(limit=50, offset=0)`
+- `client.pins.delete(pin_id)`
+- `client.jobs.get(job_id)`
+
+```python
+from pinbridge_sdk.models import PinCreate
+
+pin = client.pins.create(
+    PinCreate(
+        account_id="...",
+        board_id="...",
+        title="Hello",
+        description="From SDK",
+        image_url="https://example.com/image.jpg",
+        idempotency_key="my-idempotency-key",
+    )
+)
+status = client.jobs.get(pin.id)
+print(status.status)
+```
+
+### Schedules (`client.schedules`)
+
+- `create(ScheduleCreate | dict)`
+- `get(schedule_id)`
+- `list(limit=50, offset=0)`
+- `cancel(schedule_id)`
+
+### Webhooks (`client.webhooks`)
+
+- `create(WebhookCreate | dict)`
+- `list()`
+- `get(webhook_id)`
+- `update(webhook_id, WebhookUpdate | dict)`
+- `delete(webhook_id)`
+
+### Billing and Rate Meter (`client.billing`, `client.rate_meter`)
+
+- `client.billing.pricing()`
+- `client.billing.checkout(CheckoutRequest | dict)`
+- `client.billing.portal()`
+- `client.billing.status()`
+- `client.rate_meter.get(account_id)`
+
+## Typed Models
+
+All methods return typed Pydantic models from `pinbridge_sdk.models`.
+
+Use either model instances or plain dictionaries as method input.
+
+```python
+from pinbridge_sdk.models import WebhookCreate
+
+created = client.webhooks.create(
+    WebhookCreate(
+        url="https://example.com/hook",
+        secret="0123456789012345",
+        events=["pin.published", "pin.failed"],
+    )
+)
+```
+
+## Error Handling
+
+Raised exceptions:
+
+- `pinbridge_sdk.AuthenticationError`
+- `pinbridge_sdk.NotFoundError`
+- `pinbridge_sdk.ValidationError`
+- `pinbridge_sdk.RateLimitError`
+- `pinbridge_sdk.APIError`
+
+```python
+from pinbridge_sdk import APIError, PinbridgeClient
+
+try:
+    with PinbridgeClient(api_key="bad") as client:
+        client.auth.me()
+except APIError as exc:
+    print(exc.status_code, exc.message, exc.code)
+```
+
+## Extending the SDK
+
+You can register custom resources without changing core classes.
+
+```python
+from pinbridge_sdk import PinbridgeClient
+from pinbridge_sdk.resources.base import SyncAPIResource
+
+class DiagnosticsResource(SyncAPIResource):
+    def ping(self):
+        return self._request("GET", "/healthz").json()
+
+with PinbridgeClient(api_key="pb_live_...") as client:
+    client.register_resource("diagnostics", DiagnosticsResource)
+    print(client.diagnostics.ping())
+```
+
+This keeps new API groups low-risk: add models + resource class and register/bind it.
+
+## Testing, Formatting, Coverage
+
+```bash
+black .
+ruff check .
+pytest --cov=pinbridge_sdk --cov-config=.coveragerc --cov-report=term-missing --cov-report=xml
+```
+
+Coverage config file: `.coveragerc`
+
+## CI
+
+GitHub Actions CI runs on push to `main` and on pull requests.
+
+- Lint: `ruff check .` + `black --check .`
+- Test + coverage: `pytest --cov=pinbridge_sdk ...`
+- Build verification: `python -m build` + `twine check dist/*`
+
+Workflow file: `.github/workflows/ci.yml`
+
+## Publish to PyPI
+
+Release workflow file: `.github/workflows/publish.yml`
+
+Trigger options:
+
+- Push a version tag (for example: `v0.1.0`)
+- Manual `workflow_dispatch` with explicit version input
+
+Detailed release runbook: `RELEASING.md`