postmarker 1.0__tar.gz → 2.0__tar.gz

postmarker-2.0/.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.0/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.5
+Name: postmarker
+Version: 2.0
+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: 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; 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 library for [Postmark API](https://postmarkapp.com/developer).
+
+## Installation
+
+Postmarker can be obtained with `pip`:
+
+```
+pip install postmarker
+```
+
+## Usage example
+
+**NOTE**:
+
+The attributes of all classes are provided **as is**, without transformation to snake case. We don't want to introduce new names for existing entities.
+
+Send single email:
+
+```python
+>>> from postmarker.core import PostmarkClient
+>>> postmark = PostmarkClient(server_token='API_TOKEN')
+>>> postmark.emails.send(
+    From='sender@example.com',
+    To='receiver@example.com',
+    Subject='Postmark test',
+    HtmlBody='<strong>Hello</strong> dear Postmark user.'
+)
+```
+
+Send batch:
+
+```python
+>>> postmark.emails.send_batch(
+    {
+        'From': 'sender@example.com',
+        'To': 'receiver@example.com',
+        'Subject': 'Postmark test',
+        'HtmlBody': '<strong>Hello</strong> dear Postmark user.',
+    },
+    {
+        'From': 'sender2@example.com',
+        'To': 'receiver2@example.com',
+        'Subject': 'Postmark test 2',
+        'HtmlBody': '<strong>Hello</strong> dear Postmark user.',
+    }
+)
+```
+
+Setup an email:
+
+```python
+>>> email = postmark.emails.Email(
+    From='sender@example.com',
+    To='receiver@example.com',
+    Subject='Postmark test',
+    HtmlBody='<strong>Hello</strong> dear Postmark user.'
+)
+>>> email['X-Accept-Language'] = 'en-us, en'
+>>> email.attach('/home/user/readme.txt')
+>>> email.attach_binary(content=b'content', filename='readme.txt')
+>>> email.send()
+```
+
+There are a lot of features available. Check it out in our documentation! Here's just a few of them:
+
+- Support for sending Python email instances.
+- Server APIs: Bounces, Messages, Message Streams, Suppressions, Templates with layouts, Server, Stats and Triggers.
+- Account APIs: Domains, Sender signatures, Servers and pushing templates between servers.
+- Status API.
+- Django email backend.
+- Tornado helper.
+- Spam check API.
+- Wrappers for Bounce, Inbound, Open and Delivery webhooks.
+- `pytest` fixtures to mock Postmark API in tests.
+- Type annotations, with a `py.typed` marker.
+
+## Documentation
+
+You can view the documentation online at:
+
+- <https://postmarker.readthedocs.io/en/stable/>
+
+Or you can look at the `docs/` directory in the repository.
+
+## Python support
+
+Postmarker supports CPython 3.10 - 3.15 and PyPy 3.11. The Django email backend supports Django 5.2, 6.0 and 6.1.
+
+## Thanks
+
+Many thanks to [Shmele](https://github.com/butorov) and [lobziik](https://github.com/lobziik) for their reviews and advice :)

postmarker-2.0/README.md

@@ -0,0 +1,95 @@
+# 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 library for [Postmark API](https://postmarkapp.com/developer).
+
+## Installation
+
+Postmarker can be obtained with `pip`:
+
+```
+pip install postmarker
+```
+
+## Usage example
+
+**NOTE**:
+
+The attributes of all classes are provided **as is**, without transformation to snake case. We don't want to introduce new names for existing entities.
+
+Send single email:
+
+```python
+>>> from postmarker.core import PostmarkClient
+>>> postmark = PostmarkClient(server_token='API_TOKEN')
+>>> postmark.emails.send(
+    From='sender@example.com',
+    To='receiver@example.com',
+    Subject='Postmark test',
+    HtmlBody='<strong>Hello</strong> dear Postmark user.'
+)
+```
+
+Send batch:
+
+```python
+>>> postmark.emails.send_batch(
+    {
+        'From': 'sender@example.com',
+        'To': 'receiver@example.com',
+        'Subject': 'Postmark test',
+        'HtmlBody': '<strong>Hello</strong> dear Postmark user.',
+    },
+    {
+        'From': 'sender2@example.com',
+        'To': 'receiver2@example.com',
+        'Subject': 'Postmark test 2',
+        'HtmlBody': '<strong>Hello</strong> dear Postmark user.',
+    }
+)
+```
+
+Setup an email:
+
+```python
+>>> email = postmark.emails.Email(
+    From='sender@example.com',
+    To='receiver@example.com',
+    Subject='Postmark test',
+    HtmlBody='<strong>Hello</strong> dear Postmark user.'
+)
+>>> email['X-Accept-Language'] = 'en-us, en'
+>>> email.attach('/home/user/readme.txt')
+>>> email.attach_binary(content=b'content', filename='readme.txt')
+>>> email.send()
+```
+
+There are a lot of features available. Check it out in our documentation! Here's just a few of them:
+
+- Support for sending Python email instances.
+- Server APIs: Bounces, Messages, Message Streams, Suppressions, Templates with layouts, Server, Stats and Triggers.
+- Account APIs: Domains, Sender signatures, Servers and pushing templates between servers.
+- Status API.
+- Django email backend.
+- Tornado helper.
+- Spam check API.
+- Wrappers for Bounce, Inbound, Open and Delivery webhooks.
+- `pytest` fixtures to mock Postmark API in tests.
+- Type annotations, with a `py.typed` marker.
+
+## Documentation
+
+You can view the documentation online at:
+
+- <https://postmarker.readthedocs.io/en/stable/>
+
+Or you can look at the `docs/` directory in the repository.
+
+## Python support
+
+Postmarker supports CPython 3.10 - 3.15 and PyPy 3.11. The Django email backend supports Django 5.2, 6.0 and 6.1.
+
+## Thanks
+
+Many thanks to [Shmele](https://github.com/butorov) and [lobziik](https://github.com/lobziik) for their reviews and advice :)

postmarker-2.0/pyproject.toml

@@ -0,0 +1,127 @@
+[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]
+tests = ["coverage[toml]>=7", "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_lines = ["raise NotImplementedError"]
+
+[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.0/src/postmarker/__init__.py

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

{postmarker-1.0 → postmarker-2.0}/src/postmarker/core.py

@@ -1,4 +1,8 @@
+from __future__ import annotations
+
 import sys
+from collections.abc import Mapping
+from typing import Any, TextIO
 from urllib.parse import urljoin
 
 import requests
@@ -6,52 +10,74 @@ import requests
 from . import __version__
 from .exceptions import ClientError, SpamAssassinError
 from .logging import get_logger
+from .models.base import ModelManager
 from .models.bounces import BounceManager
 from .models.domains import DomainsManager
 from .models.emails import EmailManager
+from .models.message_streams import MessageStreamsManager
 from .models.messages import MessageManager
 from .models.senders import SenderSignaturesManager
 from .models.server import ServerManager
+from .models.servers import ServersManager
 from .models.stats import StatsManager
 from .models.status import StatusManager
+from .models.suppressions import SuppressionsManager
 from .models.templates import TemplateManager
 from .models.triggers import TriggersManager
 from .utils import get_args
 
 DEFAULT_API = "https://api.postmarkapp.com/"
 STATUS_API = "https://status.postmarkapp.com/api/1.0/"
-SPAMCHECK_API = "http://spamcheck.postmarkapp.com/filter/"
-USER_AGENT = "Postmarker/%s" % __version__
+SPAMCHECK_API = "https://spamcheck.postmarkapp.com/filter/"
+USER_AGENT = f"Postmarker/{__version__}"
 TEST_TOKEN = "POSTMARK_API_TEST"
 
 
 class PostmarkClient:
     """Basic class for API clients. Provides basic functionality to make requests."""
 
-    _managers = (
+    bounces: BounceManager
+    domains: DomainsManager
+    emails: EmailManager
+    messages: MessageManager
+    message_streams: MessageStreamsManager
+    senders: SenderSignaturesManager
+    server: ServerManager
+    servers: ServersManager
+    stats: StatsManager
+    status: StatusManager
+    suppressions: SuppressionsManager
+    templates: TemplateManager
+    triggers: TriggersManager
+    _session: requests.Session
+
+    _managers: tuple[type[ModelManager[Any]], ...] = (
         BounceManager,
         DomainsManager,
         EmailManager,
         MessageManager,
+        MessageStreamsManager,
         SenderSignaturesManager,
         ServerManager,
+        ServersManager,
         StatsManager,
         StatusManager,
+        SuppressionsManager,
         TemplateManager,
         TriggersManager,
     )
 
     def __init__(
         self,
-        server_token=None,
-        account_token=None,
-        verbosity=0,
-        max_retries=0,
-        timeout=None,
-        logs_stream=sys.stdout,
-        root_api_url=DEFAULT_API,
-    ):
-        assert server_token, "You have to provide token to use Postmark API"
+        server_token: str | None = None,
+        account_token: str | None = None,
+        verbosity: int = 0,
+        max_retries: int = 0,
+        timeout: float | tuple[float, float] | None = None,
+        logs_stream: TextIO = sys.stdout,
+        root_api_url: str = DEFAULT_API,
+    ) -> None:
+        assert server_token or account_token, "You have to provide server_token or account_token to use Postmark API"
         self.server_token = server_token
         self.account_token = account_token
         self.max_retries = max_retries
@@ -61,7 +87,9 @@ class PostmarkClient:
         self._setup_managers()
 
     @classmethod
-    def from_config(cls, config, prefix="postmark_", is_uppercase=False):
+    def from_config(
+        cls, config: Mapping[str, Any], prefix: str = "postmark_", is_uppercase: bool = False
+    ) -> PostmarkClient:
         """Helper method for instantiating PostmarkClient from dict-like objects."""
         kwargs = {}
         for arg in get_args(cls):
@@ -74,10 +102,10 @@ class PostmarkClient:
                 kwargs[arg] = config[key]
         return cls(**kwargs)
 
-    def __repr__(self):
+    def __repr__(self) -> str:
         return f"<{self.__class__.__name__}: {self.server_token}>"
 
-    def _setup_managers(self):
+    def _setup_managers(self) -> None:
         """Allows to access manager by model name.
 
         >>> postmark = PostmarkClient(server_token='TEST')
@@ -89,15 +117,15 @@ class PostmarkClient:
             setattr(self, instance.name, instance)
 
     @property
-    def session(self):
+    def session(self) -> requests.Session:
         if not hasattr(self, "_session"):
-            self._session = requests.Session()  # pylint: disable=attribute-defined-outside-init
+            self._session = requests.Session()
             adapter = requests.adapters.HTTPAdapter(max_retries=self.max_retries)
             self._session.mount("http://", adapter)
             self._session.mount("https://", adapter)
         return self._session
 
-    def call(self, method, endpoint, token_type="server", data=None, **kwargs):
+    def call(self, method: str, endpoint: str, token_type: str = "server", data: Any = None, **kwargs: Any) -> Any:
         if token_type == "account":
             header = "X-Postmark-Account-Token"
             token = self.account_token
@@ -106,18 +134,26 @@ class PostmarkClient:
             token = self.server_token
         return self._call(method, self.root_api_url, endpoint, data, {header: token}, **kwargs)
 
-    def call_status(self, endpoint):
+    def call_status(self, endpoint: str) -> Any:
         return self._call("GET", STATUS_API, endpoint)
 
-    def spamcheck(self, dump, options="long"):
+    def spamcheck(self, dump: str, options: str = "long") -> Any:
         data = {"email": dump, "options": options}
         response = self._call("POST", SPAMCHECK_API, "", data)
         if not response["success"]:
             raise SpamAssassinError(response["message"])
         return response
 
-    def _call(self, method, root, endpoint, data=None, headers=None, **kwargs):
-        default_headers = {"Accept": "application/json", "User-Agent": USER_AGENT}
+    def _call(
+        self,
+        method: str,
+        root: str,
+        endpoint: str,
+        data: Any = None,
+        headers: dict[str, str | None] | None = None,
+        **kwargs: Any,
+    ) -> Any:
+        default_headers: dict[str, str | None] = {"Accept": "application/json", "User-Agent": USER_AGENT}
         if headers:
             default_headers.update(headers)
         url = urljoin(root, endpoint)
@@ -134,7 +170,7 @@ class PostmarkClient:
         self.check_response(response)
         return response.json()
 
-    def check_response(self, response):
+    def check_response(self, response: requests.Response) -> None:
         try:
             response.raise_for_status()
         except requests.HTTPError as http_error:
@@ -145,5 +181,5 @@ class PostmarkClient:
             message = self.format_exception_message(data)
             raise ClientError(message, error_code=data["ErrorCode"]) from http_error
 
-    def format_exception_message(self, data):
+    def format_exception_message(self, data: dict[str, Any]) -> str:
         return "[{}] {}".format(data["ErrorCode"], data["Message"])

postmarker-2.0/src/postmarker/django/__init__.py

@@ -0,0 +1,12 @@
+from .backend import EmailBackend, PostmarkEmailMessage, PostmarkEmailMixin, PostmarkEmailMultiAlternatives
+from .signals import on_exception, post_send, pre_send
+
+__all__ = [
+    "EmailBackend",
+    "PostmarkEmailMessage",
+    "PostmarkEmailMixin",
+    "PostmarkEmailMultiAlternatives",
+    "on_exception",
+    "post_send",
+    "pre_send",
+]