gosms-python 1.0.3__tar.gz

gosms_python-1.0.3/.github/workflows/release.yml

@@ -0,0 +1,87 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.9", "3.10", "3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: pip install -e ".[dev,async]"
+
+      - name: Lint
+        run: ruff check src/ tests/
+
+      - name: Test
+        run: pytest --tb=short -q
+
+  release:
+    needs: test
+    if: github.event_name == 'push' && github.ref == 'refs/heads/main'
+    runs-on: ubuntu-latest
+    outputs:
+      released: ${{ steps.semantic.outputs.new_release_published }}
+      version: ${{ steps.semantic.outputs.new_release_version }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Semantic Release
+        id: semantic
+        uses: cycjimmy/semantic-release-action@v4
+        with:
+          extra_plugins: |
+            conventional-changelog-conventionalcommits@8
+          semantic_version: 24
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  publish:
+    needs: release
+    if: needs.release.outputs.released == 'true'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: main
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Set version from release
+        run: |
+          VERSION=${{ needs.release.outputs.version }}
+          sed -i "s/version = \".*\"/version = \"$VERSION\"/" pyproject.toml
+          sed -i "s/__version__ = \".*\"/__version__ = \"$VERSION\"/" src/gosms/__init__.py
+
+      - name: Install build tools
+        run: pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Publish to PyPI
+        run: twine upload dist/*
+        env:
+          TWINE_USERNAME: __token__
+          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}

gosms_python-1.0.3/.gitignore

@@ -0,0 +1,37 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+
+# Distribution / packaging
+dist/
+build/
+*.egg-info/
+*.egg
+pip-wheel-metadata/
+
+# Virtual environments
+.venv/
+venv/
+env/
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# Testing
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Linting
+.ruff_cache/
+.mypy_cache/
+
+# OS
+.DS_Store
+Thumbs.db

gosms_python-1.0.3/.releaserc.json

@@ -0,0 +1,12 @@
+{
+  "branches": ["main"],
+  "plugins": [
+    ["@semantic-release/commit-analyzer", {
+      "preset": "conventionalcommits"
+    }],
+    ["@semantic-release/release-notes-generator", {
+      "preset": "conventionalcommits"
+    }],
+    "@semantic-release/github"
+  ]
+}

gosms_python-1.0.3/PKG-INFO

@@ -0,0 +1,276 @@
+Metadata-Version: 2.4
+Name: gosms-python
+Version: 1.0.3
+Summary: Official Python SDK for GoSMS.GE SMS Gateway
+Project-URL: Homepage, https://gosms.ge
+Project-URL: Repository, https://github.com/gosms-ge/gosmsge-python
+Project-URL: Issues, https://github.com/gosms-ge/gosmsge-python/issues
+Author-email: "GoSMS.GE" <info@gosms.ge>
+License-Expression: MIT
+Keywords: gosms,otp,sms,sms-api,sms-gateway,sms-sdk
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+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 :: Communications
+Classifier: Typing :: Typed
+Requires-Python: >=3.9
+Requires-Dist: requests>=2.28.0
+Provides-Extra: async
+Requires-Dist: httpx>=0.24.0; extra == 'async'
+Provides-Extra: dev
+Requires-Dist: build; extra == 'dev'
+Requires-Dist: pytest-asyncio>=0.21; extra == 'dev'
+Requires-Dist: pytest-httpx>=0.21; extra == 'dev'
+Requires-Dist: pytest>=7.0; extra == 'dev'
+Requires-Dist: responses>=0.23; extra == 'dev'
+Requires-Dist: ruff>=0.1; extra == 'dev'
+Provides-Extra: django
+Requires-Dist: django>=3.2; extra == 'django'
+Description-Content-Type: text/markdown
+
+# GoSMS.GE Python SDK
+
+[![PyPI version](https://img.shields.io/pypi/v/gosms-python.svg)](https://pypi.org/project/gosms-python/)
+[![Python versions](https://img.shields.io/pypi/pyversions/gosms-python.svg)](https://pypi.org/project/gosms-python/)
+[![Tests](https://github.com/gosms-python/gosms-python-python/actions/workflows/release.yml/badge.svg)](https://github.com/gosms-python/gosms-python-python/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Official Python SDK for the [GoSMS.GE](https://gosms.ge) SMS gateway. Send SMS messages, manage OTP verification, and check balances with both sync and async clients.
+
+## Installation
+
+```bash
+pip install gosms-python
+```
+
+For async support:
+
+```bash
+pip install gosms-python[async]
+```
+
+## Quick Start
+
+```python
+from gosms import SMS
+
+sms = SMS("your_api_key")
+
+# Send a message
+result = sms.send("995555123456", "Hello!", "GOSMS.GE")
+print(result.message_id)  # 12345
+print(result.balance)     # 99
+
+# Check balance
+balance = sms.balance()
+print(balance.balance)  # 500
+```
+
+## All Endpoints
+
+### Send SMS
+
+```python
+result = sms.send("995555123456", "Hello!", "GOSMS.GE")
+result = sms.send("995555123456", "Urgent!", "GOSMS.GE", urgent=True)
+```
+
+### Send Bulk SMS
+
+```python
+result = sms.send_bulk(
+    "GOSMS.GE",
+    ["995555111111", "995555222222"],
+    "Hello everyone!",
+)
+print(result.total_count)    # 2
+print(result.success_count)  # 2
+
+for msg in result.messages:
+    print(f"{msg.to}: {msg.message_id}")
+```
+
+### Send OTP
+
+```python
+result = sms.send_otp("995555123456")
+print(result.hash)  # "abc123hash" — save this for verification
+```
+
+### Verify OTP
+
+```python
+result = sms.verify_otp("995555123456", "abc123hash", "1234")
+print(result.verify)  # True
+```
+
+### Check Message Status
+
+```python
+result = sms.status(12345)
+print(result.status)  # "delivered"
+```
+
+### Check Balance
+
+```python
+result = sms.balance()
+print(result.balance)  # 500
+```
+
+### Create Sender Name
+
+```python
+result = sms.create_sender("MyBrand")
+print(result.success)  # True
+```
+
+## Async Usage
+
+```python
+import asyncio
+from gosms import AsyncSMS
+
+async def main():
+    async with AsyncSMS("your_api_key") as sms:
+        result = await sms.send("995555123456", "Hello!", "GOSMS.GE")
+        print(result.message_id)
+
+        balance = await sms.balance()
+        print(balance.balance)
+
+asyncio.run(main())
+```
+
+All methods from the sync client are available as async equivalents with the same signatures.
+
+## Django Integration
+
+Add to your `settings.py`:
+
+```python
+GOSMS_SETTINGS = {
+    "api_key": "your_api_key",
+    "timeout": 30,    # optional
+    "retries": 1,     # optional
+}
+```
+
+Use anywhere in your project:
+
+```python
+from gosms.django import get_sms_client
+
+sms = get_sms_client()
+sms.send("995555123456", "Hello!", "GOSMS.GE")
+```
+
+The client is created lazily on first call and reused as a singleton.
+
+## Configuration
+
+```python
+sms = SMS(
+    "your_api_key",
+    timeout=30,   # request timeout in seconds (default: 30)
+    retries=3,    # retry attempts on failure (default: 1)
+    debug=True,   # enable debug logging (default: False)
+)
+```
+
+## Error Handling
+
+```python
+from gosms import SMS, GoSmsApiError, GoSmsErrorCode
+
+sms = SMS("your_api_key")
+
+try:
+    result = sms.send("995555123456", "Hello!", "GOSMS.GE")
+except GoSmsApiError as e:
+    print(e.error_code)  # 100
+    print(e.message)     # "Invalid API key"
+
+    if e.error_code == GoSmsErrorCode.INVALID_API_KEY:
+        print("Check your API key")
+```
+
+### Error Codes
+
+| Code | Constant | Description |
+|------|----------|-------------|
+| 100 | `INVALID_API_KEY` | Invalid API key |
+| 101 | `INVALID_PHONE_NUMBER` | Invalid phone number |
+| 102 | `INSUFFICIENT_BALANCE` | Insufficient balance |
+| 103 | `SENDER_NOT_FOUND` | Sender name not found |
+| 104 | `INVALID_TEXT` | Invalid message text |
+| 105 | `TOO_MANY_RECIPIENTS` | Too many recipients (max 1000) |
+| 106 | `INVALID_MESSAGE_ID` | Invalid message ID |
+| 107 | `SENDER_EXISTS` | Sender name already exists |
+| 108 | `INVALID_SENDER_NAME` | Invalid sender name |
+| 109 | `INVALID_OTP_HASH` | Invalid OTP hash |
+| 110 | `INVALID_OTP_CODE` | Invalid OTP code |
+| 111 | `OTP_EXPIRED` | OTP expired |
+| 112 | `OTP_ALREADY_VERIFIED` | OTP already verified |
+| 113 | `RATE_LIMIT_EXCEEDED` | Rate limit exceeded |
+
+## Response Types
+
+All methods return typed frozen dataclasses:
+
+| Method | Return Type | Key Fields |
+|--------|-------------|------------|
+| `send()` | `SmsSendResponse` | `success`, `message_id`, `balance` |
+| `send_bulk()` | `SendBulkSmsResponse` | `success`, `total_count`, `messages` |
+| `send_otp()` | `OtpSendResponse` | `success`, `hash`, `balance` |
+| `verify_otp()` | `OtpVerifyResponse` | `success`, `verify` |
+| `status()` | `CheckStatusResponse` | `success`, `status`, `message_id` |
+| `balance()` | `BalanceResponse` | `success`, `balance` |
+| `create_sender()` | `SenderCreateResponse` | `success` |
+
+## Migration from v1.x
+
+v2.0 is a complete rewrite. Key changes:
+
+```python
+# v1.x (old)
+from gosms import sms                    # module-level singleton
+sms.send('995...', 'text', 'SENDER')
+
+# v2.0 (new)
+from gosms import SMS                    # explicit instantiation
+sms = SMS('your_api_key')
+sms.send('995...', 'text', 'SENDER')
+
+# v1.x Django (old)
+from gosms import sms                    # import-time side effect
+
+# v2.0 Django (new)
+from gosms.django import get_sms_client  # lazy factory
+sms = get_sms_client()
+```
+
+Other changes:
+- `GoSmsApiError` now extends `Exception` (was `BaseException`)
+- Added `GoSmsErrorCode` constants for typed error handling
+- Added `send_bulk()` and `create_sender()` endpoints
+- Added async client (`AsyncSMS`) via `pip install gosms-python[async]`
+- All responses are typed frozen dataclasses
+- Removed `dev_mode` / `RequestMock` in favor of standard test mocking
+
+## License
+
+MIT
+
+## Links
+
+- Website: https://gosms.ge
+- PyPI: https://pypi.org/project/gosms-python/
+- GitHub: https://github.com/gosms-python/gosms-python-python
+- Support: info@gosms.ge

gosms_python-1.0.3/README.md

@@ -0,0 +1,240 @@
+# GoSMS.GE Python SDK
+
+[![PyPI version](https://img.shields.io/pypi/v/gosms-python.svg)](https://pypi.org/project/gosms-python/)
+[![Python versions](https://img.shields.io/pypi/pyversions/gosms-python.svg)](https://pypi.org/project/gosms-python/)
+[![Tests](https://github.com/gosms-python/gosms-python-python/actions/workflows/release.yml/badge.svg)](https://github.com/gosms-python/gosms-python-python/actions)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+Official Python SDK for the [GoSMS.GE](https://gosms.ge) SMS gateway. Send SMS messages, manage OTP verification, and check balances with both sync and async clients.
+
+## Installation
+
+```bash
+pip install gosms-python
+```
+
+For async support:
+
+```bash
+pip install gosms-python[async]
+```
+
+## Quick Start
+
+```python
+from gosms import SMS
+
+sms = SMS("your_api_key")
+
+# Send a message
+result = sms.send("995555123456", "Hello!", "GOSMS.GE")
+print(result.message_id)  # 12345
+print(result.balance)     # 99
+
+# Check balance
+balance = sms.balance()
+print(balance.balance)  # 500
+```
+
+## All Endpoints
+
+### Send SMS
+
+```python
+result = sms.send("995555123456", "Hello!", "GOSMS.GE")
+result = sms.send("995555123456", "Urgent!", "GOSMS.GE", urgent=True)
+```
+
+### Send Bulk SMS
+
+```python
+result = sms.send_bulk(
+    "GOSMS.GE",
+    ["995555111111", "995555222222"],
+    "Hello everyone!",
+)
+print(result.total_count)    # 2
+print(result.success_count)  # 2
+
+for msg in result.messages:
+    print(f"{msg.to}: {msg.message_id}")
+```
+
+### Send OTP
+
+```python
+result = sms.send_otp("995555123456")
+print(result.hash)  # "abc123hash" — save this for verification
+```
+
+### Verify OTP
+
+```python
+result = sms.verify_otp("995555123456", "abc123hash", "1234")
+print(result.verify)  # True
+```
+
+### Check Message Status
+
+```python
+result = sms.status(12345)
+print(result.status)  # "delivered"
+```
+
+### Check Balance
+
+```python
+result = sms.balance()
+print(result.balance)  # 500
+```
+
+### Create Sender Name
+
+```python
+result = sms.create_sender("MyBrand")
+print(result.success)  # True
+```
+
+## Async Usage
+
+```python
+import asyncio
+from gosms import AsyncSMS
+
+async def main():
+    async with AsyncSMS("your_api_key") as sms:
+        result = await sms.send("995555123456", "Hello!", "GOSMS.GE")
+        print(result.message_id)
+
+        balance = await sms.balance()
+        print(balance.balance)
+
+asyncio.run(main())
+```
+
+All methods from the sync client are available as async equivalents with the same signatures.
+
+## Django Integration
+
+Add to your `settings.py`:
+
+```python
+GOSMS_SETTINGS = {
+    "api_key": "your_api_key",
+    "timeout": 30,    # optional
+    "retries": 1,     # optional
+}
+```
+
+Use anywhere in your project:
+
+```python
+from gosms.django import get_sms_client
+
+sms = get_sms_client()
+sms.send("995555123456", "Hello!", "GOSMS.GE")
+```
+
+The client is created lazily on first call and reused as a singleton.
+
+## Configuration
+
+```python
+sms = SMS(
+    "your_api_key",
+    timeout=30,   # request timeout in seconds (default: 30)
+    retries=3,    # retry attempts on failure (default: 1)
+    debug=True,   # enable debug logging (default: False)
+)
+```
+
+## Error Handling
+
+```python
+from gosms import SMS, GoSmsApiError, GoSmsErrorCode
+
+sms = SMS("your_api_key")
+
+try:
+    result = sms.send("995555123456", "Hello!", "GOSMS.GE")
+except GoSmsApiError as e:
+    print(e.error_code)  # 100
+    print(e.message)     # "Invalid API key"
+
+    if e.error_code == GoSmsErrorCode.INVALID_API_KEY:
+        print("Check your API key")
+```
+
+### Error Codes
+
+| Code | Constant | Description |
+|------|----------|-------------|
+| 100 | `INVALID_API_KEY` | Invalid API key |
+| 101 | `INVALID_PHONE_NUMBER` | Invalid phone number |
+| 102 | `INSUFFICIENT_BALANCE` | Insufficient balance |
+| 103 | `SENDER_NOT_FOUND` | Sender name not found |
+| 104 | `INVALID_TEXT` | Invalid message text |
+| 105 | `TOO_MANY_RECIPIENTS` | Too many recipients (max 1000) |
+| 106 | `INVALID_MESSAGE_ID` | Invalid message ID |
+| 107 | `SENDER_EXISTS` | Sender name already exists |
+| 108 | `INVALID_SENDER_NAME` | Invalid sender name |
+| 109 | `INVALID_OTP_HASH` | Invalid OTP hash |
+| 110 | `INVALID_OTP_CODE` | Invalid OTP code |
+| 111 | `OTP_EXPIRED` | OTP expired |
+| 112 | `OTP_ALREADY_VERIFIED` | OTP already verified |
+| 113 | `RATE_LIMIT_EXCEEDED` | Rate limit exceeded |
+
+## Response Types
+
+All methods return typed frozen dataclasses:
+
+| Method | Return Type | Key Fields |
+|--------|-------------|------------|
+| `send()` | `SmsSendResponse` | `success`, `message_id`, `balance` |
+| `send_bulk()` | `SendBulkSmsResponse` | `success`, `total_count`, `messages` |
+| `send_otp()` | `OtpSendResponse` | `success`, `hash`, `balance` |
+| `verify_otp()` | `OtpVerifyResponse` | `success`, `verify` |
+| `status()` | `CheckStatusResponse` | `success`, `status`, `message_id` |
+| `balance()` | `BalanceResponse` | `success`, `balance` |
+| `create_sender()` | `SenderCreateResponse` | `success` |
+
+## Migration from v1.x
+
+v2.0 is a complete rewrite. Key changes:
+
+```python
+# v1.x (old)
+from gosms import sms                    # module-level singleton
+sms.send('995...', 'text', 'SENDER')
+
+# v2.0 (new)
+from gosms import SMS                    # explicit instantiation
+sms = SMS('your_api_key')
+sms.send('995...', 'text', 'SENDER')
+
+# v1.x Django (old)
+from gosms import sms                    # import-time side effect
+
+# v2.0 Django (new)
+from gosms.django import get_sms_client  # lazy factory
+sms = get_sms_client()
+```
+
+Other changes:
+- `GoSmsApiError` now extends `Exception` (was `BaseException`)
+- Added `GoSmsErrorCode` constants for typed error handling
+- Added `send_bulk()` and `create_sender()` endpoints
+- Added async client (`AsyncSMS`) via `pip install gosms-python[async]`
+- All responses are typed frozen dataclasses
+- Removed `dev_mode` / `RequestMock` in favor of standard test mocking
+
+## License
+
+MIT
+
+## Links
+
+- Website: https://gosms.ge
+- PyPI: https://pypi.org/project/gosms-python/
+- GitHub: https://github.com/gosms-python/gosms-python-python
+- Support: info@gosms.ge

gosms_python-1.0.3/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "gosms-python"
+version = "1.0.3"
+description = "Official Python SDK for GoSMS.GE SMS Gateway"
+readme = "README.md"
+license = "MIT"
+requires-python = ">=3.9"
+authors = [
+    { name = "GoSMS.GE", email = "info@gosms.ge" },
+]
+keywords = ["sms", "sms-api", "gosms", "sms-sdk", "sms-gateway", "otp"]
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Communications",
+    "Typing :: Typed",
+]
+dependencies = [
+    "requests>=2.28.0",
+]
+
+[project.optional-dependencies]
+async = ["httpx>=0.24.0"]
+django = ["django>=3.2"]
+dev = [
+    "pytest>=7.0",
+    "pytest-asyncio>=0.21",
+    "responses>=0.23",
+    "pytest-httpx>=0.21",
+    "ruff>=0.1",
+    "build",
+]
+
+[project.urls]
+Homepage = "https://gosms.ge"
+Repository = "https://github.com/gosms-ge/gosmsge-python"
+Issues = "https://github.com/gosms-ge/gosmsge-python/issues"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/gosms"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+
+[tool.ruff]
+target-version = "1.0.3"
+line-length = 120
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "SIM"]