Skip to main content

Python SDK for the Nudgey API

Project description

Nudgey

Python SDK for the Nudgey API.

Install

pip install nudgey

Quickstart

import os

from nudgey import NudgeyAPIError, NudgeyClient

client = NudgeyClient(api_key=os.environ["NUDGEY_API_KEY"])

try:
    result = client.track(
        "partner_smoke_test_user",
        "sdk_installed",
        {"source": "python-sdk"},
    )
    print(result)
except NudgeyAPIError as exc:
    print(f"Nudgey request failed: {exc}")

What To Expect

The SDK uses the X-Nudgey-Key header for authentication and talks to https://api.nudgey.ai by default.

If you want to target a different environment, pass base_url when constructing the client.

Next Steps

  1. Create your API key in the Nudgey dashboard.
  2. Send your first production event.
  3. Add webhook handling if your integration consumes nudge delivery events.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

nudgey-0.1.0.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nudgey-0.1.0-py3-none-any.whl (5.0 kB view details)

Uploaded Python 3

File details

Details for the file nudgey-0.1.0.tar.gz.

File metadata

  • Download URL: nudgey-0.1.0.tar.gz
  • Upload date:
  • Size: 5.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for nudgey-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9f4a26c36fa8425d00a27ef5cb9a9be72fc952dced042925d2d4be00312e149c
MD5 396fe68070bfe28ea24feeb7bc4147a8
BLAKE2b-256 31616b7b5e57f79b3d5ffb6d06bd2fd0999d8e96b3bc933d00dec40804b37d5a

See more details on using hashes here.

File details

Details for the file nudgey-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: nudgey-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for nudgey-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f66e3d1cc18a5db1d7e03f45c90cba197ae357eb2e5caab6d1abb3fc0496a6cb
MD5 4d33996201dc11b68499cdbed14d33e5
BLAKE2b-256 fa43f0f410996086f31cc8cf343441582d7b04f93e1d4dd3ea13eddad79f392d

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page