cyclos-sdk-py 0.1.0__tar.gz

cyclos_sdk_py-0.1.0/.env.example

@@ -0,0 +1,23 @@
+# Cyclos API configuration
+# The base URL must include the API path. The OpenAPI spec reports /api, but your
+# installation may use a different prefix such as /uwallet/api.
+CYCLOS_BASE_URL=https://wallet.angstrom-technologies.ug/uwallet/api
+
+# Credentials for HTTP Basic authentication during login.
+# Prefer configuring these through a secrets manager rather than .env in production.
+CYCLOS_USERNAME=
+CYCLOS_PASSWORD=
+
+# HTTP client settings
+CYCLOS_TIMEOUT=30
+CYCLOS_VERIFY_SSL=true
+
+# Retry settings for transient failures only (never applied to non-idempotent financial POSTs)
+CYCLOS_MAX_RETRIES=3
+CYCLOS_RETRY_BACKOFF=0.5
+
+# Optional integration test configuration
+CYCLOS_INTEGRATION_TESTS=false
+CYCLOS_TEST_BASE_URL=https://wallet.angstrom-technologies.ug/uwallet/api
+CYCLOS_TEST_USERNAME=
+CYCLOS_TEST_PASSWORD=

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

@@ -0,0 +1,63 @@
+name: Publish Python Package
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+  workflow_dispatch:
+    inputs:
+      version:
+        description: "Version tag to publish (optional)"
+        required: false
+        type: string
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install build tools
+        run: python -m pip install --upgrade build
+
+      - name: Build package
+        run: python -m build
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          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/project/angstrom-cyclos/
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish package to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.PYPI_API_TOKEN }}

cyclos_sdk_py-0.1.0/.gitignore

@@ -0,0 +1,45 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+
+# Testing
+.coverage
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+htmlcov/
+.tox/
+
+# OS
+.DS_Store
+Thumbs.db

cyclos_sdk_py-0.1.0/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 0.1.0 (Unreleased)
+
+### Added
+- Initial production-grade Python SDK for Cyclos 4.16 REST API.
+- Synchronous `CyclosClient` and asynchronous `AsyncCyclosClient`.
+- Environment-based configuration via `CyclosConfig` / `pydantic-settings`.
+- Modular sub-clients: `auth`, `members`, `users`, `organizations`, `operators`, `permissions`, `webservices`, `accounts`, `transfers`, `transactions`.
+- Pydantic v2 request/response models for members, operators, accounts, payments, transfers, and transactions.
+- Structured, secret-safe logging with MSISDN masking.
+- HTTP transport layer with retries, correlation IDs, timeouts, and connection pooling.
+- Tenacity-based retry policy for transient errors only.
+- Idempotency guard for financial `POST` operations.
+- Generic `PaginatedResult[T]` pagination model.
+- Comprehensive error hierarchy mapping Cyclos HTTP status codes.
+- Unit tests using `pytest`, `pytest-asyncio`, and `respx`.
+- Optional integration tests gated by `CYCLOS_INTEGRATION_TESTS`.
+- `mypy` and `ruff` configuration in `pyproject.toml`.

cyclos_sdk_py-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Angstrom Technologies
+
+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.

cyclos_sdk_py-0.1.0/PKG-INFO

@@ -0,0 +1,298 @@
+Metadata-Version: 2.5
+Name: cyclos-sdk-py
+Version: 0.1.0
+Summary: Production-grade Python SDK for the Cyclos 4.16 REST API
+Project-URL: Homepage, https://github.com/Angstrom-Technologies/cyclos-sdk-py
+Project-URL: Repository, https://github.com/Angstrom-Technologies/cyclos-sdk-py
+Project-URL: Issues, https://github.com/Angstrom-Technologies/cyclos-sdk-py/issues
+Author-email: Angstrom Technologies <dev@angstrom-technologies.ug>
+License: MIT License
+        
+        Copyright (c) 2026 Angstrom Technologies
+        
+        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.
+License-File: LICENSE
+Keywords: cyclos,fintech,payments,sdk,wallet
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+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.11
+Requires-Dist: httpx<1.0,>=0.27
+Requires-Dist: pydantic-settings<3.0,>=2.1
+Requires-Dist: pydantic<3.0,>=2.5
+Requires-Dist: tenacity<9.0,>=8.2
+Provides-Extra: dev
+Requires-Dist: mypy<2.0,>=1.7; extra == 'dev'
+Requires-Dist: pytest-asyncio<1.0,>=0.23; extra == 'dev'
+Requires-Dist: pytest<9.0,>=7.4; extra == 'dev'
+Requires-Dist: respx<1.0,>=0.21; extra == 'dev'
+Requires-Dist: ruff>=0.6.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# cyclos-sdk-py
+
+Production-grade Python SDK for the Cyclos 4.16 REST API.
+
+Published on PyPI as `cyclos-sdk-py`, imported as `angstrom_cyclos`.
+
+## Installation
+
+```bash
+pip install cyclos-sdk-py
+```
+
+For development:
+
+```bash
+git clone https://github.com/Angstrom-Technologies/cyclos-sdk-py.git
+cd cyclos-sdk-py
+pip install -e ".[dev]"
+```
+
+## Configuration
+
+Set environment variables or pass a `CyclosConfig` object:
+
+```python
+from angstrom_cyclos import CyclosClient, CyclosConfig
+
+config = CyclosConfig(
+    base_url="https://wallet.angstrom-technologies.ug/uwallet/api",
+    username="service_client",
+    password="...",
+)
+
+client = CyclosClient(config)
+```
+
+### Environment variables
+
+```env
+CYCLOS_BASE_URL=https://wallet.angstrom-technologies.ug/uwallet/api
+CYCLOS_USERNAME=service_client
+CYCLOS_PASSWORD=...
+CYCLOS_TIMEOUT=30
+CYCLOS_VERIFY_SSL=true
+CYCLOS_MAX_RETRIES=3
+CYCLOS_RETRY_BACKOFF=0.5
+```
+
+## Authentication
+
+```python
+from angstrom_cyclos import CyclosClient, CyclosConfig
+
+config = CyclosConfig.from_env()
+client = CyclosClient(config)
+
+client.auth.login("customer", "password")
+print(client.auth.is_authenticated())
+
+client.auth.logout()
+```
+
+## Creating members
+
+### Individual
+
+```python
+customer = client.members.create_individual(
+    username="256772123456",
+    first_name="John",
+    last_name="Doe",
+    email="john@example.com",
+    mobile="256772123456",
+    custom_fields={"kycStatus": "VERIFIED"},
+)
+```
+
+### Merchant
+
+```python
+merchant = client.members.create_merchant(
+    username="merchant001",
+    name="Merchant One",
+    email="merchant@example.com",
+    mobile="256772123456",
+    group="merchant",
+)
+```
+
+### Organization
+
+```python
+organization = client.organizations.create(
+    group="corporate",
+    username="abc_limited",
+    name="ABC Limited",
+    custom_fields={"businessRegistrationNumber": "800200012345"},
+)
+```
+
+## Operators
+
+```python
+operator = client.operators.create(
+    organization_id=organization.user.id,
+    username="operator001",
+    first_name="Jane",
+    last_name="Doe",
+)
+
+client.operators.assign_permissions(
+    organization_id=organization.user.id,
+    operator_id=operator.user.id,
+    permissions=["VIEW_MEMBER", "PERFORM_TRANSFER"],
+)
+```
+
+## Web service client
+
+```python
+client.webservices.send_activation_code(
+    {"mobilePhone": "256772123456"}
+)
+ws_client = client.webservices.create_client(
+    name="Angstrom Wallet API",
+    activation_code="123456",
+)
+```
+
+## Accounts and balances
+
+```python
+accounts = client.accounts.list(member_id="alice")
+account = client.accounts.get(member_id="alice", account_type="mobileWallet")
+balance = client.accounts.get_balance(member_id="alice", account_type="mobileWallet")
+print(balance.balance)
+```
+
+## Transfers
+
+```python
+from decimal import Decimal
+
+transfer = client.transfers.create(
+    transfer_type="walletTransfer",
+    from_account="alice",
+    to_account="bob",
+    amount=Decimal("50000"),
+    currency="UGX",
+    description="P2P transfer",
+    idempotency_key="TXN-20260909-000001",
+)
+```
+
+## Transfer history
+
+```python
+history = client.transfers.history(
+    member_id="alice",
+    account_type="mobileWallet",
+    page=0,
+    page_size=50,
+)
+```
+
+## Transaction lookup
+
+```python
+transaction = client.transactions.get("transaction-id")
+```
+
+## Error handling
+
+```python
+from angstrom_cyclos import CyclosAuthenticationError, CyclosValidationError, CyclosNotFoundError
+
+try:
+    client.auth.login("user", "wrong")
+except CyclosAuthenticationError as exc:
+    print(exc.status_code)
+except CyclosValidationError as exc:
+    print(exc.property_errors)
+except CyclosNotFoundError as exc:
+    print(exc.endpoint)
+```
+
+## Async usage
+
+```python
+import asyncio
+from angstrom_cyclos import AsyncCyclosClient, CyclosConfig
+
+async def main() -> None:
+    config = CyclosConfig.from_env()
+    async with AsyncCyclosClient(config) as client:
+        await client.auth.login("user", "pass")
+        member = await client.members.get("alice")
+        print(member)
+
+asyncio.run(main())
+```
+
+## CLI
+
+```bash
+cyclos --help
+cyclos members get <id>
+cyclos members search <query>
+cyclos accounts balance <member>
+cyclos transfers get <id>
+cyclos transfers history <member>
+```
+
+## Architecture
+
+```
+Mobile App
+     |
+Web App
+     |
+SMS / USSD
+     |
+Wallet API
+     |
+Angstrom Cyclos SDK  <-- this package
+     |
+Cyclos
+     |
+PostgreSQL
+```
+
+This SDK is only an API client. Mobile money integrations (MTN/Airtel) belong
+in the wallet middleware, not in this package.
+
+## Testing
+
+```bash
+pytest
+mypy src
+ruff check src
+ruff format src
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE).

cyclos_sdk_py-0.1.0/README.md

@@ -0,0 +1,246 @@
+# cyclos-sdk-py
+
+Production-grade Python SDK for the Cyclos 4.16 REST API.
+
+Published on PyPI as `cyclos-sdk-py`, imported as `angstrom_cyclos`.
+
+## Installation
+
+```bash
+pip install cyclos-sdk-py
+```
+
+For development:
+
+```bash
+git clone https://github.com/Angstrom-Technologies/cyclos-sdk-py.git
+cd cyclos-sdk-py
+pip install -e ".[dev]"
+```
+
+## Configuration
+
+Set environment variables or pass a `CyclosConfig` object:
+
+```python
+from angstrom_cyclos import CyclosClient, CyclosConfig
+
+config = CyclosConfig(
+    base_url="https://wallet.angstrom-technologies.ug/uwallet/api",
+    username="service_client",
+    password="...",
+)
+
+client = CyclosClient(config)
+```
+
+### Environment variables
+
+```env
+CYCLOS_BASE_URL=https://wallet.angstrom-technologies.ug/uwallet/api
+CYCLOS_USERNAME=service_client
+CYCLOS_PASSWORD=...
+CYCLOS_TIMEOUT=30
+CYCLOS_VERIFY_SSL=true
+CYCLOS_MAX_RETRIES=3
+CYCLOS_RETRY_BACKOFF=0.5
+```
+
+## Authentication
+
+```python
+from angstrom_cyclos import CyclosClient, CyclosConfig
+
+config = CyclosConfig.from_env()
+client = CyclosClient(config)
+
+client.auth.login("customer", "password")
+print(client.auth.is_authenticated())
+
+client.auth.logout()
+```
+
+## Creating members
+
+### Individual
+
+```python
+customer = client.members.create_individual(
+    username="256772123456",
+    first_name="John",
+    last_name="Doe",
+    email="john@example.com",
+    mobile="256772123456",
+    custom_fields={"kycStatus": "VERIFIED"},
+)
+```
+
+### Merchant
+
+```python
+merchant = client.members.create_merchant(
+    username="merchant001",
+    name="Merchant One",
+    email="merchant@example.com",
+    mobile="256772123456",
+    group="merchant",
+)
+```
+
+### Organization
+
+```python
+organization = client.organizations.create(
+    group="corporate",
+    username="abc_limited",
+    name="ABC Limited",
+    custom_fields={"businessRegistrationNumber": "800200012345"},
+)
+```
+
+## Operators
+
+```python
+operator = client.operators.create(
+    organization_id=organization.user.id,
+    username="operator001",
+    first_name="Jane",
+    last_name="Doe",
+)
+
+client.operators.assign_permissions(
+    organization_id=organization.user.id,
+    operator_id=operator.user.id,
+    permissions=["VIEW_MEMBER", "PERFORM_TRANSFER"],
+)
+```
+
+## Web service client
+
+```python
+client.webservices.send_activation_code(
+    {"mobilePhone": "256772123456"}
+)
+ws_client = client.webservices.create_client(
+    name="Angstrom Wallet API",
+    activation_code="123456",
+)
+```
+
+## Accounts and balances
+
+```python
+accounts = client.accounts.list(member_id="alice")
+account = client.accounts.get(member_id="alice", account_type="mobileWallet")
+balance = client.accounts.get_balance(member_id="alice", account_type="mobileWallet")
+print(balance.balance)
+```
+
+## Transfers
+
+```python
+from decimal import Decimal
+
+transfer = client.transfers.create(
+    transfer_type="walletTransfer",
+    from_account="alice",
+    to_account="bob",
+    amount=Decimal("50000"),
+    currency="UGX",
+    description="P2P transfer",
+    idempotency_key="TXN-20260909-000001",
+)
+```
+
+## Transfer history
+
+```python
+history = client.transfers.history(
+    member_id="alice",
+    account_type="mobileWallet",
+    page=0,
+    page_size=50,
+)
+```
+
+## Transaction lookup
+
+```python
+transaction = client.transactions.get("transaction-id")
+```
+
+## Error handling
+
+```python
+from angstrom_cyclos import CyclosAuthenticationError, CyclosValidationError, CyclosNotFoundError
+
+try:
+    client.auth.login("user", "wrong")
+except CyclosAuthenticationError as exc:
+    print(exc.status_code)
+except CyclosValidationError as exc:
+    print(exc.property_errors)
+except CyclosNotFoundError as exc:
+    print(exc.endpoint)
+```
+
+## Async usage
+
+```python
+import asyncio
+from angstrom_cyclos import AsyncCyclosClient, CyclosConfig
+
+async def main() -> None:
+    config = CyclosConfig.from_env()
+    async with AsyncCyclosClient(config) as client:
+        await client.auth.login("user", "pass")
+        member = await client.members.get("alice")
+        print(member)
+
+asyncio.run(main())
+```
+
+## CLI
+
+```bash
+cyclos --help
+cyclos members get <id>
+cyclos members search <query>
+cyclos accounts balance <member>
+cyclos transfers get <id>
+cyclos transfers history <member>
+```
+
+## Architecture
+
+```
+Mobile App
+     |
+Web App
+     |
+SMS / USSD
+     |
+Wallet API
+     |
+Angstrom Cyclos SDK  <-- this package
+     |
+Cyclos
+     |
+PostgreSQL
+```
+
+This SDK is only an API client. Mobile money integrations (MTN/Airtel) belong
+in the wallet middleware, not in this package.
+
+## Testing
+
+```bash
+pytest
+mypy src
+ruff check src
+ruff format src
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE).