Skip to content

Commit 6b01275

Browse files
Wilfried-TechWilfried-Tech
committed
initial release of notchpay v0.1.0 – full-featured unofficial Python SDK
- Add complete synchronous and asynchronous clients (NotchPay & AsyncNotchPay) - Implement all core resources: payments, customers, beneficiaries, transfers (incl. bulk), channels, balance, and webhooks - Provide comprehensive Pydantic schemas with full type hints and validation - Add detailed docstrings, examples, and inline documentation - Implement robust error handling (NotchPayError hierarchy) - Add webhook signature verification utility - Introduce convenient helpers (direct_charge, payment processing, etc.) - Set up modern packaging with pyproject.toml (uv build backend) - Include full test suite with sync/async coverage for all endpoints - Add comprehensive README and project metadata - Configure mypy, pytest, and coverage settings
0 parents  commit 6b01275

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+7693
-0
lines changed

‎.github/workflows/release.yml‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
name: Release and Publish
2+
3+
on:
4+
push:
5+
branches:
6+
- "releases/**"
7+
8+
env:
9+
PYTHON_VERSION: "3.9"
10+
11+
jobs:
12+
release:
13+
runs-on: ubuntu-latest
14+
environment:
15+
name: pypi
16+
permissions:
17+
contents: write
18+
id-token: write
19+
steps:
20+
- name: Checkout code
21+
uses: actions/checkout@v4
22+
with:
23+
fetch-depth: 0
24+
25+
- name: Extract version from branch name
26+
run: |
27+
BRANCH_NAME="${GITHUB_REF#refs/heads/}"
28+
VERSION="${BRANCH_NAME#releases/}"
29+
echo "PACKAGE_VERSION=$VERSION" >> $GITHUB_ENV
30+
echo "Branch version: $VERSION"
31+
32+
- name: Extract version from pyproject.toml
33+
run: |
34+
TOML_VERSION=$(grep -E '^version = ' pyproject.toml | sed -E 's/version = "(.*)"/\1/')
35+
echo "TOML_VERSION=$TOML_VERSION" >> $GITHUB_ENV
36+
echo "TOML version: $TOML_VERSION"
37+
38+
- name: Extract version from __init__.py
39+
run: |
40+
INIT_VERSION=$(grep -E '^__version__ = ' src/notchpay/__init__.py | sed -E 's/__version__ = "(.*)"/\1/')
41+
echo "INIT_VERSION=$INIT_VERSION" >> $GITHUB_ENV
42+
echo "__init__.py version: $INIT_VERSION"
43+
44+
- name: Install uv
45+
uses: astral-sh/setup-uv@v7
46+
with:
47+
enable-cache: true
48+
49+
- name: Set up Python
50+
run: uv python install
51+
52+
- name: Verify versions match
53+
run: |
54+
if [ "${{ env.TOML_VERSION }}" != "${{ env.PACKAGE_VERSION }}" ]; then
55+
echo "❌ Version mismatch: branch=${{ env.PACKAGE_VERSION }}, pyproject.toml=${{ env.TOML_VERSION }}"
56+
exit 1
57+
fi
58+
if [ "${{ env.INIT_VERSION }}" != "${{ env.PACKAGE_VERSION }}" ]; then
59+
echo "❌ Version mismatch: branch=${{ env.PACKAGE_VERSION }}, __init__.py=${{ env.INIT_VERSION }}"
60+
exit 1
61+
fi
62+
echo "✅ All versions match: ${{ env.PACKAGE_VERSION }}"
63+
64+
- name: Install the project
65+
run: uv sync --locked --all-extras --dev
66+
67+
- name: Build package
68+
run: uv build
69+
70+
- name: Upload wheel artifact
71+
uses: actions/upload-artifact@v4
72+
with:
73+
name: wheel-package
74+
path: dist/*.whl
75+
76+
- name: Upload source distribution artifact
77+
uses: actions/upload-artifact@v4
78+
with:
79+
name: source-distribution
80+
path: dist/*.tar.gz
81+
82+
- name: Create GitHub Release
83+
if: startsWith(github.ref, 'refs/heads/releases/')
84+
uses: softprops/action-gh-release@v2
85+
with:
86+
files: |
87+
dist/*.whl
88+
dist/*.tar.gz
89+
token: ${{ secrets.GITHUB_TOKEN }}
90+
name: "Release v${{ env.PACKAGE_VERSION }}"
91+
body: |
92+
## 🚀 Release v${{ env.PACKAGE_VERSION }}
93+
94+
### 📝 Latest Changes
95+
${{ github.event.head_commit.message }}
96+
97+
### 📦 Installation
98+
```bash
99+
pip install notchpay==${{ env.PACKAGE_VERSION }}
100+
```
101+
102+
### 🔗 Links
103+
- [Documentation](https://developer.notchpay.co/sdks/python)
104+
- [PyPI Package](https://pypi.org/project/notchpay/${{ env.PACKAGE_VERSION }}/)
105+
- [Changelog](https://github.com/${{ github.repository }}/blob/master/CHANGELOG.md)
106+
tag_name: "v${{ env.PACKAGE_VERSION }}"
107+
draft: false
108+
prerelease: false
109+
110+
- name: Publish to PyPI
111+
if: startsWith(github.ref, 'refs/heads/releases/')
112+
env:
113+
UV_PUBLISH_TOKEN: ${{ secrets.PYPI_API_TOKEN }}
114+
run: uv publish --token $UV_PUBLISH_TOKEN
115+
116+
- name: Delete release branch
117+
if: startsWith(github.ref, 'refs/heads/releases/')
118+
run: |
119+
BRANCH_NAME=${GITHUB_REF#refs/heads/}
120+
git push origin --delete $BRANCH_NAME

‎.gitignore‎

Lines changed: 211 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,211 @@
1+
# Byte-compiled / optimized / DLL files
2+
__pycache__/
3+
*.py[codz]
4+
*$py.class
5+
6+
# C extensions
7+
*.so
8+
9+
# Distribution / packaging
10+
.Python
11+
build/
12+
develop-eggs/
13+
dist/
14+
downloads/
15+
eggs/
16+
.eggs/
17+
lib/
18+
lib64/
19+
parts/
20+
sdist/
21+
var/
22+
wheels/
23+
share/python-wheels/
24+
*.egg-info/
25+
.installed.cfg
26+
*.egg
27+
MANIFEST
28+
29+
# PyInstaller
30+
# Usually these files are written by a python script from a template
31+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
32+
*.manifest
33+
*.spec
34+
35+
# Installer logs
36+
pip-log.txt
37+
pip-delete-this-directory.txt
38+
39+
# Unit test / coverage reports
40+
htmlcov/
41+
.tox/
42+
.nox/
43+
.coverage
44+
.coverage.*
45+
.cache
46+
nosetests.xml
47+
coverage.xml
48+
*.cover
49+
*.py.cover
50+
.hypothesis/
51+
.pytest_cache/
52+
cover/
53+
54+
# Translations
55+
*.mo
56+
*.pot
57+
58+
# Django stuff:
59+
*.log
60+
local_settings.py
61+
db.sqlite3
62+
db.sqlite3-journal
63+
64+
# Flask stuff:
65+
instance/
66+
.webassets-cache
67+
68+
# Scrapy stuff:
69+
.scrapy
70+
71+
# Sphinx documentation
72+
docs/_build/
73+
74+
# PyBuilder
75+
.pybuilder/
76+
target/
77+
78+
# Jupyter Notebook
79+
.ipynb_checkpoints
80+
81+
# IPython
82+
profile_default/
83+
ipython_config.py
84+
85+
# pyenv
86+
# For a library or package, you might want to ignore these files since the code is
87+
# intended to run in multiple environments; otherwise, check them in:
88+
# .python-version
89+
90+
# pipenv
91+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
92+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
93+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
94+
# install all needed dependencies.
95+
#Pipfile.lock
96+
97+
# UV
98+
# Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
99+
# This is especially recommended for binary packages to ensure reproducibility, and is more
100+
# commonly ignored for libraries.
101+
#uv.lock
102+
103+
# poetry
104+
# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
105+
# This is especially recommended for binary packages to ensure reproducibility, and is more
106+
# commonly ignored for libraries.
107+
# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
108+
#poetry.lock
109+
#poetry.toml
110+
111+
# pdm
112+
# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
113+
# pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
114+
# https://pdm-project.org/en/latest/usage/project/#working-with-version-control
115+
#pdm.lock
116+
#pdm.toml
117+
.pdm-python
118+
.pdm-build/
119+
120+
# pixi
121+
# Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
122+
#pixi.lock
123+
# Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
124+
# in the .venv directory. It is recommended not to include this directory in version control.
125+
.pixi
126+
127+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
128+
__pypackages__/
129+
130+
# Celery stuff
131+
celerybeat-schedule
132+
celerybeat.pid
133+
134+
# SageMath parsed files
135+
*.sage.py
136+
137+
# Environments
138+
.env
139+
.envrc
140+
.venv
141+
env/
142+
venv/
143+
ENV/
144+
env.bak/
145+
venv.bak/
146+
147+
# Spyder project settings
148+
.spyderproject
149+
.spyproject
150+
151+
# Rope project settings
152+
.ropeproject
153+
154+
# mkdocs documentation
155+
/site
156+
157+
# mypy
158+
.mypy_cache/
159+
.dmypy.json
160+
dmypy.json
161+
162+
# Pyre type checker
163+
.pyre/
164+
165+
# pytype static type analyzer
166+
.pytype/
167+
168+
# Cython debug symbols
169+
cython_debug/
170+
171+
# PyCharm
172+
# JetBrains specific template is maintained in a separate JetBrains.gitignore that can
173+
# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
174+
# and can be added to the global gitignore or merged into this file. For a more nuclear
175+
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
176+
.idea/
177+
178+
# Abstra
179+
# Abstra is an AI-powered process automation framework.
180+
# Ignore directories containing user credentials, local state, and settings.
181+
# Learn more at https://abstra.io/docs
182+
.abstra/
183+
184+
# Visual Studio Code
185+
# Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore
186+
# that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
187+
# and can be added to the global gitignore or merged into this file. However, if you prefer,
188+
# you could uncomment the following to ignore the entire vscode folder
189+
# .vscode/
190+
191+
# Ruff stuff:
192+
.ruff_cache/
193+
194+
# PyPI configuration file
195+
.pypirc
196+
197+
# Cursor
198+
# Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
199+
# exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
200+
# refer to https://docs.cursor.com/context/ignore-files
201+
.cursorignore
202+
.cursorindexingignore
203+
204+
# Marimo
205+
marimo/_static/
206+
marimo/_lsp/
207+
__marimo__/
208+
209+
openapi.yaml
210+
docs.txt
211+
llms.txt

‎.python-version‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
3.9

‎CHANGELOG.md‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
8+
## [0.1.0] - 2024-12-10
9+
10+
### Added
11+
12+
- Initial release of the Notch Pay Python SDK
13+
- Full support for Notch Pay API v2
14+
- Synchronous and asynchronous client implementations
15+
- Complete type safety with Pydantic models
16+
- Payment management (create, retrieve, list, cancel, process, direct charge)
17+
- Transfer management (create, retrieve, list, cancel)
18+
- Customer management (create, retrieve, update, list, delete, payments, payment methods)
19+
- Beneficiary management (create, retrieve, update, list, delete)
20+
- Balance retrieval
21+
- Webhook management (create, retrieve, update, list, delete)
22+
- Payment channel listing
23+
- Comprehensive error handling with custom exceptions
24+
- Full test coverage with pytest
25+
- Support for Python 3.9+
26+
27+
### Features
28+
29+
- **Payments API**: Initialize, retrieve, list, cancel, and process payments
30+
- **Transfers API**: Create and manage transfers to beneficiaries
31+
- **Customers API**: Manage customer profiles and payment methods
32+
- **Beneficiaries API**: Store and manage transfer beneficiaries
33+
- **Balance API**: Check account balance across currencies
34+
- **Webhooks API**: Configure webhook endpoints for event notifications
35+
- **Channels API**: Retrieve available payment channels by country
36+
- **Type Safety**: Full Pydantic model validation for requests and responses
37+
- **Async Support**: Native async/await support for modern Python frameworks
38+
- **Error Handling**: Detailed exceptions for validation, authentication, and API errors
39+
40+
### Documentation
41+
42+
- Comprehensive README with installation instructions
43+
- Quick start guide with common use cases
44+
- Framework integration examples (Django, Flask, FastAPI)
45+
- API reference with links to official documentation
46+
- Error handling guide
47+
- Webhook verification examples
48+
- Development setup instructions
49+
50+
---
51+
52+
[0.1.0]: https://github.com/Wilfried-Tech/notchpay-python/releases/tag/v0.1.0

0 commit comments

Comments
 (0)