boilpayment 0.2.0__tar.gz

boilpayment-0.2.0/.gitignore

@@ -0,0 +1,13 @@
+node_modules/
+dist/
+*.tsbuildinfo
+.venv/
+__pycache__/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.env
+.env.*
+!.env.example
+.DS_Store
+paykit.config.json

boilpayment-0.2.0/LICENSE

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

boilpayment-0.2.0/PKG-INFO

@@ -0,0 +1,104 @@
+Metadata-Version: 2.5
+Name: boilpayment
+Version: 0.2.0
+Summary: Payment kit: refunds, dunning, renewals and overage for code generated by npx boilpayment init. Part of Schift's boil series.
+Project-URL: Homepage, https://github.com/schift-io/boilpayment#readme
+Project-URL: Repository, https://github.com/schift-io/boilpayment.git
+Project-URL: Issues, https://github.com/schift-io/boilpayment/issues
+Author: boilpayment contributors
+License-Expression: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Office/Business :: Financial
+Requires-Python: >=3.11
+Requires-Dist: cryptography>=43
+Requires-Dist: httpx>=0.27
+Requires-Dist: psycopg-pool>=3.2
+Requires-Dist: psycopg[binary]>=3.2
+Requires-Dist: stripe>=11
+Description-Content-Type: text/markdown
+
+# boilpayment
+
+Single-install facade for boilpayment. Depends on all 13 `boilpayment-*`
+distributions pinned to the exact version published alongside it (`==0.1.0`, not a range — a
+mismatched internal version can never happen) and re-exports every one of them as a submodule, so
+a project only installs and imports **one** distribution instead of thirteen.
+
+## Install
+
+```
+pip install boilpayment
+```
+
+## Usage
+
+Pick your module by submodule:
+
+```python
+from boilpayment.core import resolve_policy, InMemoryLedger, InMemoryRepo, SystemClock, UuidIdGen
+from boilpayment.lifecycle import upgrade, downgrade, cancel, reactivate
+from boilpayment.credits import consume, topup
+from boilpayment.refund import evaluate, execute
+from boilpayment.usage import record, check
+from boilpayment.webhook import receive, process, default_handlers
+from boilpayment.notify import resend, smtp, slack
+from boilpayment.cs import open_case, escalate
+from boilpayment.postgres import PostgresRepo, PostgresLedgerStore, migrate
+from boilpayment.stripe import StripeProvider
+from boilpayment.toss import TossProvider
+from boilpayment.portone import PortoneProvider
+from boilpayment.polar import PolarProvider
+```
+
+Every submodule above (`.core`, `.credits`, `.lifecycle`, `.refund`, `.usage`, `.webhook`,
+`.notify`, `.cs`, `.postgres`, `.stripe`, `.toss`, `.portone`, `.polar`) is a **full, unfiltered**
+re-export of the corresponding `boilpayment-*` distribution — nothing is renamed or
+dropped, and each has its own explicit `__all__` mirroring the source distribution's public
+surface.
+
+The package root (`from boilpayment import ...`, no submodule) is narrower — see below.
+
+## Root export & name collisions
+
+`boilpayment` (the bare root import) re-exports the **full** surface of
+`boilpayment_core` (types, `Policy`, `Clock`/`IdGen`, period/money helpers, idempotency
+helpers, in-memory reference implementations, logging) plus a curated set of the most-used entry
+points from the five core operation modules:
+
+| from | names |
+|---|---|
+| lifecycle | `upgrade`, `downgrade`, `cancel`, `reactivate` |
+| credits | `consume`, `topup` |
+| refund | `evaluate`, `execute`, `on_external_refund` |
+| usage | `record`, `check` |
+| webhook | `receive`, `process`, `default_handlers` |
+
+**Not** re-exported at the root — every one of these is a deliberate exclusion, not an oversight:
+
+- **The four provider adapters** (`.stripe`, `.toss`, `.portone`, `.polar`) — they export several
+  same-named symbols with genuinely different shapes:
+  - `normalize_failure`, `normalize_subscription`, `normalize_refund`, `map_event_type`,
+    `to_normalized_event` — defined by **both** `boilpayment_stripe` and
+    `boilpayment_polar`, with different signatures.
+  - `CashReceiptType`, `CashReceiptStatus`, `CashReceipt` — defined by **both**
+    `boilpayment_toss` and `boilpayment_portone`, with different shapes.
+
+  Re-exporting any two providers at the same root would silently shadow one implementation with
+  the other depending on import order. Import providers from their own submodule.
+- **`.refund`'s own `proration_ratio`** (and `days_between`/`apply_rounding`/
+  `weighted_avg_unit_price`) — `proration_ratio` is a **real** collision with
+  `boilpayment_core`'s own `proration_ratio` (already re-exported at the root via the core
+  surface). The root always resolves to core's version; refund's copy is only reachable via
+  `boilpayment.refund`.
+- **`.notify`, `.cs`, `.postgres`** — add-on/infra modules most projects don't touch.
+- **The rest of `.lifecycle`** (`convert_trial`, `retry_on_version_conflict`, the `dunning`,
+  `scheduler`, `period` submodules), **`.credits`** (`grant_for_period`, `rollover_on_renewal`,
+  `clawback`, `expire_due`, `notify_expiring`), **`.usage`** (`close_period`, `flush_outbox`),
+  **`.webhook`** (`process_pending`, http helpers, correlation-id helpers) — no collision, just
+  kept off the root to keep it short. Pull these from their submodule.
+
+Full contract: [docs/ARCHITECTURE.md](https://github.com/schift-io/boilpayment/blob/main/docs/ARCHITECTURE.md) ·
+[docs/EDGE_CASES.md](https://github.com/schift-io/boilpayment/blob/main/docs/EDGE_CASES.md).

boilpayment-0.2.0/README.md

@@ -0,0 +1,82 @@
+# boilpayment
+
+Single-install facade for boilpayment. Depends on all 13 `boilpayment-*`
+distributions pinned to the exact version published alongside it (`==0.1.0`, not a range — a
+mismatched internal version can never happen) and re-exports every one of them as a submodule, so
+a project only installs and imports **one** distribution instead of thirteen.
+
+## Install
+
+```
+pip install boilpayment
+```
+
+## Usage
+
+Pick your module by submodule:
+
+```python
+from boilpayment.core import resolve_policy, InMemoryLedger, InMemoryRepo, SystemClock, UuidIdGen
+from boilpayment.lifecycle import upgrade, downgrade, cancel, reactivate
+from boilpayment.credits import consume, topup
+from boilpayment.refund import evaluate, execute
+from boilpayment.usage import record, check
+from boilpayment.webhook import receive, process, default_handlers
+from boilpayment.notify import resend, smtp, slack
+from boilpayment.cs import open_case, escalate
+from boilpayment.postgres import PostgresRepo, PostgresLedgerStore, migrate
+from boilpayment.stripe import StripeProvider
+from boilpayment.toss import TossProvider
+from boilpayment.portone import PortoneProvider
+from boilpayment.polar import PolarProvider
+```
+
+Every submodule above (`.core`, `.credits`, `.lifecycle`, `.refund`, `.usage`, `.webhook`,
+`.notify`, `.cs`, `.postgres`, `.stripe`, `.toss`, `.portone`, `.polar`) is a **full, unfiltered**
+re-export of the corresponding `boilpayment-*` distribution — nothing is renamed or
+dropped, and each has its own explicit `__all__` mirroring the source distribution's public
+surface.
+
+The package root (`from boilpayment import ...`, no submodule) is narrower — see below.
+
+## Root export & name collisions
+
+`boilpayment` (the bare root import) re-exports the **full** surface of
+`boilpayment_core` (types, `Policy`, `Clock`/`IdGen`, period/money helpers, idempotency
+helpers, in-memory reference implementations, logging) plus a curated set of the most-used entry
+points from the five core operation modules:
+
+| from | names |
+|---|---|
+| lifecycle | `upgrade`, `downgrade`, `cancel`, `reactivate` |
+| credits | `consume`, `topup` |
+| refund | `evaluate`, `execute`, `on_external_refund` |
+| usage | `record`, `check` |
+| webhook | `receive`, `process`, `default_handlers` |
+
+**Not** re-exported at the root — every one of these is a deliberate exclusion, not an oversight:
+
+- **The four provider adapters** (`.stripe`, `.toss`, `.portone`, `.polar`) — they export several
+  same-named symbols with genuinely different shapes:
+  - `normalize_failure`, `normalize_subscription`, `normalize_refund`, `map_event_type`,
+    `to_normalized_event` — defined by **both** `boilpayment_stripe` and
+    `boilpayment_polar`, with different signatures.
+  - `CashReceiptType`, `CashReceiptStatus`, `CashReceipt` — defined by **both**
+    `boilpayment_toss` and `boilpayment_portone`, with different shapes.
+
+  Re-exporting any two providers at the same root would silently shadow one implementation with
+  the other depending on import order. Import providers from their own submodule.
+- **`.refund`'s own `proration_ratio`** (and `days_between`/`apply_rounding`/
+  `weighted_avg_unit_price`) — `proration_ratio` is a **real** collision with
+  `boilpayment_core`'s own `proration_ratio` (already re-exported at the root via the core
+  surface). The root always resolves to core's version; refund's copy is only reachable via
+  `boilpayment.refund`.
+- **`.notify`, `.cs`, `.postgres`** — add-on/infra modules most projects don't touch.
+- **The rest of `.lifecycle`** (`convert_trial`, `retry_on_version_conflict`, the `dunning`,
+  `scheduler`, `period` submodules), **`.credits`** (`grant_for_period`, `rollover_on_renewal`,
+  `clawback`, `expire_due`, `notify_expiring`), **`.usage`** (`close_period`, `flush_outbox`),
+  **`.webhook`** (`process_pending`, http helpers, correlation-id helpers) — no collision, just
+  kept off the root to keep it short. Pull these from their submodule.
+
+Full contract: [docs/ARCHITECTURE.md](https://github.com/schift-io/boilpayment/blob/main/docs/ARCHITECTURE.md) ·
+[docs/EDGE_CASES.md](https://github.com/schift-io/boilpayment/blob/main/docs/EDGE_CASES.md).

boilpayment-0.2.0/pyproject.toml

@@ -0,0 +1,28 @@
+[project]
+name = "boilpayment"
+version = "0.2.0"
+description = "Payment kit: refunds, dunning, renewals and overage for code generated by npx boilpayment init. Part of Schift's boil series."
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [{ name = "boilpayment contributors" }]
+requires-python = ">=3.11"
+dependencies = ["cryptography>=43", "httpx>=0.27", "psycopg-pool>=3.2", "psycopg[binary]>=3.2", "stripe>=11"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Programming Language :: Python :: 3",
+  "Topic :: Office/Business :: Financial",
+]
+
+[project.urls]
+Homepage = "https://github.com/schift-io/boilpayment#readme"
+Repository = "https://github.com/schift-io/boilpayment.git"
+Issues = "https://github.com/schift-io/boilpayment/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/boilpayment_core","src/boilpayment_credits","src/boilpayment_refund","src/boilpayment_usage","src/boilpayment_webhook","src/boilpayment_notify","src/boilpayment_schema_postgres","src/boilpayment_lifecycle","src/boilpayment_cs","src/boilpayment_stripe","src/boilpayment_toss","src/boilpayment_portone","src/boilpayment_polar","src/boilpayment"]

boilpayment-0.2.0/src/boilpayment/__init__.py

@@ -0,0 +1,337 @@
+"""boilpayment -- root export.
+
+Deliberately narrow (see ../README.md "Root export & name collisions" for the full rationale and
+the two real name collisions this avoids). What's here:
+  1. The full surface of boilpayment_core (types, Policy, Clock/IdGen, period/money
+     helpers, idempotency helpers, in-memory reference implementations, logging) -- this is what
+     every other module's function signatures are built from, so it's safe and expected to be
+     fully available at the root.
+  2. A curated set of the most-used entry points from the five core operation modules
+     (lifecycle, credits, refund, usage, webhook), so
+     `from boilpayment import upgrade, consume, evaluate, record, receive` covers the
+     common path without picking a submodule.
+
+NOT re-exported here -- use the dedicated submodule instead:
+  - `.stripe`, `.toss`, `.portone`, `.polar` -- the four provider adapters export several
+    same-named functions/types with DIFFERENT shapes (`normalize_failure`,
+    `normalize_subscription`, `normalize_refund`, `map_event_type`, `to_normalized_event` collide
+    between stripe/polar; `CashReceiptType`, `CashReceiptStatus`, `CashReceipt` collide between
+    toss/portone). Bundling any two of them at the root would silently shadow one implementation
+    with the other.
+  - `.notify`, `.cs`, `.postgres` -- add-on/infra modules, not every project uses them.
+  - `.refund`'s own `proration_ratio` (and `days_between`/`apply_rounding`/
+    `weighted_avg_unit_price`) -- `proration_ratio` is a REAL collision with core's own
+    `proration_ratio` (re-exported via #1 above); refund's copy is available at `.refund` only, so
+    `from boilpayment import ...` always gets core's version unambiguously.
+  - the rest of `.lifecycle` (`downgrade`/`convert_trial`/`retry_on_version_conflict`/the
+    `dunning`, `scheduler`, `period` submodules), `.credits` (`grant_for_period`/
+    `rollover_on_renewal`/`clawback`/`expire_due`/`notify_expiring`), `.usage`
+    (`close_period`/`flush_outbox`), `.webhook` (`process_pending`/`default_handlers`/http
+    helpers/correlation ids) -- deeper wiring, no collisions, just kept off the root to keep it a
+    short list. Pull them from their submodule.
+"""
+
+from __future__ import annotations
+
+from boilpayment_core import (
+    DEFAULT_POLICY,
+    ZERO_DECIMAL_CURRENCIES,
+    AnnualRefundMethod,
+    AppendResult,
+    Balance,
+    BankReset,
+    BaseLogger,
+    CancelCredits,
+    CancelMode,
+    CashReceiptMode,
+    CashReceiptRef,
+    CashReceiptType,
+    Checkout,
+    ClawbackShortfall,
+    Clock,
+    CollectingLogger,
+    CollectingNotifier,
+    ConsoleLogger,
+    ConsumeInput,
+    ConsumeOrder,
+    ConsumeResult,
+    CreateCheckoutInput,
+    CsCase,
+    CsCaseKind,
+    CsCaseStatus,
+    Customer,
+    CustomerStatus,
+    Deps,
+    DisputeOnLost,
+    DisputeOnOpen,
+    DowngradeMode,
+    ExpiringBucket,
+    FeeBearer,
+    FixedClock,
+    GrantDuringGrace,
+    GrantLagBehavior,
+    IdGen,
+    InMemoryLedger,
+    InMemoryRepo,
+    InsufficientBalanceError,
+    Interval,
+    IntervalChangeMode,
+    LedgerEntry,
+    LedgerKind,
+    LedgerReference,
+    LedgerSource,
+    LedgerStore,
+    Logger,
+    LogLevel,
+    MemTable,
+    Money,
+    MonthEndAnchor,
+    MultipleSubscriptions,
+    NegativeBalance,
+    NegativeOffset,
+    NewLedgerEntry,
+    NoopLogger,
+    NoopNotifier,
+    NormalizedEvent,
+    NormalizedEventType,
+    Notification,
+    Notifier,
+    NotifyType,
+    OnFinalFailure,
+    OnRecovery,
+    Operation,
+    OperationStatus,
+    OutboxItem,
+    Overage,
+    OveruseBehavior,
+    PauseMode,
+    Payment,
+    PaymentFailure,
+    PaymentKind,
+    PaymentKitError,
+    PaymentProvider,
+    PaymentStatus,
+    Period,
+    Plan,
+    PlanPrice,
+    Policy,
+    PolicyValidationError,
+    Pool,
+    PoolMode,
+    ProrationDenominator,
+    ProviderCapabilities,
+    ProviderError,
+    ProviderName,
+    ProviderRef,
+    Refund,
+    RefundDecision,
+    RefundMethod,
+    RefundRounding,
+    RefundStatus,
+    RegrantMode,
+    Repo,
+    RevokeShortfall,
+    Rollover,
+    RunIdempotentResult,
+    SequentialIdGen,
+    Subscription,
+    SubscriptionStatus,
+    SystemClock,
+    Table,
+    TrialAbuseGuard,
+    TrialCreditsOnCancel,
+    TrialCreditsOnConvert,
+    UpgradeCreditDelta,
+    UpgradeMode,
+    UsageDuringGrace,
+    UsageEvent,
+    UuidIdGen,
+    WebhookEventRecord,
+    WebhookEventStatus,
+    WebhookSignatureError,
+    add_money,
+    assert_same_currency,
+    civil_day_of,
+    days_in_month,
+    days_in_period,
+    deserialize_cs_case,
+    deserialize_ledger_entry,
+    deserialize_refund,
+    deserialize_subscription,
+    elapsed_ratio,
+    hash_payload,
+    money,
+    mul_money_ratio,
+    next_period,
+    period_containing,
+    proration_ratio,
+    redact,
+    resolve_policy,
+    serialize_cs_case,
+    serialize_ledger_entry,
+    serialize_refund,
+    serialize_subscription,
+    stable_stringify,
+    validate_policy,
+)
+from boilpayment_credits import consume, topup
+from boilpayment_lifecycle import cancel, downgrade, reactivate, upgrade
+from boilpayment_refund import evaluate, execute, on_external_refund
+from boilpayment_usage import check, record
+from boilpayment_webhook import default_handlers, process, receive
+
+__all__ = [
+    "DEFAULT_POLICY",
+    "ZERO_DECIMAL_CURRENCIES",
+    "AnnualRefundMethod",
+    "AppendResult",
+    "Balance",
+    "BankReset",
+    "BaseLogger",
+    "CancelCredits",
+    "CancelMode",
+    "CashReceiptMode",
+    "CashReceiptRef",
+    "CashReceiptType",
+    "Checkout",
+    "ClawbackShortfall",
+    "Clock",
+    "CollectingLogger",
+    "CollectingNotifier",
+    "ConsoleLogger",
+    "ConsumeInput",
+    "ConsumeOrder",
+    "ConsumeResult",
+    "CreateCheckoutInput",
+    "CsCase",
+    "CsCaseKind",
+    "CsCaseStatus",
+    "Customer",
+    "CustomerStatus",
+    "Deps",
+    "DisputeOnLost",
+    "DisputeOnOpen",
+    "DowngradeMode",
+    "ExpiringBucket",
+    "FeeBearer",
+    "FixedClock",
+    "GrantDuringGrace",
+    "GrantLagBehavior",
+    "IdGen",
+    "InMemoryLedger",
+    "InMemoryRepo",
+    "InsufficientBalanceError",
+    "Interval",
+    "IntervalChangeMode",
+    "LedgerEntry",
+    "LedgerKind",
+    "LedgerReference",
+    "LedgerSource",
+    "LedgerStore",
+    "LogLevel",
+    "Logger",
+    "MemTable",
+    "Money",
+    "MonthEndAnchor",
+    "MultipleSubscriptions",
+    "NegativeBalance",
+    "NegativeOffset",
+    "NewLedgerEntry",
+    "NoopLogger",
+    "NoopNotifier",
+    "NormalizedEvent",
+    "NormalizedEventType",
+    "Notification",
+    "Notifier",
+    "NotifyType",
+    "OnFinalFailure",
+    "OnRecovery",
+    "Operation",
+    "OperationStatus",
+    "OutboxItem",
+    "Overage",
+    "OveruseBehavior",
+    "PauseMode",
+    "Payment",
+    "PaymentFailure",
+    "PaymentKind",
+    "PaymentKitError",
+    "PaymentProvider",
+    "PaymentStatus",
+    "Period",
+    "Plan",
+    "PlanPrice",
+    "Policy",
+    "PolicyValidationError",
+    "Pool",
+    "PoolMode",
+    "ProrationDenominator",
+    "ProviderCapabilities",
+    "ProviderError",
+    "ProviderName",
+    "ProviderRef",
+    "Refund",
+    "RefundDecision",
+    "RefundMethod",
+    "RefundRounding",
+    "RefundStatus",
+    "RegrantMode",
+    "Repo",
+    "RevokeShortfall",
+    "Rollover",
+    "RunIdempotentResult",
+    "SequentialIdGen",
+    "Subscription",
+    "SubscriptionStatus",
+    "SystemClock",
+    "Table",
+    "TrialAbuseGuard",
+    "TrialCreditsOnCancel",
+    "TrialCreditsOnConvert",
+    "UpgradeCreditDelta",
+    "UpgradeMode",
+    "UsageDuringGrace",
+    "UsageEvent",
+    "UuidIdGen",
+    "WebhookEventRecord",
+    "WebhookEventStatus",
+    "WebhookSignatureError",
+    "add_money",
+    "assert_same_currency",
+    "cancel",
+    "check",
+    "civil_day_of",
+    "consume",
+    "days_in_month",
+    "days_in_period",
+    "default_handlers",
+    "deserialize_cs_case",
+    "deserialize_ledger_entry",
+    "deserialize_refund",
+    "deserialize_subscription",
+    "downgrade",
+    "elapsed_ratio",
+    "evaluate",
+    "execute",
+    "hash_payload",
+    "money",
+    "mul_money_ratio",
+    "next_period",
+    "on_external_refund",
+    "period_containing",
+    "process",
+    "proration_ratio",
+    "reactivate",
+    "receive",
+    "record",
+    "redact",
+    "resolve_policy",
+    "serialize_cs_case",
+    "serialize_ledger_entry",
+    "serialize_refund",
+    "serialize_subscription",
+    "stable_stringify",
+    "topup",
+    "upgrade",
+    "validate_policy",
+]