Skip to main content

shopbird

The official Python client for the Shopbird API. It covers locks, audiences, codes, drops, sync and webhook signatures.

No dependencies. It needs Python 3.9 or later.

pip install shopbird

Use it

Create a token in Shopbird under Settings > API access and put it in SHOPBIRD_TOKEN.

from shopbird import Shopbird

shopbird = Shopbird()

for lock in shopbird.locks.list():
    print(lock["name"])

lock = shopbird.locks.create(
    {"name": "VIP", "targets": [{"type": "product", "resource_id": "gid://shopify/Product/123"}], "audience_ids": ["<audience id>"]},
    wait=True,
)
shopbird.locks.update(lock["id"], {"name": "VIP only"}, version=lock["version"])

Verify webhooks

from shopbird import verify_webhook

delivery = verify_webhook(raw_body, headers, os.environ["SHOPBIRD_WEBHOOK_SECRET"])
if delivery.event["type"] == "drop.stage_changed":
    print(delivery.event["data"]["to"])

Full guide: https://shopbird.app/docs/sdk-python. API reference: https://shopbird.app/docs.

Develop

This package lives in sdk-python/ of the Shopbird repository. Run the tests with PYTHONPATH=src python -m unittest discover -s tests. tests/test_contract.py fails when an API route has no SDK method. Releases: docs/operations/sdk-release.md.

Metadata

Release files for shopbird 0.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shopbird 0.1.0
File Size Uploaded Provenance Actions
shopbird-0.1.0.tar.gz 11.6 kB With provenance Details for shopbird-0.1.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for shopbird 0.1.0
File Interpreter ABI Platform Actions
shopbird-0.1.0-py3-none-any.whl Python 3 none any Details for shopbird-0.1.0-py3-none-any.whl

Total release size: 23.3 kB

Release files / shopbird-0.1.0.tar.gz

Download URL shopbird-0.1.0.tar.gz
Size 11.6 kB
Tags Source
SHA-256 checksum
How to use checksums
807750961f2cdda8425fb56b9fae7dfb5e4fb6152c9738a209f0fd679e7e521f
BLAKE2b-256 checksum
How to use checksums
85379c9f4f574cc42b1496ba2e9db7fc1b06f1fbe36f8203968b99a17748bc05
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Release files / shopbird-0.1.0-py3-none-any.whl

Download URL shopbird-0.1.0-py3-none-any.whl
Size 11.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
991a904d9e85768020ca550c3de8802ccd9282ed18715b0795c80b4a4f465754
BLAKE2b-256 checksum
How to use checksums
69a745493600c73436697c0adc0b92121d0c10d50100a1ccc82a5377269f9222
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

Security for shopbird 0.1.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for shopbird-0.1.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Nov 9, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.1.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page