Metadata-Version: 2.1
Name: django-payments-mollie
Version: 0.0.1
Summary: Mollie integration for django-payments
Keywords: 
Author-email: Four Digits <info@fourdigits.nl>
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: django-payments
Requires-Dist: mollie-api-python >=3.1.0
Requires-Dist: flit ; extra == "dev"
Requires-Dist: pytest ; extra == "test"
Requires-Dist: pytest-cov ; extra == "test"
Requires-Dist: pytest-django ; extra == "test"
Requires-Dist: pytest-mock ; extra == "test"
Requires-Dist: dj_database_url ; extra == "test"
Requires-Dist: factory_boy ; extra == "test"
Project-URL: Documentation, https://github.com/fourdigits/django-payments-mollie#readme
Project-URL: Issues, https://github.com/fourdigits/django-payments-mollie/issues
Project-URL: Source, https://github.com/fourdigits/django-payments-mollie
Provides-Extra: dev
Provides-Extra: test

# django-payments-mollie

[![PyPI - Version](https://img.shields.io/pypi/v/django-payments-mollie.svg)](https://pypi.org/project/django-payments-mollie)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/django-payments-mollie.svg)](https://pypi.org/project/django-payments-mollie)

-----

Django Payments Mollie is a Django app that adds support for the [Mollie payment provider](https://www.mollie.com) to [Django Payments](https://django-payments.readthedocs.io/).

**Table of Contents**

- [Installation](#installation)
- [Configuration](#configuration)
- [Sandbox](#sandbox)
- [License](#license)

## Installation

```console
pip install django-payments-mollie
```

## Configuration

You should follow the configration guide in the Django Payments documentation. To setup this package as a payment variant, use the following `PAYMENT_VARIANTS` in the Django settings file:

```python
PAYMENT_VARIANTS = {
    "mollie": (
        "django_payments_mollie.provider.MollieProvider",
        {
            # For api key authentication
            "api_key": "test_example-api-key",

            # For access token authentication
            "access_token": "access_example-token",
            "testmode": True,

            # For OAuth2 authentication
            "client_id": "example-client-id",
            "client_secret": "example-client-secret",
            "testmode": True,
        }
    )
}
```

### Available configuration options

- `api_key`: A [Mollie API key](https://docs.mollie.com/overview/authentication#creating-api-keys), this is the simplest way to configure access to the Mollie API. Use the test key for development or testing. This also allows you to use payment methods that aren't enabled for live payments yet.

### Configuration helpers

#### Payment model

Django Payments docs will instruct you to create a Payment model that subclasses `BasePayment`. This package also provides a base model that you can use (optionally). The abstract model class `BaseMolliePayment` is a subclass of `BasePayment`, and it configures some of the fields as `required=True`, since Mollie requires them to be filled. Use it just like you would use Django payments' `BasePayment`:

```python
from django_mollie_payments.models import BaseMolliePayment

class Payment(BaseMolliePayment):
    ...
    # Add custom fields and methods
```

## Sandbox

The project contains a sandbox that shows a very simple implementation of Django Payments with the Mollie payment variant. You can use it to see how implementation could be done, or to actually run an application against your own Mollie account. See the [Sandbox README](sandbox/README.md) for details.

## License

`django-payments-mollie` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

