python-getpaid-core 0.1.1__tar.gz → 3.0.0a2__tar.gz

python_getpaid_core-3.0.0a2/.github/workflows/ci.yml

@@ -0,0 +1,33 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install uv
+        run: pip install uv
+
+      - name: Install dependencies
+        run: uv sync
+
+      - name: Lint with ruff
+        run: uv run ruff check .
+
+      - name: Run tests
+        run: uv run pytest --tb=short

python_getpaid_core-3.0.0a2/.sisyphus/evidence/task-22-readme-core.txt

@@ -0,0 +1,7 @@
+README.md verification results:
+Line count: 82
+pip install count: 1
+BaseProcessor count: 5
+Wrappers count: 8
+
+All verification checks PASSED.

python_getpaid_core-3.0.0a2/PKG-INFO

@@ -0,0 +1,107 @@
+Metadata-Version: 2.4
+Name: python-getpaid-core
+Version: 3.0.0a2
+Summary: Framework-agnostic payment processing core.
+Project-URL: Homepage, https://github.com/django-getpaid/python-getpaid-core
+Project-URL: Repository, https://github.com/django-getpaid/python-getpaid-core
+Project-URL: Documentation, https://getpaid-core.readthedocs.io
+Project-URL: Changelog, https://github.com/django-getpaid/python-getpaid-core/releases
+Author-email: Dominik Kozaczko <dominik@kozaczko.info>
+License: MIT
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Office/Business :: Financial :: Point-Of-Sale
+Classifier: Typing :: Typed
+Requires-Python: >=3.12
+Requires-Dist: anyio>=4.0
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: transitions>=0.9.0
+Description-Content-Type: text/markdown
+
+# python-getpaid-core
+
+[![PyPI version](https://img.shields.io/pypi/v/python-getpaid-core)](https://pypi.org/project/python-getpaid-core/)
+[![Python version](https://img.shields.io/pypi/pyversions/python-getpaid-core)](https://pypi.org/project/python-getpaid-core/)
+[![License](https://img.shields.io/pypi/l/python-getpaid-core)](https://github.com/django-getpaid/python-getpaid-core/blob/main/LICENSE)
+
+**Framework-agnostic payment processing core.**
+
+`python-getpaid-core` is the foundation of the Getpaid ecosystem. It provides the abstract interfaces, finite state machines (FSM), and plugin registry needed to build a robust payment system without coupling your logic to a specific web framework or payment provider.
+
+## Installation
+
+```bash
+pip install python-getpaid-core
+```
+
+## Quick Start: Creating a Custom Processor
+
+To implement a new payment backend, subclass `BaseProcessor` and implement at least `prepare_transaction`.
+
+```python
+from getpaid_core import BaseProcessor
+from getpaid_core.types import TransactionResult
+
+class MyPaymentProcessor(BaseProcessor):
+    slug = "my-provider"
+    display_name = "My Payment Provider"
+    accepted_currencies = ["USD", "EUR"]
+
+    async def prepare_transaction(self, **kwargs) -> TransactionResult:
+        # Generate payment link or form data
+        return TransactionResult(
+            redirect_url=f"https://api.provider.com/pay/{self.payment.id}",
+            method="GET"
+        )
+```
+
+### Registering your Processor
+
+Register your processor using entry points in your `pyproject.toml` so it can be discovered by the registry:
+
+```toml
+[project.entry-points."getpaid.backends"]
+my-provider = "my_package.processors:MyPaymentProcessor"
+```
+
+## Architecture Overview
+
+- **BaseProcessor**: The abstract base class that all payment gateway plugins must implement. It provides the standard interface for transaction preparation, callback handling, charging, and refunds.
+- **PaymentFlow**: Manages the payment lifecycle using a Finite State Machine (FSM) powered by the `transitions` library. It ensures that payments move between states (e.g., `NEW` -> `PREPARED` -> `PAID`) according to strict business rules.
+- **PluginRegistry**: A central service for discovering and managing payment processors registered via `getpaid.backends` entry points.
+- **State Machine (FSM)**: Dynamically attaches state-machine triggers to payment objects at runtime, allowing for clean and predictable state transitions.
+
+## API Summary
+
+| Class / Module | Role |
+| --- | --- |
+| `BaseProcessor` | Abstract base for implementing payment gateways. |
+| `PaymentFlow` | FSM logic for managing payment lifecycles. |
+| `PaymentStatus` | Enum for all possible payment states (NEW, PAID, FAILED, etc.). |
+| `registry` | Singleton registry for backend discovery. |
+| `TransactionResult` | Standard response for transaction initiation. |
+| `GetPaidException` | Base exception for all payment-related errors. |
+
+## Ecosystem
+
+`getpaid-core` is the heart of a larger ecosystem designed to make payment processing easy in any Python web application.
+
+### Framework Wrappers
+- [django-getpaid](https://github.com/django-getpaid/django-getpaid) — Official Django integration.
+- [litestar-getpaid](https://github.com/django-getpaid/litestar-getpaid) — Official Litestar integration.
+- [fastapi-getpaid](https://github.com/django-getpaid/fastapi-getpaid) — Official FastAPI integration.
+
+### Processor Plugins
+- [python-getpaid-payu](https://github.com/django-getpaid/python-getpaid-payu) — PayU backend.
+- [python-getpaid-paynow](https://github.com/django-getpaid/python-getpaid-paynow) — Paynow backend.
+- [python-getpaid-bitpay](https://github.com/django-getpaid/python-getpaid-bitpay) — BitPay backend.
+- [python-getpaid-przelewy24](https://github.com/django-getpaid/python-getpaid-przelewy24) — Przelewy24 backend.
+
+## License
+
+This project is licensed under the MIT License.

python_getpaid_core-3.0.0a2/README.md

@@ -0,0 +1,82 @@
+# python-getpaid-core
+
+[![PyPI version](https://img.shields.io/pypi/v/python-getpaid-core)](https://pypi.org/project/python-getpaid-core/)
+[![Python version](https://img.shields.io/pypi/pyversions/python-getpaid-core)](https://pypi.org/project/python-getpaid-core/)
+[![License](https://img.shields.io/pypi/l/python-getpaid-core)](https://github.com/django-getpaid/python-getpaid-core/blob/main/LICENSE)
+
+**Framework-agnostic payment processing core.**
+
+`python-getpaid-core` is the foundation of the Getpaid ecosystem. It provides the abstract interfaces, finite state machines (FSM), and plugin registry needed to build a robust payment system without coupling your logic to a specific web framework or payment provider.
+
+## Installation
+
+```bash
+pip install python-getpaid-core
+```
+
+## Quick Start: Creating a Custom Processor
+
+To implement a new payment backend, subclass `BaseProcessor` and implement at least `prepare_transaction`.
+
+```python
+from getpaid_core import BaseProcessor
+from getpaid_core.types import TransactionResult
+
+class MyPaymentProcessor(BaseProcessor):
+    slug = "my-provider"
+    display_name = "My Payment Provider"
+    accepted_currencies = ["USD", "EUR"]
+
+    async def prepare_transaction(self, **kwargs) -> TransactionResult:
+        # Generate payment link or form data
+        return TransactionResult(
+            redirect_url=f"https://api.provider.com/pay/{self.payment.id}",
+            method="GET"
+        )
+```
+
+### Registering your Processor
+
+Register your processor using entry points in your `pyproject.toml` so it can be discovered by the registry:
+
+```toml
+[project.entry-points."getpaid.backends"]
+my-provider = "my_package.processors:MyPaymentProcessor"
+```
+
+## Architecture Overview
+
+- **BaseProcessor**: The abstract base class that all payment gateway plugins must implement. It provides the standard interface for transaction preparation, callback handling, charging, and refunds.
+- **PaymentFlow**: Manages the payment lifecycle using a Finite State Machine (FSM) powered by the `transitions` library. It ensures that payments move between states (e.g., `NEW` -> `PREPARED` -> `PAID`) according to strict business rules.
+- **PluginRegistry**: A central service for discovering and managing payment processors registered via `getpaid.backends` entry points.
+- **State Machine (FSM)**: Dynamically attaches state-machine triggers to payment objects at runtime, allowing for clean and predictable state transitions.
+
+## API Summary
+
+| Class / Module | Role |
+| --- | --- |
+| `BaseProcessor` | Abstract base for implementing payment gateways. |
+| `PaymentFlow` | FSM logic for managing payment lifecycles. |
+| `PaymentStatus` | Enum for all possible payment states (NEW, PAID, FAILED, etc.). |
+| `registry` | Singleton registry for backend discovery. |
+| `TransactionResult` | Standard response for transaction initiation. |
+| `GetPaidException` | Base exception for all payment-related errors. |
+
+## Ecosystem
+
+`getpaid-core` is the heart of a larger ecosystem designed to make payment processing easy in any Python web application.
+
+### Framework Wrappers
+- [django-getpaid](https://github.com/django-getpaid/django-getpaid) — Official Django integration.
+- [litestar-getpaid](https://github.com/django-getpaid/litestar-getpaid) — Official Litestar integration.
+- [fastapi-getpaid](https://github.com/django-getpaid/fastapi-getpaid) — Official FastAPI integration.
+
+### Processor Plugins
+- [python-getpaid-payu](https://github.com/django-getpaid/python-getpaid-payu) — PayU backend.
+- [python-getpaid-paynow](https://github.com/django-getpaid/python-getpaid-paynow) — Paynow backend.
+- [python-getpaid-bitpay](https://github.com/django-getpaid/python-getpaid-bitpay) — BitPay backend.
+- [python-getpaid-przelewy24](https://github.com/django-getpaid/python-getpaid-przelewy24) — Przelewy24 backend.
+
+## License
+
+This project is licensed under the MIT License.

{python_getpaid_core-0.1.1 → python_getpaid_core-3.0.0a2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = 'python-getpaid-core'
-version = "0.1.1"
+dynamic = ["version"]
 description = 'Framework-agnostic payment processing core.'
 readme = 'README.md'
 license = {text = 'MIT'}
@@ -52,6 +52,9 @@ build-backend = 'hatchling.build'
 [tool.hatch.build.targets.wheel]
 packages = ['src/getpaid_core']
 
+[tool.hatch.version]
+path = "src/getpaid_core/__init__.py"
+
 [tool.pytest.ini_options]
 testpaths = ['tests']
 asyncio_mode = 'auto'

{python_getpaid_core-0.1.1 → python_getpaid_core-3.0.0a2}/src/getpaid_core/__init__.py

@@ -1,6 +1,6 @@
 """Getpaid Core -- framework-agnostic payment processing."""
 
-__version__ = "0.1.0"
+__version__ = "3.0.0a2"
 
 from getpaid_core.enums import BackendMethod
 from getpaid_core.enums import ConfirmationMethod

{python_getpaid_core-0.1.1 → python_getpaid_core-3.0.0a2}/tests/test_public_api.py

@@ -5,7 +5,7 @@ import getpaid_core
 
 class TestPublicAPI:
     def test_version(self):
-        assert getpaid_core.__version__ == "0.1.0"
+        assert getpaid_core.__version__ == "3.0.0a2"
 
     def test_exports_enums(self):
         assert getpaid_core.PaymentStatus is not None

python_getpaid_core-3.0.0a2/tests/test_version.py

@@ -0,0 +1,11 @@
+"""Tests for package version consistency."""
+
+from importlib.metadata import version
+
+import getpaid_core
+
+
+def test_version_consistency():
+    """Ensure __version__ matches package metadata."""
+    pkg_version = version("python-getpaid-core")
+    assert getpaid_core.__version__ == pkg_version

{python_getpaid_core-0.1.1 → python_getpaid_core-3.0.0a2}/uv.lock

@@ -585,7 +585,6 @@ wheels = [
 
 [[package]]
 name = "python-getpaid-core"
-version = "0.1.1"
 source = { editable = "." }
 dependencies = [
     { name = "anyio" },

python_getpaid_core-0.1.1/PKG-INFO

@@ -1,105 +0,0 @@
-Metadata-Version: 2.4
-Name: python-getpaid-core
-Version: 0.1.1
-Summary: Framework-agnostic payment processing core.
-Project-URL: Homepage, https://github.com/django-getpaid/python-getpaid-core
-Project-URL: Repository, https://github.com/django-getpaid/python-getpaid-core
-Project-URL: Documentation, https://getpaid-core.readthedocs.io
-Project-URL: Changelog, https://github.com/django-getpaid/python-getpaid-core/releases
-Author-email: Dominik Kozaczko <dominik@kozaczko.info>
-License: MIT
-License-File: LICENSE
-Classifier: Development Status :: 3 - Alpha
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.12
-Classifier: Programming Language :: Python :: 3.13
-Classifier: Topic :: Office/Business :: Financial
-Classifier: Topic :: Office/Business :: Financial :: Point-Of-Sale
-Classifier: Typing :: Typed
-Requires-Python: >=3.12
-Requires-Dist: anyio>=4.0
-Requires-Dist: httpx>=0.27.0
-Requires-Dist: transitions>=0.9.0
-Description-Content-Type: text/markdown
-
-# getpaid-core
-
-[![PyPI](https://img.shields.io/pypi/v/python-getpaid-core.svg)](https://pypi.org/project/python-getpaid-core/)
-[![Python Version](https://img.shields.io/pypi/pyversions/python-getpaid-core)](https://pypi.org/project/python-getpaid-core/)
-[![License](https://img.shields.io/pypi/l/python-getpaid-core)](https://github.com/django-getpaid/python-getpaid-core/blob/main/LICENSE)
-
-Framework-agnostic payment processing library for Python. Provides the core
-abstractions — enums, protocols, FSM, processor base class, plugin registry,
-and exception hierarchy — that framework-specific adapters build on.
-
-## Architecture
-
-getpaid-core defines the **what** of payment processing without coupling to
-any web framework:
-
-- **Enums** (`PaymentStatus`, `FraudStatus`, `BackendMethod`, `ConfirmationMethod`)
-  define all valid states and methods.
-- **Protocols** (`Payment`, `Order`, `PaymentRepository`) define structural
-  contracts that framework models must satisfy.
-- **FSM** (`create_payment_machine`, `create_fraud_machine`) attaches
-  state-machine triggers to payment objects at runtime using the `transitions`
-  library.
-- **BaseProcessor** is an abstract class that payment gateway plugins subclass
-  to implement `prepare_transaction`, `handle_callback`, `charge`, etc.
-- **PluginRegistry** discovers and stores payment backend processors via
-  entry points or manual registration.
-- **Exceptions** provide a structured hierarchy for payment errors.
-
-## Framework Adapters
-
-- **[django-getpaid](https://github.com/django-getpaid/django-getpaid)** —
-  Django adapter (models, views, forms, admin)
-- **[fastapi-getpaid](https://github.com/django-getpaid/fastapi-getpaid)** —
-  FastAPI adapter (async routes, SQLAlchemy, Pydantic config)
-- **[litestar-getpaid](https://github.com/django-getpaid/litestar-getpaid)** —
-  Litestar adapter (controllers, Provide DI, SQLAlchemy, Pydantic config)
-
-## Installation
-
-```bash
-pip install python-getpaid-core
-```
-
-You typically install this as a dependency of a framework adapter rather than
-directly.
-
-## Quick Example
-
-```python
-from getpaid_core.enums import PaymentStatus
-from getpaid_core.fsm import create_payment_machine
-
-# Any object satisfying the Payment protocol works
-payment = MyPayment(status=PaymentStatus.NEW, amount_required=100)
-machine = create_payment_machine(payment)
-
-# FSM trigger methods are attached directly to the object
-payment.confirm_prepared()
-assert payment.status == PaymentStatus.PREPARED
-```
-
-## Requirements
-
-- Python 3.12+
-- transitions
-- httpx
-- anyio
-
-## License
-
-MIT
-
-## Disclaimer
-
-This project has nothing in common with the
-[getpaid](http://code.google.com/p/getpaid/) plone project.
-
-## Credits
-
-Created by [Dominik Kozaczko](https://github.com/dekoza).

python_getpaid_core-0.1.1/README.md

@@ -1,80 +0,0 @@
-# getpaid-core
-
-[![PyPI](https://img.shields.io/pypi/v/python-getpaid-core.svg)](https://pypi.org/project/python-getpaid-core/)
-[![Python Version](https://img.shields.io/pypi/pyversions/python-getpaid-core)](https://pypi.org/project/python-getpaid-core/)
-[![License](https://img.shields.io/pypi/l/python-getpaid-core)](https://github.com/django-getpaid/python-getpaid-core/blob/main/LICENSE)
-
-Framework-agnostic payment processing library for Python. Provides the core
-abstractions — enums, protocols, FSM, processor base class, plugin registry,
-and exception hierarchy — that framework-specific adapters build on.
-
-## Architecture
-
-getpaid-core defines the **what** of payment processing without coupling to
-any web framework:
-
-- **Enums** (`PaymentStatus`, `FraudStatus`, `BackendMethod`, `ConfirmationMethod`)
-  define all valid states and methods.
-- **Protocols** (`Payment`, `Order`, `PaymentRepository`) define structural
-  contracts that framework models must satisfy.
-- **FSM** (`create_payment_machine`, `create_fraud_machine`) attaches
-  state-machine triggers to payment objects at runtime using the `transitions`
-  library.
-- **BaseProcessor** is an abstract class that payment gateway plugins subclass
-  to implement `prepare_transaction`, `handle_callback`, `charge`, etc.
-- **PluginRegistry** discovers and stores payment backend processors via
-  entry points or manual registration.
-- **Exceptions** provide a structured hierarchy for payment errors.
-
-## Framework Adapters
-
-- **[django-getpaid](https://github.com/django-getpaid/django-getpaid)** —
-  Django adapter (models, views, forms, admin)
-- **[fastapi-getpaid](https://github.com/django-getpaid/fastapi-getpaid)** —
-  FastAPI adapter (async routes, SQLAlchemy, Pydantic config)
-- **[litestar-getpaid](https://github.com/django-getpaid/litestar-getpaid)** —
-  Litestar adapter (controllers, Provide DI, SQLAlchemy, Pydantic config)
-
-## Installation
-
-```bash
-pip install python-getpaid-core
-```
-
-You typically install this as a dependency of a framework adapter rather than
-directly.
-
-## Quick Example
-
-```python
-from getpaid_core.enums import PaymentStatus
-from getpaid_core.fsm import create_payment_machine
-
-# Any object satisfying the Payment protocol works
-payment = MyPayment(status=PaymentStatus.NEW, amount_required=100)
-machine = create_payment_machine(payment)
-
-# FSM trigger methods are attached directly to the object
-payment.confirm_prepared()
-assert payment.status == PaymentStatus.PREPARED
-```
-
-## Requirements
-
-- Python 3.12+
-- transitions
-- httpx
-- anyio
-
-## License
-
-MIT
-
-## Disclaimer
-
-This project has nothing in common with the
-[getpaid](http://code.google.com/p/getpaid/) plone project.
-
-## Credits
-
-Created by [Dominik Kozaczko](https://github.com/dekoza).