bitpin-sdk 0.1.0__tar.gz

bitpin_sdk-0.1.0/.gitignore

@@ -0,0 +1,19 @@
+__pycache__/
+*.py[cod]
+.venv/
+dist/
+build/
+*.egg-info/
+.coverage
+coverage.xml
+htmlcov/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+site/
+.superpowers/
+.env
+.env.*
+!.env.example
+.DS_Store
+.hypothesis/

bitpin_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+
+All notable changes to the Python SDK, written by release-please from Conventional Commits.
+
+
+## 0.1.0 (2026-10-27)
+
+
+### Features
+
+* **python:** async client with public market data ([e23997b](https://github.com/bitpin-dev/bitpin-sdk/commit/e23997b3e3135e0d2d1352d86ac62fb301141c41))
+* **python:** config, rate limiter, symbol and decimal helpers ([4bf3f14](https://github.com/bitpin-dev/bitpin-sdk/commit/4bf3f142848c800c6e2dd8e40ada0053683d3d12))
+* **python:** error hierarchy and mapping ([5795634](https://github.com/bitpin-dev/bitpin-sdk/commit/57956343ad9f8ad9219269ce2047f89e5aed3350))
+* **python:** generate endpoint table from spec ([7377da1](https://github.com/bitpin-dev/bitpin-sdk/commit/7377da15cd4a326ff9a49ad61951e05d6660e9b8))
+* **python:** generate sync client with unasync ([2e1c41c](https://github.com/bitpin-dev/bitpin-sdk/commit/2e1c41c7c304ce83a6508f30850554519ca56cf7))
+* **python:** request builder, parsers and shared fixtures ([daaa339](https://github.com/bitpin-dev/bitpin-sdk/commit/daaa339f942065ee7a06f00513c4928af80766b4))
+* **python:** token lifecycle and token stores ([300ddf6](https://github.com/bitpin-dev/bitpin-sdk/commit/300ddf6040bb5bd2964ae3fda843cddbe146cdf5))
+* **python:** trading, wallet and not-supported methods ([5007c21](https://github.com/bitpin-dev/bitpin-sdk/commit/5007c211cdf9b0ec4041a8d1f52e8556709fd5be))
+* **python:** websocket watch methods ([03b6624](https://github.com/bitpin-dev/bitpin-sdk/commit/03b66249e637f7abad484cfc2b75ad1a685fbbeb))
+
+
+### Bug fixes
+
+* **ci:** dependabot PR titles pass the conventional-title check ([d9edc02](https://github.com/bitpin-dev/bitpin-sdk/commit/d9edc02c6cc66dc2c922799c7245747eb79396d7))
+* **examples:** market maker always cancels its quotes on exit ([6c1b066](https://github.com/bitpin-dev/bitpin-sdk/commit/6c1b0665d22b0b64bac7b742a51c37ee105d61ad))
+* **python:** give each websocket watch its own queue ([41cee57](https://github.com/bitpin-dev/bitpin-sdk/commit/41cee574bd748341b5ca4e71df5e4df956c479ba))
+* **python:** ignore a late 401 for a token that was already replaced ([5f7092a](https://github.com/bitpin-dev/bitpin-sdk/commit/5f7092a732ee738b5f2fbd7ff6867100df1cae46))
+* **python:** paginate reads every page and can't loop forever ([f25b7b3](https://github.com/bitpin-dev/bitpin-sdk/commit/f25b7b316254534f99ac900c0e515a97abe491ba))
+* **python:** parse one-digit fractions on Python 3.10; derive the token-file id with PBKDF2 ([d896f26](https://github.com/bitpin-dev/bitpin-sdk/commit/d896f26e5cfe066b06b8ee99dcae829cb2484f15))
+* **python:** reserve rate-limit slots so concurrent calls don't burst ([d934e3d](https://github.com/bitpin-dev/bitpin-sdk/commit/d934e3dda3a02bb754e3555e4b23faac15d337f5))
+* **python:** safe concurrent token-file saves; keep credentials out of exception chains ([1835e09](https://github.com/bitpin-dev/bitpin-sdk/commit/1835e09d9fbd5023d2c99e064609a2eb00d7c61a))
+* **python:** ticker change is a ratio, report it as ccxt percentage ([d81d56e](https://github.com/bitpin-dev/bitpin-sdk/commit/d81d56ec33e32ffe3c0e92325b7f72c6d1f7c4b7))
+
+
+### Documentation
+
+* **ai:** agent instructions, rules, skills and permissions ([0b5989a](https://github.com/bitpin-dev/bitpin-sdk/commit/0b5989ad4a41323487d3d7efe0d711031796189a))
+* bilingual documentation and llms.txt ([69e7f6a](https://github.com/bitpin-dev/bitpin-sdk/commit/69e7f6a5e0c4cb276796c1c0c7c411a5626d0f45))
+* **examples:** add dry-run examples ([58620ac](https://github.com/bitpin-dev/bitpin-sdk/commit/58620ac1999ef10f2a503b43df6eae32a71d8cae))

bitpin_sdk-0.1.0/LICENSE

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

bitpin_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,61 @@
+Metadata-Version: 2.5
+Name: bitpin-sdk
+Version: 0.1.0
+Summary: Official Python SDK for the Bitpin exchange API (REST + WebSocket, sync + async)
+Project-URL: Homepage, https://github.com/bitpin-dev/bitpin-sdk
+Project-URL: Documentation, https://bitpin-dev.github.io/bitpin-sdk/
+Project-URL: Source, https://github.com/bitpin-dev/bitpin-sdk/tree/main/python
+Project-URL: Changelog, https://github.com/bitpin-dev/bitpin-sdk/blob/main/python/CHANGELOG.md
+Project-URL: Issues, https://github.com/bitpin-dev/bitpin-sdk/issues
+Author: Bitpin
+License-Expression: MIT
+License-File: LICENSE
+Keywords: bitpin,ccxt,crypto,exchange,market-making,sdk,trading
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Financial and Insurance Industry
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+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: Programming Language :: Python :: 3.14
+Classifier: Topic :: Office/Business :: Financial :: Investment
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: tomli>=2.0; python_version < '3.11'
+Provides-Extra: ws
+Requires-Dist: centrifuge-python<1,>=0.4; extra == 'ws'
+Description-Content-Type: text/markdown
+
+# bitpin-sdk
+
+The official Python SDK for the [Bitpin](https://bitpin.ir) exchange API: sync `Bitpin` and async `AsyncBitpin`, ccxt method names and result structures, `Decimal` numbers, automatic token refresh, client-side rate limiting with overridable VIP limits, and WebSocket streams.
+
+SDK رسمی پایتون برای API صرافی بیت‌پین. [مستندات فارسی](https://bitpin-dev.github.io/bitpin-sdk/fa/)
+
+```bash
+pip install bitpin-sdk          # REST
+pip install "bitpin-sdk[ws]"    # + WebSocket
+```
+
+```python
+from bitpin_sdk import Bitpin, Config
+
+with Bitpin(Config.from_env()) as client:          # BITPIN_API_KEY, BITPIN_SECRET_KEY
+    print(client.fetch_ticker("BTC/IRT")["last"])
+    order = client.create_order("USDT/IRT", "limit", "buy", "10", "90000",
+                                {"clientOrderId": "bot-1"})
+    client.cancel_order_by_identifier("bot-1")
+```
+
+Bitpin has no sandbox: every call is real.
+
+- [Documentation](https://bitpin-dev.github.io/bitpin-sdk/) (English and Persian)
+- [Examples](https://github.com/bitpin-dev/bitpin-sdk/tree/main/examples/python)
+- [llms.txt](https://github.com/bitpin-dev/bitpin-sdk/blob/main/llms.txt) for AI agents
+- [Changelog](https://github.com/bitpin-dev/bitpin-sdk/blob/main/python/CHANGELOG.md)
+- [Security](https://github.com/bitpin-dev/bitpin-sdk/blob/main/SECURITY.md)

bitpin_sdk-0.1.0/README.md

@@ -0,0 +1,28 @@
+# bitpin-sdk
+
+The official Python SDK for the [Bitpin](https://bitpin.ir) exchange API: sync `Bitpin` and async `AsyncBitpin`, ccxt method names and result structures, `Decimal` numbers, automatic token refresh, client-side rate limiting with overridable VIP limits, and WebSocket streams.
+
+SDK رسمی پایتون برای API صرافی بیت‌پین. [مستندات فارسی](https://bitpin-dev.github.io/bitpin-sdk/fa/)
+
+```bash
+pip install bitpin-sdk          # REST
+pip install "bitpin-sdk[ws]"    # + WebSocket
+```
+
+```python
+from bitpin_sdk import Bitpin, Config
+
+with Bitpin(Config.from_env()) as client:          # BITPIN_API_KEY, BITPIN_SECRET_KEY
+    print(client.fetch_ticker("BTC/IRT")["last"])
+    order = client.create_order("USDT/IRT", "limit", "buy", "10", "90000",
+                                {"clientOrderId": "bot-1"})
+    client.cancel_order_by_identifier("bot-1")
+```
+
+Bitpin has no sandbox: every call is real.
+
+- [Documentation](https://bitpin-dev.github.io/bitpin-sdk/) (English and Persian)
+- [Examples](https://github.com/bitpin-dev/bitpin-sdk/tree/main/examples/python)
+- [llms.txt](https://github.com/bitpin-dev/bitpin-sdk/blob/main/llms.txt) for AI agents
+- [Changelog](https://github.com/bitpin-dev/bitpin-sdk/blob/main/python/CHANGELOG.md)
+- [Security](https://github.com/bitpin-dev/bitpin-sdk/blob/main/SECURITY.md)

bitpin_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,103 @@
+[build-system]
+requires = ["hatchling>=1.25"]
+build-backend = "hatchling.build"
+
+[project]
+name = "bitpin-sdk"
+version = "0.1.0"
+description = "Official Python SDK for the Bitpin exchange API (REST + WebSocket, sync + async)"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+authors = [{ name = "Bitpin" }]
+keywords = ["bitpin", "crypto", "exchange", "trading", "sdk", "ccxt", "market-making"]
+classifiers = [
+  "Development Status :: 4 - Beta",
+  "Intended Audience :: Developers",
+  "Intended Audience :: Financial and Insurance Industry",
+  "License :: OSI Approved :: MIT License",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
+  "Topic :: Office/Business :: Financial :: Investment",
+  "Typing :: Typed",
+]
+dependencies = [
+  "httpx>=0.27,<1",
+  "tomli>=2.0; python_version < '3.11'",
+]
+
+[project.optional-dependencies]
+ws = ["centrifuge-python>=0.4,<1"]
+
+[project.urls]
+Homepage = "https://github.com/bitpin-dev/bitpin-sdk"
+Documentation = "https://bitpin-dev.github.io/bitpin-sdk/"
+Source = "https://github.com/bitpin-dev/bitpin-sdk/tree/main/python"
+Changelog = "https://github.com/bitpin-dev/bitpin-sdk/blob/main/python/CHANGELOG.md"
+Issues = "https://github.com/bitpin-dev/bitpin-sdk/issues"
+
+[dependency-groups]
+dev = [
+  "pytest>=8",
+  "pytest-asyncio>=0.24",
+  "pytest-cov>=5",
+  "respx>=0.21",
+  "hypothesis>=6.100",
+  "jsonschema>=4.22",
+  "pyyaml>=6",
+  "ruff>=0.6",
+  "mypy>=1.11",
+  "types-pyyaml",
+  "unasync>=0.6",
+  "centrifuge-python>=0.4,<1",
+]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/bitpin_sdk"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+filterwarnings = ["error"]
+markers = ["live: calls the real Bitpin API (read-only); never run in CI"]
+addopts = "-m 'not live'"
+
+[tool.coverage.run]
+branch = true
+source = ["bitpin_sdk"]
+
+[tool.coverage.report]
+fail_under = 95
+show_missing = true
+exclude_also = ["if TYPE_CHECKING:", "@overload", "raise NotImplementedError", "\\.\\.\\."]
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+extend-exclude = ["src/bitpin_sdk/_generated", "src/bitpin_sdk/_sync"]
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "UP", "B", "S", "SIM", "RUF", "PT", "C4", "ASYNC"]
+ignore = ["S101"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/**" = ["S105", "S106", "S108"]
+
+[tool.mypy]
+strict = true
+python_version = "3.10"
+files = ["src"]
+
+[[tool.mypy.overrides]]
+module = ["tomli", "centrifuge", "centrifuge.*", "respx"]
+ignore_missing_imports = true
+
+[tool.hatch.build.targets.sdist]
+exclude = [".hypothesis", ".venv", "dist"]

bitpin_sdk-0.1.0/src/bitpin_sdk/__init__.py

@@ -0,0 +1,26 @@
+"""Official Python SDK for the Bitpin exchange.
+
+    from bitpin_sdk import Bitpin, AsyncBitpin, Config
+
+See https://bitpin-dev.github.io/bitpin-sdk/ for the full documentation.
+"""
+
+__version__ = "0.1.0"  # x-release-please-version
+
+from bitpin_sdk import errors
+from bitpin_sdk._async.client import AsyncBitpin
+from bitpin_sdk._sync.client import Bitpin
+from bitpin_sdk.config import Config, RateLimit
+from bitpin_sdk.token_store import FileTokenStore, MemoryTokenStore, TokenStore
+
+__all__ = [
+    "AsyncBitpin",
+    "Bitpin",
+    "Config",
+    "FileTokenStore",
+    "MemoryTokenStore",
+    "RateLimit",
+    "TokenStore",
+    "__version__",
+    "errors",
+]

bitpin_sdk-0.1.0/src/bitpin_sdk/_async/__init__.py

@@ -0,0 +1 @@
+"""The async client. The hand-written source of truth; ``_sync`` is generated from it."""

bitpin_sdk-0.1.0/src/bitpin_sdk/_async/_compat.py

@@ -0,0 +1,16 @@
+"""Async primitives. ``_sync/_compat.py`` is the hand-written sync counterpart."""
+
+from __future__ import annotations
+
+import asyncio
+from typing import Any
+
+Lock = asyncio.Lock
+default_sleep = asyncio.sleep
+
+
+def websocket(client: Any, transport_factory: Any) -> Any:
+    """The WebSocket client behind ``AsyncBitpin.watch_*``."""
+    from bitpin_sdk.ws.client import BitpinWS
+
+    return BitpinWS(client, transport_factory=transport_factory)