Release 0.1.0

.env.example

@@ -1,12 +1,12 @@
-BPE_WEBSITE="Example.com"
-BPE_WEBSITE_KEY="KEY"
-BPE_SECRET_KEY="SECRET"
-BPE_MODE="test"
-BPE_DEBUG=true
-BPE_REPORT_ERROR=true
+# Buckaroo API Credentials
+BUCKAROO_STORE_KEY=your_store_key_here
+BUCKAROO_SECRET_KEY=your_secret_key_here
 
-BPE_EXAMPLE_BASE_URL="https://example.com/buckaroo/"
-BPE_EXAMPLE_RETURN_URL="${BPE_EXAMPLE_BASE_URL}return"
-BPE_EXAMPLE_PUSH_URL="${BPE_EXAMPLE_BASE_URL}push"
-BPE_EXAMPLE_IP="127.0.0.1"
-BPE_EXAMPLE_CURRENCY_CODE="EUR"
+# Logging Configuration (optional)
+BUCKAROO_LOG_LEVEL=DEBUG
+BUCKAROO_LOG_DESTINATION=both
+BUCKAROO_LOG_FILE=buckaroo_sdk.log
+BUCKAROO_LOG_MASK_SENSITIVE=true
+
+# Copy this file to .env and fill in your actual credentials:
+# cp .env.example .env

.gitattributes

@@ -0,0 +1,3 @@
+# Normalize line endings to LF on checkout + commit regardless of host platform.
+* text=auto eol=lf
+*.py text eol=lf

.github/workflows/codestyle.yml

@@ -0,0 +1,33 @@
+name: Code Style
+
+on:
+  pull_request:
+
+concurrency:
+  group: codestyle-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+
+    name: Ruff
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+
+      - name: Install Ruff
+        run: pip install ruff
+
+      - name: Run Ruff check
+        run: ruff check .
+
+      - name: Run Ruff format check
+        run: ruff format --check .

.github/workflows/publish.yml

@@ -0,0 +1,79 @@
+name: Publish
+
+on:
+  push:
+    tags: ["v*"]
+  workflow_dispatch:
+    inputs:
+      target:
+        description: Target repository
+        required: true
+        default: testpypi
+        type: choice
+        options:
+          - testpypi
+          - pypi
+
+concurrency:
+  group: publish-${{ github.ref }}
+  cancel-in-progress: false
+
+jobs:
+  build:
+    name: Build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+          cache: pip
+
+      - name: Install build tooling
+        run: pip install --upgrade build twine
+
+      - name: Build sdist + wheel
+        run: python -m build
+
+      - name: Verify metadata
+        run: twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+          if-no-files-found: error
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    if: github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && inputs.target == 'pypi')
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    needs: build
+    if: github.event_name == 'workflow_dispatch' && inputs.target == 'testpypi'
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

.github/workflows/tests.yml

@@ -0,0 +1,37 @@
+name: Tests
+
+on:
+  pull_request:
+
+concurrency:
+  group: tests-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+
+    name: Python ${{ matrix.python-version }}
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements-dev.txt
+          pip install -e .
+
+      - name: Run tests
+        run: pytest --cov=buckaroo --cov-report=term-missing

.gitignore

@@ -1,5 +1,19 @@
-Dockerfile
-docker-compose.yml
-.mypy_cache/
-.venv/
-*__pycache__/
+# build artifacts
+/build
+/dist
+/*.egg-info
+*.egg-info/
+/.eggs
+
+# test and local dev artifacts
+/.pytest_cache
+/.coverage
+htmlcov/
+.tox/
+/.idea
+.DS_Store
+__pycache__/
+*.pyc
+.env
+
+*.log

CHANGELOG.md

@@ -0,0 +1,53 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+---
+
+## [Released]
+
+## [0.1.0]
+- BA-510 Initial setup
+- BTI-9 Core SDK setup
+- BTI-10 Buckaroo API integration
+- BTI-11 Specific payment model
+- BTI-13 Documentation
+- BTI-14 Webhook / PUSH handler
+- BTI-15 Unit testing
+- BTI-841 Add a test suite
+- BA-992 Add payment method: Alipay
+- BA-993 Add payment method: Apple Pay
+- BA-994 Add payment method: Bancontact
+- BA-995 Add payment method: Belfius
+- BA-996 Add payment method: Billink
+- BA-999 Add payment method: Bizum
+- BA-1000 Add payment method: Blik
+- BA-1001 Add payment method: Buckaroo Voucher
+- BA-1002 Add payment method: Click to Pay
+- BA-1003 Add payment method: Creditcards
+- BA-1004 Add payment method: EPS
+- BA-1005 Add payment method: Giftcards
+- BA-1006 Add payment method: goSettle
+- BA-1007 Add payment method: Google Pay
+- BA-1008 Add payment method: External Payment
+- BA-1009 Add payment method: iDEAL | Wero
+- BA-1010 Add payment method: iDEAL | Wero QR
+- BA-1011 Add payment method: In3
+- BA-1012 Add payment method: KBC
+- BA-1013 Add payment method: Klarna KP
+- BA-1014 Add payment method: Klarna
+- BA-1015 Add payment method: MB Way
+- BA-1016 Add payment method: Multibanco
+- BA-1017 Add payment method: Pay by Bank
+- BA-1018 Add payment method: Payconiq
+- BA-1019 Add payment method: PayPal
+- BA-1020 Add payment method: Przelewy24
+- BA-1021 Add payment method: Riverty
+- BA-1022 Add payment method: Sepa Direct Debit
+- BA-1023 Add payment method: Swish
+- BA-1024 Add payment method: Transfer
+- BA-1025 Add payment method: Trustly
+- BA-1026 Add payment method: Twint
+- BA-1027 Add payment method: Wero
+- BA-1028 Add payment method: WeChat Pay
+- BA-1029 Add payment method: Vouchers

CONTRIBUTING.md

@@ -0,0 +1,21 @@
+# Contribution Guidelines
+
+### Repository setup:
+- Fork the repository to your account
+- more details about [how to fork a repo](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo) can be found [here](https://docs.github.com/en/github/getting-started-with-github/fork-a-repo):
+
+### Making changes:
+- create a branch from develop branch
+- name of the branch shoul be something like: `feature/GITHUB-ISSUE-ID-slug` (eg: `feature/50-configprovider-update`)
+- including unit tests is encouraged
+
+### Pull Request:
+- open the PR to develop branch
+- if there is no issue referenced, add a description about the problem and the way it is being solved
+- Allow edits from maintainers
+
+
+### Contribution to refactoring:
+- include unit tests
+- open the Pull Request
+- check that git workflows checks have passed

LICENSE → LICENSE.txt

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 Buckaroo
+Copyright (c) 2025 Buckaroo
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE.txt
+include CHANGELOG.md
+include CONTRIBUTING.md
+include requirements.txt
+recursive-include buckaroo *.py py.typed
+global-exclude __pycache__
+global-exclude *.pyc