pypaystack2 2.1.1__tar.gz → 3.0.0__tar.gz

pypaystack2-3.0.0/.github/workflows/documentation-release.yml

@@ -0,0 +1,32 @@
+name: Generate [version] documentation
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Deploy docs to GitHub Pages
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+          fetch-depth: 0
+      - uses: astral-sh/setup-uv@v1
+        with:
+          version: "latest"
+      - name: Install dependencies
+        run: uv sync -p 3.10
+      - name: Setup doc deploy
+        run: |
+          git config --global user.name Docs deploy
+          git config --global user.email docs@dummy.bot.com
+      - name: Set release notes tag
+        run: |
+          export RELEASE_TAG_VERSION="${{ github.event.release.tag_name }}"
+          echo RELEASE_TAG_VERSION="${RELEASE_TAG_VERSION:1}" >> "$GITHUB_ENV"
+      - name: Build docs website
+        run: uv run mike deploy "${RELEASE_TAG_VERSION}" --push

pypaystack2-3.0.0/.github/workflows/publish.yml

@@ -0,0 +1,25 @@
+name: Publish Pypaystack2 [version] to PYPI
+
+on:
+  release:
+    types: [ "published" ]
+
+jobs:
+  run:
+    name: "Build and publish release"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install uv
+        uses: astral-sh/setup-uv@v3
+        with:
+          enable-cache: true
+          cache-dependency-glob: uv.lock
+      - name: Set up Python
+        run: uv python install 3.12  # Or whatever version I want to use.
+
+      - name: Build
+        run: uv build
+
+      - name: Publish
+        run: uv publish -t ${{ secrets.PYPI_TOKEN }}

{pypaystack2-2.1.1 → pypaystack2-3.0.0}/.github/workflows/python-package.yml

@@ -1,7 +1,7 @@
 # This workflow will install Python dependencies, run tests and lint with a variety of Python versions
 # For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
 
-name: pypaystack2 package test
+name: Pypaystack2 Linting,Formatting and Testing
 
 on:
   push:
@@ -10,33 +10,31 @@ on:
     branches: [ "main" ]
 
 env:
-  PAYSTACK_AUTHORIZATION_KEY: ${{ secrets.PAYSTACK_AUTHORIZATION_KEY }}
+  PAYSTACK_SECRET_KEY: ${{ secrets.PAYSTACK_SECRET_KEY }}
 
 jobs:
-  build:
+  test:
 
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        python-version: [ "3.9","3.10", "3.11","3.12" ]
+        python-version: [ "3.11","3.12", "3.13" ]
 
     steps:
       - uses: actions/checkout@v3
       - name: Set up Python ${{ matrix.python-version }}
-        uses: actions/setup-python@v3
+        uses: actions/setup-python@v4
         with:
           python-version: ${{ matrix.python-version }}
-      - name: Install dependencies
-        run: |
-          python -m pip install --upgrade pip
-          python -m pip install -r requirements.txt
+      - uses: astral-sh/setup-uv@v1
+        with:
+          version: "latest"
+      - name: Install dependencies with uv
+        run: uv sync -p ${{ matrix.python-version }}
       - name: Format with ruff
-        run: |
-          ruff format .
+        run: uv run ruff format .
       - name: Lint with ruff
-        run: |
-          ruff check . --fix
+        run: uv run ruff check . --fix
       - name: Test package
-        run: |
-          pytest
+        run: uv run pytest

pypaystack2-3.0.0/.pre-commit-config.yaml

@@ -0,0 +1,19 @@
+# See https://pre-commit.com for more information
+# See https://pre-commit.com/hooks.html for more hooks
+repos:
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: end-of-file-fixer
+      - id: check-yaml
+      - id: check-added-large-files
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    # Ruff version.
+    rev: v0.9.9
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format

pypaystack2-3.0.0/.python-version

@@ -0,0 +1 @@
+3.11

{pypaystack2-2.1.1 → pypaystack2-3.0.0}/CHANGELOG.md

@@ -7,7 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## unreleased
 
-## [2.1.1] - 2024-12-09
+## [3.0.0] - 2025-03-
+
+### Added
+
+- Pydantic v2 to project dependencies.
+- Utility methods for fees calculation `calculate_fee`, `to_base_unit`, `to_subunit`.
+- `ClientNetworkError`. An exception raised for all network related errors.
+
+### Changed
+
+- `auth_key` parameter to `secret_key`.
+- secret key environmental variable name from `PAYSTACK_AUTHORIZATION_KEY` to `PAYSTACK_SECRET_KEY`
+- `MissingAuthKeyException` to  `MissingSecretKeyException`
+- Rename wrappers to clients. All usages of wrappers are now deprecated in favour of clients.
+  `Paystack` wrapper class in the past is now `PaystackClient` likewise all other api wrappers
+  are now sub clients e.g. `ApplePay` is now  `ApplePayClient`
+
+### Fixed
+
+- Unused `amount` parameter in `TransactionClient.export`
+
+### Removed
+
+- Support for `python<=3.10`
+- Package defined `HTTPMethod` enum. Now using `HTTPMethod` from the standard lib.
+- `validate_amount` and `validate_interval` helper methods
+- `InvalidMethodException`, `InvalidDataException`
+
+## [2.1.1] - (9th December 2024)
 
 ### Added
 
@@ -22,7 +50,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Charge.setAddress -> Charge.submitAddress
 
-## [2.1.0] - 2024-10-08
+## [2.1.0] - (8th October 2024)
 
 ### Added
 
@@ -58,7 +86,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Redundant payload from Subscription.send_update_link
 - Redundant payload from AsyncSubscription.send_update_link
 
-## [2.0.3] - 2024-03-24
+## [2.0.3] - (24th March 2024)
 
 ### Added
 
@@ -71,7 +99,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   `Response` with the `data` parameter containing a `content` field with the bytes content returned.
 - Mismatched source code and documentation links in docs
 
-## [2.0.2] - 2023-12-01
+## [2.0.2] - (1st December 2023)
 
 ### Added
 
@@ -91,13 +119,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Broken docstrings API reference documentation links
 
-## [2.0.1] - 2023-07-27
+## [2.0.1] - (27th July 2023)
 
 ### Changed
 
 - Refactor project internals
 
-## [2.0.0] - 2023-05-18
+## [2.0.0] - (18th May 2023)
 
 ### Added
 
@@ -108,25 +136,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Use `httpx` in place of `requests`
 
-## [1.1.3] - 2023-03-10
+## [1.1.3] - (10th March 2023)
 
 ### Added
 
 - `Paystack` class which had bindings to other wrappers
 
-## [1.0.3] - 2022-12-26
+## [1.0.3] - (26th December 2022)
 
 ### Added
 
 - Cleanup documentation
 
-## [1.0.2] - 2022-12-25
+## [1.0.2] - (25th December 2022)
 
 ### Added
 
 - Implement additional wrappers to cover all endpoints provided by paystack
 
-## [1.0.0] - 2022-07-25
+## [1.0.0] - (25th July 2022)
 
 ### Added
 
@@ -136,7 +164,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Breaks projects were it is added as a dependency
 
-[unreleased]: https://github.com/gray-adeyi/pypaystack2/compare/v2.0.3...HEAD
+[unreleased]: https://github.com/gray-adeyi/pypaystack2/compare/v2.1.1...HEAD
+
+[2.1.1]: https://github.com/gray-adeyi/pypaystack2/compare/v2.1.0...v2.1.1
+
+[2.1.0]: https://github.com/gray-adeyi/pypaystack2/compare/v2.0.3...v2.1.0
 
 [2.0.3]: https://github.com/gray-adeyi/pypaystack2/compare/v2.0.2...v2.0.3
 
@@ -144,8 +176,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 [2.0.1]: https://github.com/gray-adeyi/pypaystack2/compare/v2.0.0...v2.0.1
 
+[2.0.0]: https://github.com/gray-adeyi/pypaystack2/compare/v1.1.3...v2.0.0
+
 [1.1.3]: https://github.com/gray-adeyi/pypaystack2/compare/v1.0.3...v1.1.3
 
 [1.0.3]: https://github.com/gray-adeyi/pypaystack2/compare/v1.0.2...v1.0.3
 
 [1.0.2]: https://github.com/gray-adeyi/pypaystack2/compare/v1.0.0...v1.0.2
+
+[1.0.0]: https://github.com/gray-adeyi/pypaystack2/releases/tag/v1.0.0

pypaystack2-3.0.0/PKG-INFO

@@ -0,0 +1,164 @@
+Metadata-Version: 2.4
+Name: pypaystack2
+Version: 3.0.0
+Summary: A developer-friendly client library for Paystack
+Author-email: Gbenga Adeyi <adeyigbenga005@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: paystack,paystack-python,paystackapi,pypaystack
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.11
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: pydantic>=2.10.6
+Description-Content-Type: text/markdown
+
+# PyPaystack2
+
+[![Downloads](https://static.pepy.tech/badge/pypaystack2)](https://pepy.tech/project/pypaystack2)
+[![Downloads](https://static.pepy.tech/badge/pypaystack2/month)](https://pepy.tech/project/pypaystack2)
+[![Downloads](https://static.pepy.tech/badge/pypaystack2/week)](https://pepy.tech/project/pypaystack2)
+
+PyPaystack2 is an Open Source Python client library for integrating [Paystack](https://paystack.com/) into your python
+projects. It aims at being developer friendly and easy to use.
+
+**Version 3 is here now**
+
+## Features
+
+- 1st class support for type annotations.
+- Synchronous and Asynchronous clients.
+- Pydantic for data modelling.
+- Fees Calculation utilities.
+
+## Installation
+
+```bash
+$ pip install -U pypaystack2
+# or install with uv
+$ uv add pypaystack2
+```
+
+## Usage Preview
+
+In the REPL session below, we're using PyPaystack2 to create a `Customer` (user) and a `Plan` on
+[Paystack](https://paystack.com/) and then add the newly created customer as a subscriber to the plan.
+
+### Note
+
+The REPL session below assumes the environmental variable `PAYSTACK_SECRET_KEY="YOUR_SECRET_KEY"` is set. if not,
+you can alternatively pass it into the `PaystackClient` on instantiation like so
+`PaystackClient(secret_key='YOUR_SECRET_KEY')` otherwise, you will get a `MissingSecretKeyException` raised prompting
+you to provide a secret key. It also does not handle likely exceptions that calling client methods like
+`client.customers.create`, `client.plans.create` & `client.subscriptions.create` may raise like `ClientNetworkError`
+for network related issues and `ValueError` for validation related issues.
+
+```bash
+Python 3.11.11 (main, Feb 12 2025, 14:51:05) [Clang 19.1.6 ] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>> from pypaystack2 import __version__
+>>> print(__version__)
+3.0.0 # Ensure you're running PyPaystack2 version >= 3.0.0 for the following entries to work
+>>> from pypaystack2 import PaystackClient
+>>> from pypaystack2.enums import Interval
+>>> from pypaystack2.models import Customer, Plan
+>>> client = PaystackClient()
+>>> new_customer_response = client.customers.create(email="johndoe@example.com",first_name="John",last_name="Doe")
+>>> assert new_customer_response.status # Validating the request is successful
+>>> new_customer = new_customer_response.data
+>>> assert isinstance(new_customer,Customer) # Showing that we indeed get an instance of a pydantic model name `Customer` a modelled representation of the data returned by paystack as a result of the request to create a new user
+>>> new_plan_response = client.plans.create(name="Test 1k Daily Contributions", amount=client.to_subunit(1000), interval=Interval.DAILY)
+>>> assert new_plan_response.status # Validating the request is successful
+>>> new_plan = new_plan_response.data # Validating the request is successful
+>>> assert isinstance(new_plan,Plan)
+>>> new_subscription_response = client.subscriptions.create(customer=new_customer.customer_code,plan=new_plan.plan_code)
+>>> assert new_subscription_response.status == True # Validating the request is successful
+>>> print(repr(new_subscription_response))
+Response(
+  status_code=<HTTPStatus.OK: 200>,
+  status=True,
+  message='Subscription successfully created',
+  data=Subscription(
+    customer=87934333,
+    plan=2237384,
+    integration=630606,
+    domain=<Domain.TEST: 'test'>,
+    start=1741208073,
+    status='active',
+    quantity=1,
+    amount=100000,
+    subscription_code='SUB_4sje2s7kb30m5bt',
+    email_token='uqzg0vneparuxtm',
+    authorization=368220905,
+    easy_cron_id=None,
+    cron_expression='54 20 5 3 *',
+    next_payment_date=datetime.datetime(2026, 3, 5, 20, 54, tzinfo=TzInfo(UTC)),
+    open_invoice=None,
+    invoice_limit=0,
+    id=759264,
+    split_code=None,
+    cancelled_at=None,
+    updated_at=datetime.datetime(2025, 3, 5, 20, 54, 33, tzinfo=TzInfo(UTC)),
+    payments_count=None,
+    most_recent_invoice=None,
+    invoices=None,
+    invoice_history=None),
+  meta=None,
+  type=None,
+  code=None,
+  raw={
+    'status': True,
+    'message': 'Subscription successfully created',
+    'data': {
+      'customer': 87934333,
+      'plan': 2237384,
+      'integration': 630606,
+      'domain': 'test',
+      'start': 1741208073,
+      'status': 'active',
+      'quantity': 1,
+      'amount': 100000,
+      'authorization': 368220905,
+      'invoice_limit': 0,
+      'split_code': None,
+      'metadata': None,
+      'subscription_code': 'SUB_4sje2s7kb30m5bt',
+      'email_token': 'uqzg0vneparuxtm',
+      'id': 759264,
+      'cancelledAt': None,
+      'createdAt': '2025-03-05T20:54:33.000Z',
+      'updatedAt': '2025-03-05T20:54:33.000Z',
+      'cron_expression': '54 20 5 3 *',
+      'next_payment_date': '2026-03-05T20:54:00.000Z',
+      'easy_cron_id': None,
+      'open_invoice': None}
+    })
+```
+
+## Documentation
+
+See [Documentation](https://gray-adeyi.github.io/pypaystack2/) for more on this package.
+
+## Disclaimer
+
+This project is an Open Source client library for [Paystack](https://paystack.com/). It is not officially endorsed or
+affiliated with [Paystack](https://paystack.com/). All trademarks and company names belong to their respective owners.
+
+## Contributions
+
+Thank you for being interested in contributing to PyPaystack2.
+There are many ways you can contribute to the project:
+
+- [Star on GitHub](https://github.com/gray-adeyi/pypaystack2/)
+- Try PyPaystack2 and [report bugs/issues you find](https://github.com/gray-adeyi/pypaystack2/issues/new)
+- [Buy me a coffee](https://www.buymeacoffee.com/jigani)
+
+## Other Related Projects
+
+| Name                                                                               | Language              | Functionality                                                                    |
+|------------------------------------------------------------------------------------|-----------------------|----------------------------------------------------------------------------------|
+| [Paystack CLI](https://pypi.org/project/paystack-cli/)                             | Python                | A command line app for interacting with paystack APIs                            |
+| [paystack](https://github.com/gray-adeyi/paystack)                                 | Go                    | A client library for integration paystack in go                                  |
+| [@gray-adeyi/paystack-sdk](https://www.npmjs.com/package/@gray-adeyi/paystack-sdk) | Typescript/Javascript | A client library for integrating paystack in Javascript runtimes (Node,Deno,Bun) |
+| [paystack](https://pub.dev/packages/paystack)                                      | Dart                  | A client library for integration paystack in Dart                                |

pypaystack2-3.0.0/README.md

@@ -0,0 +1,148 @@
+# PyPaystack2
+
+[![Downloads](https://static.pepy.tech/badge/pypaystack2)](https://pepy.tech/project/pypaystack2)
+[![Downloads](https://static.pepy.tech/badge/pypaystack2/month)](https://pepy.tech/project/pypaystack2)
+[![Downloads](https://static.pepy.tech/badge/pypaystack2/week)](https://pepy.tech/project/pypaystack2)
+
+PyPaystack2 is an Open Source Python client library for integrating [Paystack](https://paystack.com/) into your python
+projects. It aims at being developer friendly and easy to use.
+
+**Version 3 is here now**
+
+## Features
+
+- 1st class support for type annotations.
+- Synchronous and Asynchronous clients.
+- Pydantic for data modelling.
+- Fees Calculation utilities.
+
+## Installation
+
+```bash
+$ pip install -U pypaystack2
+# or install with uv
+$ uv add pypaystack2
+```
+
+## Usage Preview
+
+In the REPL session below, we're using PyPaystack2 to create a `Customer` (user) and a `Plan` on
+[Paystack](https://paystack.com/) and then add the newly created customer as a subscriber to the plan.
+
+### Note
+
+The REPL session below assumes the environmental variable `PAYSTACK_SECRET_KEY="YOUR_SECRET_KEY"` is set. if not,
+you can alternatively pass it into the `PaystackClient` on instantiation like so
+`PaystackClient(secret_key='YOUR_SECRET_KEY')` otherwise, you will get a `MissingSecretKeyException` raised prompting
+you to provide a secret key. It also does not handle likely exceptions that calling client methods like
+`client.customers.create`, `client.plans.create` & `client.subscriptions.create` may raise like `ClientNetworkError`
+for network related issues and `ValueError` for validation related issues.
+
+```bash
+Python 3.11.11 (main, Feb 12 2025, 14:51:05) [Clang 19.1.6 ] on linux
+Type "help", "copyright", "credits" or "license" for more information.
+>>> from pypaystack2 import __version__
+>>> print(__version__)
+3.0.0 # Ensure you're running PyPaystack2 version >= 3.0.0 for the following entries to work
+>>> from pypaystack2 import PaystackClient
+>>> from pypaystack2.enums import Interval
+>>> from pypaystack2.models import Customer, Plan
+>>> client = PaystackClient()
+>>> new_customer_response = client.customers.create(email="johndoe@example.com",first_name="John",last_name="Doe")
+>>> assert new_customer_response.status # Validating the request is successful
+>>> new_customer = new_customer_response.data
+>>> assert isinstance(new_customer,Customer) # Showing that we indeed get an instance of a pydantic model name `Customer` a modelled representation of the data returned by paystack as a result of the request to create a new user
+>>> new_plan_response = client.plans.create(name="Test 1k Daily Contributions", amount=client.to_subunit(1000), interval=Interval.DAILY)
+>>> assert new_plan_response.status # Validating the request is successful
+>>> new_plan = new_plan_response.data # Validating the request is successful
+>>> assert isinstance(new_plan,Plan)
+>>> new_subscription_response = client.subscriptions.create(customer=new_customer.customer_code,plan=new_plan.plan_code)
+>>> assert new_subscription_response.status == True # Validating the request is successful
+>>> print(repr(new_subscription_response))
+Response(
+  status_code=<HTTPStatus.OK: 200>,
+  status=True,
+  message='Subscription successfully created',
+  data=Subscription(
+    customer=87934333,
+    plan=2237384,
+    integration=630606,
+    domain=<Domain.TEST: 'test'>,
+    start=1741208073,
+    status='active',
+    quantity=1,
+    amount=100000,
+    subscription_code='SUB_4sje2s7kb30m5bt',
+    email_token='uqzg0vneparuxtm',
+    authorization=368220905,
+    easy_cron_id=None,
+    cron_expression='54 20 5 3 *',
+    next_payment_date=datetime.datetime(2026, 3, 5, 20, 54, tzinfo=TzInfo(UTC)),
+    open_invoice=None,
+    invoice_limit=0,
+    id=759264,
+    split_code=None,
+    cancelled_at=None,
+    updated_at=datetime.datetime(2025, 3, 5, 20, 54, 33, tzinfo=TzInfo(UTC)),
+    payments_count=None,
+    most_recent_invoice=None,
+    invoices=None,
+    invoice_history=None),
+  meta=None,
+  type=None,
+  code=None,
+  raw={
+    'status': True,
+    'message': 'Subscription successfully created',
+    'data': {
+      'customer': 87934333,
+      'plan': 2237384,
+      'integration': 630606,
+      'domain': 'test',
+      'start': 1741208073,
+      'status': 'active',
+      'quantity': 1,
+      'amount': 100000,
+      'authorization': 368220905,
+      'invoice_limit': 0,
+      'split_code': None,
+      'metadata': None,
+      'subscription_code': 'SUB_4sje2s7kb30m5bt',
+      'email_token': 'uqzg0vneparuxtm',
+      'id': 759264,
+      'cancelledAt': None,
+      'createdAt': '2025-03-05T20:54:33.000Z',
+      'updatedAt': '2025-03-05T20:54:33.000Z',
+      'cron_expression': '54 20 5 3 *',
+      'next_payment_date': '2026-03-05T20:54:00.000Z',
+      'easy_cron_id': None,
+      'open_invoice': None}
+    })
+```
+
+## Documentation
+
+See [Documentation](https://gray-adeyi.github.io/pypaystack2/) for more on this package.
+
+## Disclaimer
+
+This project is an Open Source client library for [Paystack](https://paystack.com/). It is not officially endorsed or
+affiliated with [Paystack](https://paystack.com/). All trademarks and company names belong to their respective owners.
+
+## Contributions
+
+Thank you for being interested in contributing to PyPaystack2.
+There are many ways you can contribute to the project:
+
+- [Star on GitHub](https://github.com/gray-adeyi/pypaystack2/)
+- Try PyPaystack2 and [report bugs/issues you find](https://github.com/gray-adeyi/pypaystack2/issues/new)
+- [Buy me a coffee](https://www.buymeacoffee.com/jigani)
+
+## Other Related Projects
+
+| Name                                                                               | Language              | Functionality                                                                    |
+|------------------------------------------------------------------------------------|-----------------------|----------------------------------------------------------------------------------|
+| [Paystack CLI](https://pypi.org/project/paystack-cli/)                             | Python                | A command line app for interacting with paystack APIs                            |
+| [paystack](https://github.com/gray-adeyi/paystack)                                 | Go                    | A client library for integration paystack in go                                  |
+| [@gray-adeyi/paystack-sdk](https://www.npmjs.com/package/@gray-adeyi/paystack-sdk) | Typescript/Javascript | A client library for integrating paystack in Javascript runtimes (Node,Deno,Bun) |
+| [paystack](https://pub.dev/packages/paystack)                                      | Dart                  | A client library for integration paystack in Dart                                |

pypaystack2-3.0.0/docs/how-to-guides.md

@@ -0,0 +1,3 @@
+# How to guide
+
+Coming soon.