Metadata-Version: 2.4
Name: burstfamgateway
Version: 0.1.0
Summary: Python client for the BurstAxis payment gateway
Author: BurstAxis
Project-URL: Documentation, https://payment.burstaxis.online/docs.php
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# burstfamgateway

Python client for the BurstAxis-hosted payment gateway (not an official FamApp SDK).

This source is prepared locally, NOT yet published or reserved on PyPI. Until the owner publishes it, install from this directory: `python -m pip install .`. After publication the command is `python -m pip install burstfamgateway`.

```python
import os
from burstfamgateway import BurstFamGateway

client = BurstFamGateway(api_key=os.environ["BURSTFAM_API_KEY"])
order = client.create_order(amount="5.00", validity_hours=24)
print(order.checkout_url)
status = client.get_status(order.order_id)
if status.is_paid and status.amount == order.amount:
    print("Verified UTR:", status.utr)
```

Run on your server, never expose the API key to website visitors. Store the order ID, expected amount and customer association yourself; fulfill once only. `is_paid` checks the server's order status and UTR, not the top-level API-request success flag. This client does not independently verify a bank transaction. Keep server-side payment checks configured. No automatic create-order retries (the server has no idempotency-key contract). A timeout can happen after the server created an order. HTTPS is required and HTTP redirects are rejected to protect the API key.

## Owner publishing steps

1. Create your own PyPI and TestPyPI accounts; enable 2FA. Confirm you can use the package name (availability is not guaranteed). Choose the distribution license before public release; none has been chosen for you.
2. From this `python-sdk` directory run:
   ```text
   python -m pip install --upgrade build twine
   python -m build
   python -m twine check dist/*
   python -m twine upload --repository testpypi dist/*
   ```
3. Test the uploaded package in a clean virtual environment. Then publish the same reviewed artifacts to your own PyPI project with `python -m twine upload dist/*`.
4. Use your own API token privately in the terminal (username `__token__`), or configure Trusted Publishing. Never send tokens in chat or include credentials/server files in the package. Upload only this SDK's wheel and source distribution, NOT the website ZIP.
5. Verify installation with `python -m pip install burstfamgateway` from a clean environment. Update website wording to published only after successful release. Version numbers cannot be reused for replacement files.

Reference: https://packaging.python.org/en/latest/tutorials/packaging-projects/
