altissimo-customerio 0.4.0__tar.gz

altissimo_customerio-0.4.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

altissimo_customerio-0.4.0/PKG-INFO

@@ -0,0 +1,290 @@
+Metadata-Version: 2.4
+Name: altissimo-customerio
+Version: 0.4.0
+Summary: Customer.io transactional email and messaging client for Altissimo projects
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: customerio,email,altissimo,transactional
+Author: Altissimo HQ
+Requires-Python: >=3.11
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Provides-Extra: customerio
+Requires-Dist: customerio (>=2.0,<3.0) ; extra == "customerio"
+Project-URL: Changelog, https://github.com/altissimo-hq/customerio-python/blob/main/CHANGELOG.md
+Project-URL: Homepage, https://github.com/altissimo-hq/customerio-python
+Project-URL: Issues, https://github.com/altissimo-hq/customerio-python/issues
+Project-URL: Repository, https://github.com/altissimo-hq/customerio-python
+Description-Content-Type: text/markdown
+
+# altissimo-customerio
+
+[![CI](https://github.com/altissimo-hq/customerio-python/actions/workflows/ci.yml/badge.svg)](https://github.com/altissimo-hq/customerio-python/actions/workflows/ci.yml)
+[![Python](https://img.shields.io/badge/python-3.11%20%7C%203.12%20%7C%203.13-blue)](https://www.python.org)
+[![License](https://img.shields.io/badge/license-Apache--2.0-green)](LICENSE)
+[![Code style: ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://github.com/astral-sh/ruff)
+
+Customer.io transactional email and messaging client for Altissimo Python projects.
+
+## Features
+
+- 📋 **Template emails** via `send_email()` — uses Customer.io transactional templates
+- 📧 **Plain text** emails via `send_text()` — inline content, no template required
+- 🎨 **HTML** emails via `send_html()` — inline content, no template required
+- 🌍 **Region support** — US and EU data centers
+- 🏗️ **Factory method** — `CustomerIOClient.from_env()` reads `CUSTOMERIO_API_KEY` from the environment
+- 🔌 **Optional dependency** — `customerio` SDK is lazily imported with a helpful error message
+- 📐 **Typed** — full type annotations with `py.typed` PEP 561 marker
+- ✅ **Consistent return type** — all methods return a `SendResult` dataclass
+- 🔄 **Retry with backoff** — configurable retry for transient failures
+- ✉️ **Custom headers** — including the RFC 8058 one-click unsubscribe pair
+- 🔔 **Fails loudly** — send failures raise `CustomerIOSendError` by default; opt out per client for batch sends
+
+## Requirements
+
+- Python 3.11+
+
+## Installation
+
+Published on PyPI as [`altissimo-customerio`](https://pypi.org/project/altissimo-customerio/);
+the import name is `altissimo.customerio`.
+
+```bash
+pip install "altissimo-customerio[customerio]"   # core + Customer.io SDK
+```
+
+## Quick Start
+
+```python
+from altissimo.customerio import CustomerIOClient
+
+client = CustomerIOClient.from_env()
+
+# Template email (most common)
+result = client.send_email(
+    to="user@example.com",
+    transactional_message_id="3",
+    message_data={"first_name": "Alice", "year": 2026},
+)
+
+# Plain text
+result = client.send_text(
+    to="user@example.com",
+    subject="Hello",
+    body="Welcome aboard!",
+)
+
+# HTML
+result = client.send_html(
+    to="user@example.com",
+    subject="Hello",
+    html="<h1>Welcome!</h1>",
+    reply_to="support@example.com",
+)
+
+print(result.delivery_id)
+```
+
+## Error Handling
+
+By default a failed send raises `CustomerIOSendError`. The originating SDK
+exception is preserved as `__cause__`, and the full `SendResult` is attached
+as `.result`:
+
+```python
+from altissimo.customerio import CustomerIOClient, CustomerIOSendError
+
+try:
+    result = client.send_html(to="user@example.com", subject="Hi", html="<p>Hi</p>")
+except CustomerIOSendError as exc:
+    logger.error("Reset email failed (status=%s): %s", exc.status_code, exc)
+else:
+    logger.info("Reset email sent: delivery_id=%s", result.delivery_id)
+```
+
+For batch sends where one bad recipient should not abort the run, opt out and
+check `result.ok` yourself:
+
+```python
+client = CustomerIOClient.from_env(raise_on_error=False)
+
+for user in users:
+    result = client.send_email(to=user.email, transactional_message_id="3")
+    if not result.ok:
+        failures.append((user.email, result.status_code, result.error))
+```
+
+`SendResult.raise_for_status()` converts a result to an exception on demand
+(mirroring `requests.Response.raise_for_status`), which is handy when you want
+swallow semantics in one place and raise semantics in another:
+
+```python
+client.send_html(to=..., subject=..., html=...).raise_for_status()
+```
+
+> **Note:** the library does not log send failures above `DEBUG` when
+> `raise_on_error=True` — it has no recipient or template context worth
+> logging from that frame, and a log there would make the failure look
+> handled. Reporting is the caller's job.
+
+## One-Click Unsubscribe (RFC 8058)
+
+Gmail and Yahoo's bulk-sender rules expect notification and marketing mail to carry a
+one-click unsubscribe. That needs **both** headers — `List-Unsubscribe` alone only produces
+a plain link:
+
+```python
+client.send_email(
+    to=user.email,
+    transactional_message_id="12",
+    message_data={"first_name": user.first_name},
+    headers={
+        "List-Unsubscribe": f"<https://api.example.com/email/unsubscribe?t={token}>",
+        "List-Unsubscribe-Post": "List-Unsubscribe=One-Click",
+    },
+    # The opt-out of record is our own database, so Customer.io's global
+    # `unsubscribed` flag (which tracks marketing) must not suppress this.
+    send_to_unsubscribed=True,
+)
+```
+
+Your endpoint must answer an **unauthenticated `POST`** with a `2xx` and no redirect — RFC 8058
+forbids redirecting the POST, because browsers have historically turned redirected POSTs into
+GETs. Providers will retry, so make it idempotent. Expect `GET`s on the same URL too: some
+clients (Apple Mail, Thunderbird) render the header as a link rather than POSTing it, and mail
+gateways and link scanners fetch URLs found in mail — so a `GET` should never mutate anything.
+
+> **Note:** `send_to_unsubscribed` is `bool | None`. Leave it unset to inherit whatever the
+> transactional message is configured with in the Customer.io dashboard; pass `False` to
+> explicitly opt out. `False` is forwarded, not treated as unset.
+
+### Tracking and message retention
+
+Customer.io's dashboard defaults a new transactional message to open and click tracking
+**on**, and to keeping the rendered body in delivery history. Neither can be changed through
+Customer.io's API, but both can be overridden on each send:
+
+```python
+client.send_email(
+    to=user.email,
+    transactional_message_id="password_reset",
+    message_data={"action_url": reset_link},
+    # Click tracking rewrites links through a redirect, which can break one-time codes.
+    tracked=False,
+    # Keep the reset link out of delivery history.
+    disable_message_retention=True,
+)
+```
+
+Both are `bool | None`, like `send_to_unsubscribed`: unset inherits the message's dashboard
+setting, and `False` is forwarded. `tracked` covers opens and clicks together.
+
+`send_text()` and `send_html()` accept both too, but an inline send has no transactional
+message to inherit from: unset there means Customer.io's own default, which is tracking
+**on** and the body **retained**. Pass `tracked=False` and `disable_message_retention=True`
+explicitly for inline mail that carries one-time links or codes.
+
+## Configuration
+
+### Environment Variables
+
+| Variable | Description | Default |
+|---|---|---|
+| `CUSTOMERIO_API_KEY` | Customer.io App API key | *(required)* |
+| `CUSTOMERIO_REGION` | Data center region (`us` or `eu`) | `us` |
+
+### Constructor
+
+```python
+client = CustomerIOClient(
+    app_api_key="your-api-key",
+    region="us",  # "us" or "eu"
+    default_from="noreply@lived.com",  # default sender
+    max_retries=3,  # retry transient failures
+    retry_delay=1.0,  # base delay (seconds)
+    raise_on_error=True,  # raise CustomerIOSendError on failure (default)
+)
+```
+
+## API Reference
+
+### `CustomerIOClient`
+
+| Method | Description |
+|---|---|
+| `CustomerIOClient(app_api_key, region?, default_from?, raise_on_error?)` | Create a client with an explicit API key |
+| `CustomerIOClient.from_env(env_var?, region?, default_from?, raise_on_error?)` | Create a client from an environment variable |
+| `send_email(to, transactional_message_id, message_data?, ...)` | Send a template-based transactional email |
+| `send_text(to, subject, body, from_email?, reply_to?, ...)` | Send a plain-text email (inline content) |
+| `send_html(to, subject, html, from_email?, reply_to?, ...)` | Send an HTML email (inline content) |
+
+### `SendResult`
+
+| Field | Type | Description |
+|---|---|---|
+| `ok` | `bool` | Whether the request succeeded |
+| `delivery_id` | `str` | Delivery ID from Customer.io |
+| `status_code` | `int` | HTTP status code (0 on exception) |
+| `body` | `dict[str, Any]` | Response body |
+| `error` | `str \| None` | Error message on failure |
+| `exception` | `Exception \| None` | Originating SDK exception on failure |
+
+| Method | Description |
+|---|---|
+| `raise_for_status(context?)` | Raise `CustomerIOSendError` if `ok` is `False`; no-op otherwise |
+
+### Exceptions
+
+| Exception | Raised when |
+|---|---|
+| `CustomerIOError` | Base class for all library errors |
+| `CustomerIOImportError` | The `customerio` SDK is not installed |
+| `CustomerIOSendError` | A send failed (carries `status_code` and `result`) |
+
+## Architecture
+
+```text
+altissimo.customerio
+├── __init__.py       # Public API surface
+├── client.py         # CustomerIOClient with lazy SDK initialization
+├── exceptions.py     # CustomerIOError, CustomerIOImportError, CustomerIOSendError
+├── models.py         # EmailAddress, SendResult dataclasses
+└── py.typed          # PEP 561 marker
+```
+
+## Development
+
+```bash
+# Install all dependencies
+poetry sync
+
+# Run tests
+poetry run pytest
+
+# Run tests with coverage
+poetry run pytest --cov=altissimo --cov-report=term-missing
+
+# Run linters
+poetry run ruff check .
+poetry run ruff format --check .
+```
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for detailed development guidelines.
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for version history.
+
+## Security
+
+For reporting security vulnerabilities, see [SECURITY.md](SECURITY.md).
+
+## License
+
+Apache License 2.0 — see [LICENSE](LICENSE) for details.
+