postmarker 1.0__tar.gz → 2.1__tar.gz

postmarker-2.1/.gitignore

@@ -0,0 +1,94 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# 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/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+.hypothesis/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Documentation build
+site/
+
+# PyBuilder
+target/
+
+# IPython Notebook
+.ipynb_checkpoints
+
+# pyenv
+.python-version
+
+# celery beat schedule file
+celerybeat-schedule
+
+# dotenv
+.env
+
+# virtualenv
+venv/
+ENV/
+
+# Spyder project settings
+.spyderproject
+
+# Rope project settings
+.ropeproject
+
+.idea/
+.vscode/
+
+.worktrees/

postmarker-2.1/PKG-INFO

@@ -0,0 +1,203 @@
+Metadata-Version: 2.5
+Name: postmarker
+Version: 2.1
+Summary: Python client library for Postmark API
+Project-URL: Documentation, https://postmarker.readthedocs.io/en/stable/
+Project-URL: Changelog, https://github.com/Stranger6667/postmarker/blob/master/CHANGELOG.md
+Project-URL: Bug Tracker, https://github.com/Stranger6667/postmarker/issues
+Project-URL: Funding, https://github.com/sponsors/Stranger6667
+Project-URL: Source Code, https://github.com/Stranger6667/postmarker
+Author-email: Dmitry Dygalo <dmitry@dygalo.dev>
+Maintainer-email: Dmitry Dygalo <dmitry@dygalo.dev>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: api,client,django,email,email backend,postmark,postmarkapp,transactional email
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Environment :: Console
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: Framework :: Django :: 6.1
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+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: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Programming Language :: Python :: Implementation :: CPython
+Classifier: Programming Language :: Python :: Implementation :: PyPy
+Classifier: Topic :: Communications :: Email
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: requests>=2.20.0
+Provides-Extra: css-inline
+Requires-Dist: css-inline>=0.24; extra == 'css-inline'
+Provides-Extra: docs
+Requires-Dist: mkdocstrings[python]; extra == 'docs'
+Requires-Dist: pymdown-extensions; extra == 'docs'
+Requires-Dist: ruff; extra == 'docs'
+Requires-Dist: zensical<0.2,>=0.1.1; extra == 'docs'
+Provides-Extra: tests
+Requires-Dist: coverage[toml]>=7.2; extra == 'tests'
+Requires-Dist: css-inline>=0.24; extra == 'tests'
+Requires-Dist: pytest-django; extra == 'tests'
+Requires-Dist: pytest-recording>=0.14; extra == 'tests'
+Requires-Dist: pytest>=8; extra == 'tests'
+Requires-Dist: tornado; extra == 'tests'
+Description-Content-Type: text/markdown
+
+# Postmarker
+
+[![Build](https://github.com/Stranger6667/postmarker/actions/workflows/build.yml/badge.svg)](https://github.com/Stranger6667/postmarker/actions/workflows/build.yml) [![Coverage](https://codecov.io/gh/Stranger6667/postmarker/branch/master/graph/badge.svg)](https://codecov.io/gh/Stranger6667/postmarker) [![Version](https://img.shields.io/pypi/v/postmarker.svg)](https://pypi.org/project/postmarker/) [![Python versions](https://img.shields.io/pypi/pyversions/postmarker.svg)](https://pypi.org/project/postmarker/) [![Docs](https://readthedocs.org/projects/postmarker/badge/?version=stable)](https://postmarker.readthedocs.io/en/stable/) [![License](https://img.shields.io/pypi/l/postmarker.svg)](https://opensource.org/licenses/MIT)
+
+Python client for the [Postmark](https://postmarkapp.com) email API.
+
+Postmarker covers Postmark's API beyond sending: templates, bounces, suppressions, message streams, stats, servers and domains.
+It also ships a Django email backend, Postmark webhook wrappers and a pytest fixture for your tests.
+
+> [!NOTE]
+> Postmarker keeps Postmark's field names: `From`, `HtmlBody`, `TemplateModel`, `MessageStream`.
+> Copy any field from the [Postmark API docs](https://postmarkapp.com/developer) and pass it as is. There are no snake_case aliases.
+
+## Installation
+
+```
+uv pip install postmarker
+```
+
+To inline `<style>` CSS into HTML emails, install the `css-inline` extra and create the client with `inline_css=True`:
+
+```
+uv pip install 'postmarker[css-inline]'
+```
+
+## Usage
+
+```python
+from postmarker.core import PostmarkClient
+
+postmark = PostmarkClient(server_token="POSTMARK_API_TEST")
+postmark.emails.send(
+    From="sender@example.com",
+    To="receiver@example.com",
+    Subject="Postmark test",
+    HtmlBody="<strong>Hello</strong> dear Postmark user.",
+)
+# {"ErrorCode": 0, "Message": "Test job accepted", "MessageID": "...", ...}
+```
+
+With the `POSTMARK_API_TEST` token, Postmark validates the request without delivering it.
+To send real emails, use the server token from your server's API Tokens tab in Postmark.
+`From` must be a confirmed sender signature or an address on a verified domain.
+
+Send with a template:
+
+```python
+postmark.emails.send_with_template(
+    TemplateAlias="welcome",
+    TemplateModel={"name": "Jane"},
+    From="sender@example.com",
+    To="receiver@example.com",
+)
+```
+
+Send a batch. Postmarker splits it into requests of 500 messages, Postmark's limit:
+
+```python
+messages = [
+    {"From": "sender@example.com", "To": to, "Subject": "Hi", "TextBody": "Hello"}
+    for to in ("first@example.com", "second@example.com")
+]
+responses = postmark.emails.send_batch(*messages)
+# Postmark accepts or rejects each message separately
+failed = [response for response in responses if response["ErrorCode"] != 0]
+```
+
+Add headers and attachments:
+
+```python
+email = postmark.emails.Email(
+    From="sender@example.com",
+    To="receiver@example.com",
+    Subject="Report",
+    TextBody="See the attached report.",
+)
+email["X-Accept-Language"] = "en-us, en"
+email.attach("/home/user/report.pdf")
+email.attach_binary(content=b"content", filename="readme.txt")
+email.send()
+```
+
+A rejected request raises `ClientError` with Postmark's [error code](https://postmarkapp.com/developer/api/overview#error-codes):
+
+```python
+from postmarker.exceptions import ClientError
+
+try:
+    postmark.emails.send(
+        From="sender@example.com",
+        To="receiver@example.com",
+        TextBody="Hello",
+    )
+except ClientError as exc:
+    print(exc.error_code)  # For example, 406 for an inactive recipient
+```
+
+## Django
+
+Django 6.1+:
+
+```python
+MAILERS = {
+    "default": {
+        "BACKEND": "postmarker.django.EmailBackend",
+        "OPTIONS": {"token": "<YOUR POSTMARK SERVER TOKEN>"},
+    },
+}
+```
+
+Django 5.2 and 6.0:
+
+```python
+EMAIL_BACKEND = "postmarker.django.EmailBackend"
+POSTMARK = {"TOKEN": "<YOUR POSTMARK SERVER TOKEN>"}
+```
+
+Django then sends `send_mail`, `EmailMessage` and emails from third-party apps through Postmark.
+The [Django guide](https://postmarker.readthedocs.io/en/stable/django/) covers tags, metadata, message streams and signals.
+
+## Testing
+
+Postmarker ships a `postmark_request` pytest fixture.
+It mocks requests to Postmark and records what your code sent, through `PostmarkClient` or the Django backend:
+
+```python
+def test_welcome_email(postmark_request):
+    send_welcome_email("jane@example.com")  # Your code that sends an email
+    assert postmark_request.call_args.kwargs["json"]["To"] == "jane@example.com"
+```
+
+## Features
+
+- Server APIs: Emails, Templates with layouts, Bounces, Messages (inbound, outbound, opens and clicks), Message Streams, Suppressions, Server, Stats and Triggers.
+- Account APIs: Domains, Sender signatures, Servers and pushing templates between servers.
+- Status and Spam check APIs.
+- Webhook wrappers: Inbound, Delivery, Open, Click, Bounce, Spam complaint and Subscription change.
+- Sending `email.message.Message` instances.
+- CSS inlining via [css-inline](https://github.com/Stranger6667/css-inline).
+- Django email backend and Tornado helper.
+- Type annotations, with a `py.typed` marker.
+
+## Documentation
+
+<https://postmarker.readthedocs.io/en/stable/>
+
+## Python support
+
+Postmarker supports CPython 3.10 to 3.15 and PyPy 3.11. The Django email backend supports Django 5.2, 6.0 and 6.1.

postmarker-2.1/README.md

@@ -0,0 +1,149 @@
+# Postmarker
+
+[![Build](https://github.com/Stranger6667/postmarker/actions/workflows/build.yml/badge.svg)](https://github.com/Stranger6667/postmarker/actions/workflows/build.yml) [![Coverage](https://codecov.io/gh/Stranger6667/postmarker/branch/master/graph/badge.svg)](https://codecov.io/gh/Stranger6667/postmarker) [![Version](https://img.shields.io/pypi/v/postmarker.svg)](https://pypi.org/project/postmarker/) [![Python versions](https://img.shields.io/pypi/pyversions/postmarker.svg)](https://pypi.org/project/postmarker/) [![Docs](https://readthedocs.org/projects/postmarker/badge/?version=stable)](https://postmarker.readthedocs.io/en/stable/) [![License](https://img.shields.io/pypi/l/postmarker.svg)](https://opensource.org/licenses/MIT)
+
+Python client for the [Postmark](https://postmarkapp.com) email API.
+
+Postmarker covers Postmark's API beyond sending: templates, bounces, suppressions, message streams, stats, servers and domains.
+It also ships a Django email backend, Postmark webhook wrappers and a pytest fixture for your tests.
+
+> [!NOTE]
+> Postmarker keeps Postmark's field names: `From`, `HtmlBody`, `TemplateModel`, `MessageStream`.
+> Copy any field from the [Postmark API docs](https://postmarkapp.com/developer) and pass it as is. There are no snake_case aliases.
+
+## Installation
+
+```
+uv pip install postmarker
+```
+
+To inline `<style>` CSS into HTML emails, install the `css-inline` extra and create the client with `inline_css=True`:
+
+```
+uv pip install 'postmarker[css-inline]'
+```
+
+## Usage
+
+```python
+from postmarker.core import PostmarkClient
+
+postmark = PostmarkClient(server_token="POSTMARK_API_TEST")
+postmark.emails.send(
+    From="sender@example.com",
+    To="receiver@example.com",
+    Subject="Postmark test",
+    HtmlBody="<strong>Hello</strong> dear Postmark user.",
+)
+# {"ErrorCode": 0, "Message": "Test job accepted", "MessageID": "...", ...}
+```
+
+With the `POSTMARK_API_TEST` token, Postmark validates the request without delivering it.
+To send real emails, use the server token from your server's API Tokens tab in Postmark.
+`From` must be a confirmed sender signature or an address on a verified domain.
+
+Send with a template:
+
+```python
+postmark.emails.send_with_template(
+    TemplateAlias="welcome",
+    TemplateModel={"name": "Jane"},
+    From="sender@example.com",
+    To="receiver@example.com",
+)
+```
+
+Send a batch. Postmarker splits it into requests of 500 messages, Postmark's limit:
+
+```python
+messages = [
+    {"From": "sender@example.com", "To": to, "Subject": "Hi", "TextBody": "Hello"}
+    for to in ("first@example.com", "second@example.com")
+]
+responses = postmark.emails.send_batch(*messages)
+# Postmark accepts or rejects each message separately
+failed = [response for response in responses if response["ErrorCode"] != 0]
+```
+
+Add headers and attachments:
+
+```python
+email = postmark.emails.Email(
+    From="sender@example.com",
+    To="receiver@example.com",
+    Subject="Report",
+    TextBody="See the attached report.",
+)
+email["X-Accept-Language"] = "en-us, en"
+email.attach("/home/user/report.pdf")
+email.attach_binary(content=b"content", filename="readme.txt")
+email.send()
+```
+
+A rejected request raises `ClientError` with Postmark's [error code](https://postmarkapp.com/developer/api/overview#error-codes):
+
+```python
+from postmarker.exceptions import ClientError
+
+try:
+    postmark.emails.send(
+        From="sender@example.com",
+        To="receiver@example.com",
+        TextBody="Hello",
+    )
+except ClientError as exc:
+    print(exc.error_code)  # For example, 406 for an inactive recipient
+```
+
+## Django
+
+Django 6.1+:
+
+```python
+MAILERS = {
+    "default": {
+        "BACKEND": "postmarker.django.EmailBackend",
+        "OPTIONS": {"token": "<YOUR POSTMARK SERVER TOKEN>"},
+    },
+}
+```
+
+Django 5.2 and 6.0:
+
+```python
+EMAIL_BACKEND = "postmarker.django.EmailBackend"
+POSTMARK = {"TOKEN": "<YOUR POSTMARK SERVER TOKEN>"}
+```
+
+Django then sends `send_mail`, `EmailMessage` and emails from third-party apps through Postmark.
+The [Django guide](https://postmarker.readthedocs.io/en/stable/django/) covers tags, metadata, message streams and signals.
+
+## Testing
+
+Postmarker ships a `postmark_request` pytest fixture.
+It mocks requests to Postmark and records what your code sent, through `PostmarkClient` or the Django backend:
+
+```python
+def test_welcome_email(postmark_request):
+    send_welcome_email("jane@example.com")  # Your code that sends an email
+    assert postmark_request.call_args.kwargs["json"]["To"] == "jane@example.com"
+```
+
+## Features
+
+- Server APIs: Emails, Templates with layouts, Bounces, Messages (inbound, outbound, opens and clicks), Message Streams, Suppressions, Server, Stats and Triggers.
+- Account APIs: Domains, Sender signatures, Servers and pushing templates between servers.
+- Status and Spam check APIs.
+- Webhook wrappers: Inbound, Delivery, Open, Click, Bounce, Spam complaint and Subscription change.
+- Sending `email.message.Message` instances.
+- CSS inlining via [css-inline](https://github.com/Stranger6667/css-inline).
+- Django email backend and Tornado helper.
+- Type annotations, with a `py.typed` marker.
+
+## Documentation
+
+<https://postmarker.readthedocs.io/en/stable/>
+
+## Python support
+
+Postmarker supports CPython 3.10 to 3.15 and PyPy 3.11. The Django email backend supports Django 5.2, 6.0 and 6.1.

postmarker-2.1/pyproject.toml

@@ -0,0 +1,129 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "postmarker"
+dynamic = ["version"]
+description = "Python client library for Postmark API"
+keywords = ["postmark", "postmarkapp", "api", "client", "email", "transactional email", "django", "email backend"]
+authors = [{ name = "Dmitry Dygalo", email = "dmitry@dygalo.dev" }]
+maintainers = [{ name = "Dmitry Dygalo", email = "dmitry@dygalo.dev" }]
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.10"
+classifiers = [
+  "Development Status :: 5 - Production/Stable",
+  "Environment :: Console",
+  "Environment :: Web Environment",
+  "Framework :: Django",
+  "Framework :: Django :: 5.2",
+  "Framework :: Django :: 6.0",
+  "Framework :: Django :: 6.1",
+  "Framework :: Pytest",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Programming Language :: Python :: 3.15",
+  "Programming Language :: Python :: Implementation :: CPython",
+  "Programming Language :: Python :: Implementation :: PyPy",
+  "Topic :: Communications :: Email",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+  "Typing :: Typed",
+]
+dependencies = ["requests>=2.20.0"]
+
+[project.optional-dependencies]
+css-inline = ["css-inline>=0.24"]
+tests = ["postmarker[css-inline]", "coverage[toml]>=7.2", "pytest>=8", "pytest-django", "pytest-recording>=0.14", "tornado"]
+docs = ["mkdocstrings[python]", "pymdown-extensions", "ruff", "zensical>=0.1.1,<0.2"]
+
+[project.entry-points.pytest11]
+postmark = "postmarker.pytest"
+
+[project.urls]
+Documentation = "https://postmarker.readthedocs.io/en/stable/"
+Changelog = "https://github.com/Stranger6667/postmarker/blob/master/CHANGELOG.md"
+"Bug Tracker" = "https://github.com/Stranger6667/postmarker/issues"
+Funding = "https://github.com/sponsors/Stranger6667"
+"Source Code" = "https://github.com/Stranger6667/postmarker"
+
+[tool.hatch.version]
+path = "src/postmarker/__init__.py"
+
+[tool.hatch.build.targets.sdist]
+include = ["/src", "/test"]
+
+[tool.pytest.ini_options]
+addopts = ["-ra", "--strict-markers", "--strict-config", "--block-network", "--allowed-hosts=127.0.0.1,localhost"]
+xfail_strict = true
+testpaths = ["test"]
+pythonpath = ["."]
+DJANGO_SETTINGS_MODULE = "test.django.settings"
+
+[tool.coverage.run]
+parallel = true
+branch = true
+source_pkgs = ["postmarker"]
+
+[tool.coverage.paths]
+source = ["src", ".tox/*/site-packages", ".tox/*/lib/*/site-packages", ".tox/*/Lib/site-packages"]
+
+[tool.coverage.report]
+show_missing = true
+precision = 2
+exclude_also = ["if TYPE_CHECKING:"]
+fail_under = 100
+
+[tool.ruff]
+line-length = 120
+target-version = "py310"
+
+[tool.ruff.lint]
+select = [
+  "E",      # pycodestyle errors
+  "W",      # pycodestyle warnings
+  "F",      # pyflakes
+  "C",      # flake8-comprehensions
+  "B",      # flake8-bugbear
+  "D",      # pydocstyle
+  "T201",   # flake8-print
+  "I",      # isort
+  "FURB",   # refurb
+  "PGH003", # blanket-type-ignore
+  "UP",     # pyupgrade
+  "SIM",    # flake8-simplify
+]
+ignore = [
+  "E501",   # Line too long
+  "B008",   # Do not perform function calls in argument defaults
+  "C901",   # Too complex
+  "D100",   # Missing docstring in public module
+  "D101",   # Missing docstring in public class
+  "D102",   # Missing docstring in public method
+  "D103",   # Missing docstring in public function
+  "D104",   # Missing docstring in public package
+  "D105",   # Missing docstring in magic method
+  "D106",   # Missing docstring in public nested class
+  "D107",   # Missing docstring in `__init__`
+  "D202",   # No blank lines allowed after function docstring
+  "D203",   # One blank line before class
+  "D213",   # Multiline summary second line
+  "D401",   # Imperative mood
+  "D407",   # Missing dashed underline after section
+  "SIM105", # contextlib.suppress is less performant in many cases
+  "SIM108", # ternary expressions are not always readable
+  "SIM910", # delete default arguments in .get() in some cases
+]
+
+[tool.ruff.lint.isort]
+known-first-party = ["postmarker"]
+
+[tool.typos.default]
+# Verbatim Postmark spam check API message
+extend-ignore-re = ["SpamAssassin error occured"]

postmarker-2.1/src/postmarker/__init__.py

@@ -0,0 +1 @@
+__version__ = "2.1"