immix-sdk 0.4.0__tar.gz

immix_sdk-0.4.0/LICENSE

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

immix_sdk-0.4.0/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: immix_sdk
+Version: 0.4.0
+Summary: The Python SDK for the Immix API — REST, market data and trading
+License: MIT
+License-File: LICENSE
+Keywords: immix,trading,market data,crypto,api
+Requires-Python: >=3.10,<4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: OS Independent
+Classifier: Operating System :: POSIX
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python
+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: Programming Language :: Python :: 3.14
+Classifier: Programming Language :: Python :: 3.15
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Provides-Extra: aiohttp
+Requires-Dist: aiohttp (>=3.14.1,<4) ; (python_version >= "3.10") and (extra == "aiohttp")
+Requires-Dist: httpx (>=0.21.2)
+Requires-Dist: httpx-aiohttp (>=0.1.8,<0.2.0) ; (python_version >= "3.10") and (extra == "aiohttp")
+Requires-Dist: pydantic (>=1.9.2)
+Requires-Dist: pydantic-core (>=2.18.2,<3.0.0)
+Requires-Dist: typing_extensions (>=4.0.0)
+Requires-Dist: websockets (>=12.0)
+Project-URL: Documentation, https://docs.immix.xyz
+Project-URL: Homepage, https://immix.xyz
+Project-URL: Repository, https://github.com/coinstrats/immix-python-sdk-v3
+Description-Content-Type: text/markdown
+
+# Immix Python SDK
+
+The Python SDK for the Immix API: REST, the market-data stream and the trading socket.
+
+```bash
+pip install immix_sdk
+```
+
+The package installs as `immix_sdk` and imports as `immix`. It needs Python 3.10 or newer. The API
+reference and guides are at [docs.immix.xyz](https://docs.immix.xyz).
+
+## Use
+
+```python
+from immix import Immix, MarketData
+from immix.dataframe import to_frame  # needs pandas, which you install yourself
+from immix.market_data import TradeEvent
+
+# REST: there is no public REST environment yet, so the base URL is the one your onboarding gave you.
+client = Immix(base_url="https://…", token=token)
+me = client.users.get_me()
+
+# A write mints its own Idempotency-Key when you name none, and an order is named by order_id.
+client.orders.cancel(order_id="7185994167554")
+
+# A list response as a DataFrame: money exact, timestamps UTC datetimes, enums by name.
+orders = to_frame(client.orders.list())
+
+# Market data: the public socket by default. The token goes in an `auth` message after
+# connecting, never in the handshake. The stream reconnects and resubscribes by itself, and
+# yields `Reconnected` where the gap is.
+async def stream() -> None:
+    async with MarketData(token=token) as md:
+        await md.subscribe("trade.OKX@BTC/USDT")
+        async for frame in md:
+            ...
+```
+
+- Money is a decimal string. `immix.to_decimal` and `immix.format_decimal` cross to and from
+  `Decimal` exactly, and never through a float. A REST write's money parameters (`qty`, `price`, a
+  policy's `…_amount`) take a `Decimal` or an int too, sent in plain notation
+  (`Decimal("1E-7")` as `"0.0000001"`); a float is refused before anything is sent.
+- **A write mints its own key.** Every write takes an `Idempotency-Key`, and one is minted per call
+  when you name none. The SDK's own retries resend it, so they cannot act twice. Name your own
+  (`immix.new_idempotency_key()` mints one) when you may retry the write yourself, or retry under
+  the key a failed write went out under: its exception carries it, as `idempotency_key`. An asyncio
+  timeout is asyncio's exception, not the write's, so name the key when you bound a write's time. On
+  `orders.submit` the key is the order's `clientOrderId`, so name either one.
+- **An order is named by `order_id`**, the platform's id on every order row:
+  `orders.get(order_id=…)`, `orders.cancel(order_id=…)`. REST cannot cancel by `client_order_id`;
+  the trading socket's `cancel_order` takes either.
+- **Rows as DataFrames.** `immix.dataframe.to_frame` takes a list response, one row, or rows. Money
+  columns are exact `Decimal`s (`money="float"` reads floats, for a plot), epoch-nanosecond columns
+  are UTC datetimes, and enums are their names. pandas is not a dependency: `pip install pandas`.
+
+## Development
+
+How this repository changes and how a version ships: `DEVELOPING.md`.
+
+## License
+
+MIT. See `LICENSE`.
+

immix_sdk-0.4.0/README.md

@@ -0,0 +1,62 @@
+# Immix Python SDK
+
+The Python SDK for the Immix API: REST, the market-data stream and the trading socket.
+
+```bash
+pip install immix_sdk
+```
+
+The package installs as `immix_sdk` and imports as `immix`. It needs Python 3.10 or newer. The API
+reference and guides are at [docs.immix.xyz](https://docs.immix.xyz).
+
+## Use
+
+```python
+from immix import Immix, MarketData
+from immix.dataframe import to_frame  # needs pandas, which you install yourself
+from immix.market_data import TradeEvent
+
+# REST: there is no public REST environment yet, so the base URL is the one your onboarding gave you.
+client = Immix(base_url="https://…", token=token)
+me = client.users.get_me()
+
+# A write mints its own Idempotency-Key when you name none, and an order is named by order_id.
+client.orders.cancel(order_id="7185994167554")
+
+# A list response as a DataFrame: money exact, timestamps UTC datetimes, enums by name.
+orders = to_frame(client.orders.list())
+
+# Market data: the public socket by default. The token goes in an `auth` message after
+# connecting, never in the handshake. The stream reconnects and resubscribes by itself, and
+# yields `Reconnected` where the gap is.
+async def stream() -> None:
+    async with MarketData(token=token) as md:
+        await md.subscribe("trade.OKX@BTC/USDT")
+        async for frame in md:
+            ...
+```
+
+- Money is a decimal string. `immix.to_decimal` and `immix.format_decimal` cross to and from
+  `Decimal` exactly, and never through a float. A REST write's money parameters (`qty`, `price`, a
+  policy's `…_amount`) take a `Decimal` or an int too, sent in plain notation
+  (`Decimal("1E-7")` as `"0.0000001"`); a float is refused before anything is sent.
+- **A write mints its own key.** Every write takes an `Idempotency-Key`, and one is minted per call
+  when you name none. The SDK's own retries resend it, so they cannot act twice. Name your own
+  (`immix.new_idempotency_key()` mints one) when you may retry the write yourself, or retry under
+  the key a failed write went out under: its exception carries it, as `idempotency_key`. An asyncio
+  timeout is asyncio's exception, not the write's, so name the key when you bound a write's time. On
+  `orders.submit` the key is the order's `clientOrderId`, so name either one.
+- **An order is named by `order_id`**, the platform's id on every order row:
+  `orders.get(order_id=…)`, `orders.cancel(order_id=…)`. REST cannot cancel by `client_order_id`;
+  the trading socket's `cancel_order` takes either.
+- **Rows as DataFrames.** `immix.dataframe.to_frame` takes a list response, one row, or rows. Money
+  columns are exact `Decimal`s (`money="float"` reads floats, for a plot), epoch-nanosecond columns
+  are UTC datetimes, and enums are their names. pandas is not a dependency: `pip install pandas`.
+
+## Development
+
+How this repository changes and how a version ships: `DEVELOPING.md`.
+
+## License
+
+MIT. See `LICENSE`.

immix_sdk-0.4.0/pyproject.toml

@@ -0,0 +1,107 @@
+[project]
+name = "immix_sdk"
+dynamic = ["version"]
+
+[tool.poetry]
+name = "immix_sdk"
+version = "0.4.0"
+description = "The Python SDK for the Immix API — REST, market data and trading"
+readme = "README.md"
+authors = []
+keywords = [
+    "immix",
+    "trading",
+    "market data",
+    "crypto",
+    "api"
+]
+license = "MIT"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "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",
+    "Programming Language :: Python :: 3.15",
+    "Operating System :: OS Independent",
+    "Operating System :: POSIX",
+    "Operating System :: MacOS",
+    "Operating System :: POSIX :: Linux",
+    "Operating System :: Microsoft :: Windows",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Typing :: Typed",
+    "License :: OSI Approved :: MIT License"
+]
+packages = [
+    { include = "immix", from = "src"}
+]
+
+[tool.poetry.urls]
+Documentation = 'https://docs.immix.xyz'
+Homepage = 'https://immix.xyz'
+Repository = 'https://github.com/coinstrats/immix-python-sdk-v3'
+
+[tool.poetry.dependencies]
+python = "^3.10"
+aiohttp = { version = ">=3.14.1,<4", optional = true, python = ">=3.10"}
+httpx = ">=0.21.2"
+httpx-aiohttp = { version = "^0.1.8", optional = true, python = ">=3.10"}
+pydantic = ">= 1.9.2"
+pydantic-core = ">=2.18.2,<3.0.0"
+typing_extensions = ">= 4.0.0"
+websockets = ">=12.0"
+
+[tool.poetry.group.dev.dependencies]
+mypy = "==1.13.0"
+pytest = "^9.0.3"
+pytest-asyncio = "^1.0.0"
+pytest-xdist = "^3.6.1"
+python-dateutil = "^2.9.0"
+types-python-dateutil = "^2.9.0.20240316"
+urllib3 = ">=2.6.3,<3.0.0"
+ruff = "==0.11.5"
+
+[tool.pytest.ini_options]
+testpaths = [ "tests" ]
+asyncio_mode = "auto"
+norecursedirs = [ "src" ]
+markers = [
+    "aiohttp: tests that require httpx_aiohttp to be installed",
+]
+
+[tool.mypy]
+plugins = ["pydantic.mypy"]
+
+[tool.ruff]
+line-length = 120
+
+[tool.ruff.lint]
+select = [
+    "E",  # pycodestyle errors
+    "F",  # pyflakes
+    "I",  # isort
+]
+ignore = [
+    "E402",  # Module level import not at top of file
+    "E501",  # Line too long
+    "E711",  # Comparison to `None` should be `cond is not None`
+    "E712",  # Avoid equality comparisons to `True`; use `if ...:` checks
+    "E721",  # Use `is` and `is not` for type comparisons, or `isinstance()` for insinstance checks
+    "E722",  # Do not use bare `except`
+    "E731",  # Do not assign a `lambda` expression, use a `def`
+    "F821",  # Undefined name
+    "F841"   # Local variable ... is assigned to but never used
+]
+
+[tool.ruff.lint.isort]
+section-order = ["future", "standard-library", "third-party", "first-party"]
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"
+
+[tool.poetry.extras]
+aiohttp=["aiohttp", "httpx-aiohttp"]