mtnmomo-py 0.1.0__tar.gz

mtnmomo_py-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,68 @@
+name: Test, Build, and Publish
+
+on:
+  push:
+    tags:
+      - "*"
+
+permissions:
+  contents: read
+  id-token: write
+
+jobs:
+  test:
+    name: Test (Python ${{ matrix.python-version }})
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install package and test dependencies
+        run: python -m pip install --upgrade pip && python -m pip install -e ".[test]"
+      - name: Run unit tests
+        run: python -m pytest -m "not integration"
+
+  build:
+    name: Build distribution
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+      - name: Install build tooling
+        run: python -m pip install --upgrade pip build twine
+      - name: Build package
+        run: python -m build
+      - name: Verify distribution metadata
+        run: python -m twine check dist/*
+      - name: Upload distribution artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-distribution
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/mtnmomo-py
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distribution artifact
+        uses: actions/download-artifact@v4
+        with:
+          name: python-distribution
+          path: dist/
+      - name: Publish distribution to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

mtnmomo_py-0.1.0/.gitignore

@@ -0,0 +1,13 @@
+credentials.json
+.env
+.venv/
+venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.coverage
+coverage.xml
+htmlcov/
+build/
+dist/
+*.egg-info/

mtnmomo_py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Robin
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mtnmomo_py-0.1.0/PKG-INFO

@@ -0,0 +1,128 @@
+Metadata-Version: 2.4
+Name: mtnmomo-py
+Version: 0.1.0
+Summary: Typed synchronous client for the MTN MoMo APIs
+Project-URL: Homepage, https://github.com/robin-001/mtnmomo-py
+Project-URL: Repository, https://github.com/robin-001/mtnmomo-py.git
+Project-URL: Issues, https://github.com/robin-001/mtnmomo-py/issues
+Author: Robin
+License: MIT
+License-File: LICENSE
+Keywords: api-client,mobile-money,momo,mtn,payments
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Provides-Extra: test
+Requires-Dist: build<2,>=1.2; extra == 'test'
+Requires-Dist: pytest<9,>=8; extra == 'test'
+Requires-Dist: respx<1,>=0.21; extra == 'test'
+Description-Content-Type: text/markdown
+
+# mtnmomo-py
+
+`mtnmomo-py` is a synchronous Python 3.10+ client for the MTN MoMo Collection, Disbursement, OAuth/CIBA, and Sandbox Provisioning APIs.
+
+## Install
+
+```bash
+pip install mtnmomo-py
+```
+
+## Configure
+
+Supply credentials explicitly or through environment variables. Do not commit API keys, subscription keys, or `credentials.json`.
+
+```python
+from mtnmomo import MoMoClient, MoMoConfig, ProductCredentials
+
+config = MoMoConfig(
+    collection=ProductCredentials(
+        subscription_key="collection-subscription-key",
+        api_user="collection-api-user",
+        api_key="collection-api-key",
+    ),
+    disbursement=ProductCredentials(
+        subscription_key="disbursement-subscription-key",
+        api_user="disbursement-api-user",
+        api_key="disbursement-api-key",
+    ),
+    target_environment="sandbox",
+)
+
+with MoMoClient(config) as client:
+    balance = client.collection.get_account_balance()
+    print(balance.available_balance, balance.currency)
+```
+
+`MoMoConfig.from_env()` reads:
+
+- `MTN_MOMO_COLLECTION_SUBSCRIPTION_KEY`
+- `MTN_MOMO_COLLECTION_API_USER`
+- `MTN_MOMO_COLLECTION_API_KEY`
+- `MTN_MOMO_DISBURSEMENT_SUBSCRIPTION_KEY`
+- `MTN_MOMO_DISBURSEMENT_API_USER`
+- `MTN_MOMO_DISBURSEMENT_API_KEY`
+- `MTN_MOMO_TARGET_ENVIRONMENT` (defaults to `sandbox`)
+- `MTN_MOMO_BASE_URL` (defaults to the MTN sandbox URL)
+- `MTN_MOMO_TIMEOUT` (defaults to `30` seconds)
+
+## Collection example
+
+```python
+from mtnmomo import Party
+
+reference_id = client.collection.request_to_pay(
+    {
+        "amount": "100",
+        "currency": "EUR",
+        "externalId": "order-123",
+        "payer": Party("MSISDN", "46733123453"),
+        "payerMessage": "Order 123",
+        "payeeNote": "Order 123",
+    },
+    callback_url="https://merchant.example/momo/callback",
+)
+status = client.collection.get_request_to_pay_status(reference_id)
+```
+
+## Disbursement example
+
+```python
+reference_id = client.disbursement.transfer(
+    {
+        "amount": "100",
+        "currency": "EUR",
+        "externalId": "payout-123",
+        "payee": Party("MSISDN", "46733123453"),
+    },
+    callback_url="https://merchant.example/momo/callback",
+)
+```
+
+## Testing
+
+```bash
+pip install -e .[test]
+pytest
+```
+
+Tests are network-free by default. Safe sandbox token tests require explicit environment configuration and opt-in:
+
+```bash
+MTN_MOMO_RUN_INTEGRATION=1 pytest -m integration
+```
+
+State-changing sandbox operations remain mocked by default.
+
+## Publishing
+
+Build artifacts with `python -m build`; inspect them to confirm secrets are absent. Publish using a user-managed PyPI token or Trusted Publishing after testing the release on TestPyPI.

mtnmomo_py-0.1.0/README.md

@@ -0,0 +1,99 @@
+# mtnmomo-py
+
+`mtnmomo-py` is a synchronous Python 3.10+ client for the MTN MoMo Collection, Disbursement, OAuth/CIBA, and Sandbox Provisioning APIs.
+
+## Install
+
+```bash
+pip install mtnmomo-py
+```
+
+## Configure
+
+Supply credentials explicitly or through environment variables. Do not commit API keys, subscription keys, or `credentials.json`.
+
+```python
+from mtnmomo import MoMoClient, MoMoConfig, ProductCredentials
+
+config = MoMoConfig(
+    collection=ProductCredentials(
+        subscription_key="collection-subscription-key",
+        api_user="collection-api-user",
+        api_key="collection-api-key",
+    ),
+    disbursement=ProductCredentials(
+        subscription_key="disbursement-subscription-key",
+        api_user="disbursement-api-user",
+        api_key="disbursement-api-key",
+    ),
+    target_environment="sandbox",
+)
+
+with MoMoClient(config) as client:
+    balance = client.collection.get_account_balance()
+    print(balance.available_balance, balance.currency)
+```
+
+`MoMoConfig.from_env()` reads:
+
+- `MTN_MOMO_COLLECTION_SUBSCRIPTION_KEY`
+- `MTN_MOMO_COLLECTION_API_USER`
+- `MTN_MOMO_COLLECTION_API_KEY`
+- `MTN_MOMO_DISBURSEMENT_SUBSCRIPTION_KEY`
+- `MTN_MOMO_DISBURSEMENT_API_USER`
+- `MTN_MOMO_DISBURSEMENT_API_KEY`
+- `MTN_MOMO_TARGET_ENVIRONMENT` (defaults to `sandbox`)
+- `MTN_MOMO_BASE_URL` (defaults to the MTN sandbox URL)
+- `MTN_MOMO_TIMEOUT` (defaults to `30` seconds)
+
+## Collection example
+
+```python
+from mtnmomo import Party
+
+reference_id = client.collection.request_to_pay(
+    {
+        "amount": "100",
+        "currency": "EUR",
+        "externalId": "order-123",
+        "payer": Party("MSISDN", "46733123453"),
+        "payerMessage": "Order 123",
+        "payeeNote": "Order 123",
+    },
+    callback_url="https://merchant.example/momo/callback",
+)
+status = client.collection.get_request_to_pay_status(reference_id)
+```
+
+## Disbursement example
+
+```python
+reference_id = client.disbursement.transfer(
+    {
+        "amount": "100",
+        "currency": "EUR",
+        "externalId": "payout-123",
+        "payee": Party("MSISDN", "46733123453"),
+    },
+    callback_url="https://merchant.example/momo/callback",
+)
+```
+
+## Testing
+
+```bash
+pip install -e .[test]
+pytest
+```
+
+Tests are network-free by default. Safe sandbox token tests require explicit environment configuration and opt-in:
+
+```bash
+MTN_MOMO_RUN_INTEGRATION=1 pytest -m integration
+```
+
+State-changing sandbox operations remain mocked by default.
+
+## Publishing
+
+Build artifacts with `python -m build`; inspect them to confirm secrets are absent. Publish using a user-managed PyPI token or Trusted Publishing after testing the release on TestPyPI.