pgns 0.1.4__tar.gz

pgns-0.1.4/.gitignore

@@ -0,0 +1,450 @@
+# File created using '.gitignore Generator' for Visual Studio Code: https://bit.ly/vscode-gig
+# Created by https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,dotenv,go,node,python,rust
+# Edit at https://www.toptal.com/developers/gitignore?templates=visualstudiocode,macos,dotenv,go,node,python,rust
+
+### dotenv ###
+.env
+.env.local
+
+### Go ###
+# If you prefer the allow list template instead of the deny list, see community template:
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Binaries for programs and plugins
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+
+# Test binary, built with `go test -c`
+*.test
+
+# Output of the go coverage tool, specifically when used with LiteIDE
+*.out
+
+# Dependency directories (remove the comment below to include it)
+# vendor/
+
+# Go workspace file
+go.work
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Node ###
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional stylelint cache
+.stylelintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+dist
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# vuepress v2.x temp and cache directory
+.temp
+
+# Docusaurus cache and generated files
+.docusaurus
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*
+
+### Node Patch ###
+# Serverless Webpack directories
+.webpack/
+
+# Optional stylelint cache
+
+# SvelteKit build / generate output
+.svelte-kit
+
+### Python ###
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+
+# Distribution / packaging
+.Python
+# Note: build/ is NOT ignored - it contains Bazel macros (build/*.bzl)
+# Python build artifacts go in dist/ instead
+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.*
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+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
+
+# 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
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# 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
+.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/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+### Rust ###
+# Generated by Cargo
+# will have compiled files and executables
+debug/
+
+# Cargo.lock is committed because this workspace contains binaries (server, cli)
+# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
+# Cargo.lock
+
+# These are backup files generated by rustfmt
+**/*.rs.bk
+
+# MSVC Windows builds of rustc generate these, which store debugging information
+*.pdb
+
+### VisualStudioCode ###
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+!.vscode/*.code-snippets
+
+# Local History for Visual Studio Code
+.history/
+
+# Built Visual Studio Code Extensions
+*.vsix
+
+### VisualStudioCode Patch ###
+# Ignore all local history of files
+.history
+.ionide
+
+# End of https://www.toptal.com/developers/gitignore/api/visualstudiocode,macos,dotenv,go,node,python,rust
+
+# Custom rules (everything added below won't be overriden by 'Generate .gitignore File' if you use 'Update' option)
+
+# Bazel
+/bazel-*
+/.ijwb/
+/.aswb/
+/.clwb/
+.bazelrc.user
+
+!/build/
+!/**/lib/
+
+# Project-local binaries (sqlx-cli, etc.)
+.local/
+
+# Pulumi
+.pulumi/
+
+# env
+.env.*
+!.env.*.example
+!.env.development
+
+# Beads
+.beads/dolt/
+.beads/.jsonl.lock
+.beads/dolt-access.lock
+
+# Legal
+docs/corp/
+
+# Playwright
+.playwright-cli/*.yml
+.playwright-cli/*.png
+
+# Lefthook
+lefthook-local.yml
+
+# MaxMind GeoIP databases (licensed, not committed)
+data/*.mmdb
+data/*.csv
+data/GeoLite2-*

pgns-0.1.4/LICENSE

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

pgns-0.1.4/PKG-INFO

@@ -0,0 +1,68 @@
+Metadata-Version: 2.4
+Name: pgns
+Version: 0.1.4
+Summary: Python SDK for the pgns webhook relay API
+Project-URL: Homepage, https://pgns.io
+Project-URL: Documentation, https://docs.pgns.io/sdks/python
+Project-URL: Repository, https://github.com/pgns-io/sdk-python
+Author: pgns
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api-client,pgns,sdk,webhooks
+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.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# pgns Python SDK
+
+Python client library for the [pgns](https://pgns.io) webhook relay API.
+
+## Installation
+
+```bash
+pip install pgns
+```
+
+## Quick Start
+
+```python
+from pgns import PgnsClient
+
+client = PgnsClient(api_key="your-api-key")
+
+# List roosts
+roosts = client.roosts.list()
+
+# Send a pigeon
+client.pigeons.send("rst_abc123", payload={"event": "user.created", "data": {"id": 1}})
+```
+
+## Async Usage
+
+```python
+from pgns import AsyncPgnsClient
+
+async with AsyncPgnsClient(api_key="your-api-key") as client:
+    roosts = await client.roosts.list()
+```
+
+## Documentation
+
+Full documentation is available at [docs.pgns.io/sdks/python](https://docs.pgns.io/sdks/python).
+
+## License
+
+MIT

pgns-0.1.4/README.md

@@ -0,0 +1,40 @@
+# pgns Python SDK
+
+Python client library for the [pgns](https://pgns.io) webhook relay API.
+
+## Installation
+
+```bash
+pip install pgns
+```
+
+## Quick Start
+
+```python
+from pgns import PgnsClient
+
+client = PgnsClient(api_key="your-api-key")
+
+# List roosts
+roosts = client.roosts.list()
+
+# Send a pigeon
+client.pigeons.send("rst_abc123", payload={"event": "user.created", "data": {"id": 1}})
+```
+
+## Async Usage
+
+```python
+from pgns import AsyncPgnsClient
+
+async with AsyncPgnsClient(api_key="your-api-key") as client:
+    roosts = await client.roosts.list()
+```
+
+## Documentation
+
+Full documentation is available at [docs.pgns.io/sdks/python](https://docs.pgns.io/sdks/python).
+
+## License
+
+MIT

pgns-0.1.4/pgns/__init__.py

@@ -0,0 +1,105 @@
+"""pgns SDK — Python client for the pgns webhook relay API."""
+
+from pgns.sdk._version import __version__
+from pgns.sdk.async_client import AsyncPigeonsClient
+from pgns.sdk.client import PigeonsClient
+from pgns.sdk.errors import PigeonsAuthError, PigeonsError
+from pgns.sdk.events import async_event_stream, event_stream
+from pgns.sdk.models import (
+    ApiKeyCreatedResponse,
+    ApiKeyResponse,
+    AuthTokens,
+    BillingLimits,
+    BillingStatus,
+    CheckoutRequest,
+    CheckoutResponse,
+    CreateApiKeyRequest,
+    CreateDestination,
+    CreateRoost,
+    CreateTemplate,
+    DashboardStats,
+    DeliveryAttempt,
+    DeliveryStatus,
+    Destination,
+    DestinationType,
+    LoginRequest,
+    MagicLinkRequest,
+    MagicLinkResponse,
+    MagicLinkVerifyRequest,
+    PaginatedDeliveryAttempts,
+    PaginatedPigeons,
+    PauseResponse,
+    Pigeon,
+    PortalRequest,
+    PortalResponse,
+    PreviewTemplateRequest,
+    PreviewTemplateResponse,
+    ReplayResponse,
+    Roost,
+    SignupRequest,
+    Template,
+    UpdateApiKeyRequest,
+    UpdateProfileRequest,
+    UpdateRoost,
+    UpdateTemplate,
+    User,
+)
+
+__all__ = [
+    "__version__",
+    # Clients
+    "PigeonsClient",
+    "AsyncPigeonsClient",
+    # Errors
+    "PigeonsError",
+    "PigeonsAuthError",
+    # Events
+    "event_stream",
+    "async_event_stream",
+    # Enums
+    "DestinationType",
+    "DeliveryStatus",
+    # Auth
+    "AuthTokens",
+    "SignupRequest",
+    "LoginRequest",
+    "MagicLinkRequest",
+    "MagicLinkVerifyRequest",
+    "MagicLinkResponse",
+    # Domain models
+    "User",
+    "Roost",
+    "Pigeon",
+    "Destination",
+    "DeliveryAttempt",
+    # API Keys
+    "ApiKeyResponse",
+    "ApiKeyCreatedResponse",
+    # Mutations
+    "CreateRoost",
+    "UpdateRoost",
+    "CreateDestination",
+    "UpdateProfileRequest",
+    "CreateApiKeyRequest",
+    "UpdateApiKeyRequest",
+    # Responses
+    "ReplayResponse",
+    "DashboardStats",
+    "PauseResponse",
+    # Pagination
+    "PaginatedPigeons",
+    "PaginatedDeliveryAttempts",
+    # Templates
+    "Template",
+    "CreateTemplate",
+    "UpdateTemplate",
+    "PreviewTemplateRequest",
+    "PreviewTemplateResponse",
+    # Billing
+    "BillingLimits",
+    "BillingStatus",
+    "CheckoutRequest",
+    "CheckoutResponse",
+    "PortalRequest",
+    "PortalResponse",
+]

pgns-0.1.4/pgns/_client.py

@@ -0,0 +1,32 @@
+"""Shared helpers for sync and async clients."""
+
+from __future__ import annotations
+
+from typing import Any
+
+import httpx
+
+from pgns.sdk.errors import PigeonsError
+
+
+def _auth_headers(api_key: str | None, access_token: str | None) -> dict[str, str]:
+    """Build the Authorization header dict."""
+    if api_key:
+        return {"Authorization": f"Bearer {api_key}"}
+    if access_token:
+        return {"Authorization": f"Bearer {access_token}"}
+    return {}
+
+
+def _handle_response(response: httpx.Response) -> Any:
+    """Parse an httpx response, raising PigeonsError on non-2xx."""
+    if response.status_code == 204:
+        return None
+    if not response.is_success:
+        try:
+            body = response.json()
+            message = body.get("error", response.reason_phrase or "Unknown error")
+        except Exception:
+            message = response.reason_phrase or "Unknown error"
+        raise PigeonsError(message, response.status_code)
+    return response.json()

pgns-0.1.4/pgns/_version.py

@@ -0,0 +1,3 @@
+"""Version of the pgns SDK."""
+
+__version__ = "0.1.4"