exir-py-lib 1.0.1__tar.gz

exir_py_lib-1.0.1/LICENSE

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

exir_py_lib-1.0.1/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include requirements.txt
+include LICENSE
+recursive-include example *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

exir_py_lib-1.0.1/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: exir-py-lib
+Version: 1.0.1
+Summary: Python client library for EXIR cryptocurrency exchange API
+Author-email: EXIR Team <support@exir.io>
+Maintainer-email: EXIR Team <support@exir.io>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/exirorg/exir-py-lib
+Project-URL: Documentation, https://gitlab.com/exirorg/exir-py-lib#readme
+Project-URL: Repository, https://gitlab.com/exirorg/exir-py-lib.git
+Keywords: cryptocurrency,trading,exchange,api,websocket,exir
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3,>=2.28
+Requires-Dist: websocket-client<2,>=1.6
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Dynamic: license-file
+
+## EXIR Python Client - Examples
+
+This repository contains a lightweight Python client in `index.py` and runnable examples under `example/` for:
+- **Public**: Fetching market data (e.g., ticker)
+- **Private**: Authenticated calls (user, balance, place orders)
+- **WebSocket**: Streaming market data (orderbook)
+
+### Requirements
+- Python 3.8+
+- Install dependencies:
+
+```bash
+python3 -m pip install -r requirements.txt
+```
+
+### Project layout
+- `index.py`: EXIR client (public, private, and WebSocket helpers)
+- `utils.py`: HTTP and auth utilities
+- `example/public.py`: Public ticker example
+- `example/balance.py`: Private user + balance example
+- `example/order.py`: Private create order example
+- `example/websocket.py`: WebSocket orderbook subscription example
+
+---
+
+## Public usage
+
+Fetch the ticker for `btc-usdt`:
+
+```bash
+python3 example/public.py
+```
+
+Example:
+
+```bash
+python3 example/public.py
+```
+
+---
+
+## Private usage (user, balance)
+
+Set your api keys:
+```bash
+EXIR_API_KEY=<your-api-key> \
+EXIR_API_SECRET=<your-api-secret> \
+```
+
+Notes:
+- Ensure your key has the required permissions (e.g., trading, read balance).
+- If IP whitelisting is enabled on the key, include your current IP.
+- Your system clock must be accurate; auth uses expiring signatures.
+
+---
+
+## Private usage (create order)
+
+Places a limit BUY order for 0.001 BTC at 50,000 USDT on `btc-usdt`:
+
+If you receive `401 Unauthorized` when creating orders:
+- Check key permissions and IP whitelist
+- Ensure your system clock is in sync
+
+---
+
+## WebSocket usage (orderbook)
+
+Subscribes to `orderbook:btc-usdt` and logs messages for ~10 seconds:
+
+Notes:
+- Public WS channels (e.g., `orderbook`, `trade`) do not require credentials, but the script will include them if provided.
+- The client automatically reconnects by default.

exir_py_lib-1.0.1/README.md

@@ -0,0 +1,73 @@
+## EXIR Python Client - Examples
+
+This repository contains a lightweight Python client in `index.py` and runnable examples under `example/` for:
+- **Public**: Fetching market data (e.g., ticker)
+- **Private**: Authenticated calls (user, balance, place orders)
+- **WebSocket**: Streaming market data (orderbook)
+
+### Requirements
+- Python 3.8+
+- Install dependencies:
+
+```bash
+python3 -m pip install -r requirements.txt
+```
+
+### Project layout
+- `index.py`: EXIR client (public, private, and WebSocket helpers)
+- `utils.py`: HTTP and auth utilities
+- `example/public.py`: Public ticker example
+- `example/balance.py`: Private user + balance example
+- `example/order.py`: Private create order example
+- `example/websocket.py`: WebSocket orderbook subscription example
+
+---
+
+## Public usage
+
+Fetch the ticker for `btc-usdt`:
+
+```bash
+python3 example/public.py
+```
+
+Example:
+
+```bash
+python3 example/public.py
+```
+
+---
+
+## Private usage (user, balance)
+
+Set your api keys:
+```bash
+EXIR_API_KEY=<your-api-key> \
+EXIR_API_SECRET=<your-api-secret> \
+```
+
+Notes:
+- Ensure your key has the required permissions (e.g., trading, read balance).
+- If IP whitelisting is enabled on the key, include your current IP.
+- Your system clock must be accurate; auth uses expiring signatures.
+
+---
+
+## Private usage (create order)
+
+Places a limit BUY order for 0.001 BTC at 50,000 USDT on `btc-usdt`:
+
+If you receive `401 Unauthorized` when creating orders:
+- Check key permissions and IP whitelist
+- Ensure your system clock is in sync
+
+---
+
+## WebSocket usage (orderbook)
+
+Subscribes to `orderbook:btc-usdt` and logs messages for ~10 seconds:
+
+Notes:
+- Public WS channels (e.g., `orderbook`, `trade`) do not require credentials, but the script will include them if provided.
+- The client automatically reconnects by default.

exir_py_lib-1.0.1/example/balance.py

@@ -0,0 +1,48 @@
+import json
+import logging
+import os
+import sys
+import types
+import importlib
+
+
+def _prepare_local_package():
+    repo_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    package_name = "exir"
+
+    if package_name not in sys.modules:
+        pkg = types.ModuleType(package_name)
+        pkg.__path__ = [repo_root]
+        sys.modules[package_name] = pkg
+
+
+def main():
+    _prepare_local_package()
+
+    EXIR = importlib.import_module("exir.index").EXIR  # type: ignore[attr-defined]
+
+    logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")
+
+    # Initialize with API credentials (replace with yours or env vars)
+    api_key = os.getenv("EXIR_API_KEY", "<your-api-key>")
+    api_secret = os.getenv("EXIR_API_SECRET", "<your-api-secret>")
+
+    client = EXIR(api_url=api_url, api_key=api_key, api_secret=api_secret)
+
+    try:
+        user = client.get_user()
+        logging.info("User response:\n%s", json.dumps(user, indent=2))
+    except Exception as exc:
+        logging.exception("Failed to fetch user: %s", exc)
+
+    try:
+        balance = client.get_balance()
+        logging.info("Balance response:\n%s", json.dumps(balance, indent=2))
+    except Exception as exc:
+        logging.exception("Failed to fetch balance: %s", exc)
+
+
+if __name__ == "__main__":
+    main()
+
+

exir_py_lib-1.0.1/example/order.py

@@ -0,0 +1,42 @@
+import json
+import logging
+import os
+import sys
+import types
+import importlib
+
+
+def _prepare_local_package():
+    repo_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    package_name = "exir"
+
+    if package_name not in sys.modules:
+        pkg = types.ModuleType(package_name)
+        pkg.__path__ = [repo_root]
+        sys.modules[package_name] = pkg
+
+
+def main():
+    _prepare_local_package()
+
+    EXIR = importlib.import_module("exir.index").EXIR  # type: ignore[attr-defined]
+
+    logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")
+
+    api_key = os.getenv("EXIR_API_KEY", "<your-api-key>")
+    api_secret = os.getenv("EXIR_API_SECRET", "<your-api-secret>")
+
+    client = EXIR(api_url=api_url, api_key=api_key, api_secret=api_secret)
+
+    symbol = "btc-usdt"
+    try:
+        order = client.create_order(symbol=symbol, side="buy", size=0.001, type="limit", price=50000)
+        logging.info("Create order response:\n%s", json.dumps(order, indent=2))
+    except Exception as exc:
+        logging.exception("Failed to create order: %s", exc)
+
+
+if __name__ == "__main__":
+    main()
+
+

exir_py_lib-1.0.1/example/public.py

@@ -0,0 +1,40 @@
+import json
+import logging
+import os
+import sys
+import types
+import importlib
+
+
+def _prepare_local_package():
+    repo_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    package_name = "exir"
+
+    if package_name not in sys.modules:
+        pkg = types.ModuleType(package_name)
+        pkg.__path__ = [repo_root]
+        sys.modules[package_name] = pkg
+
+
+def main():
+    _prepare_local_package()
+
+    # Import from the local package so relative imports inside index.py work
+    EXIR = importlib.import_module("exir.index").EXIR  # type: ignore[attr-defined]
+
+    logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")
+
+    client = EXIR()
+
+    symbol = "btc-irt"
+    logging.info("Requesting ticker for symbol=%s", symbol)
+    try:
+        ticker = client.get_ticker(symbol=symbol)
+        logging.info("Ticker response:\n%s", json.dumps(ticker, indent=2))
+    except Exception as exc:
+        logging.exception("Failed to fetch ticker: %s", exc)
+
+if __name__ == "__main__":
+    main()
+
+

exir_py_lib-1.0.1/example/ws.py

@@ -0,0 +1,65 @@
+import json
+import logging
+import os
+import sys
+import types
+import importlib
+import time
+
+
+def _prepare_local_package():
+    repo_root = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+    package_name = "exir"
+
+    if package_name not in sys.modules:
+        pkg = types.ModuleType(package_name)
+        pkg.__path__ = [repo_root]
+        sys.modules[package_name] = pkg
+
+
+def main():
+    _prepare_local_package()
+
+    EXIR = importlib.import_module("exir.index").EXIR  # type: ignore[attr-defined]
+
+    logging.basicConfig(level=logging.INFO, format="%(asctime)s %(levelname)s %(message)s")
+
+    api_key = os.getenv("EXIR_API_KEY", "<your-api-key>")
+    api_secret = os.getenv("EXIR_API_SECRET", "<your-api-secret>")
+
+    client = EXIR(api_url=api_url, api_key=api_key, api_secret=api_secret, ws_url=ws_url)
+
+
+    symbol = "btc-usdt"
+
+    def on_message(message: str):
+        try:
+            payload = json.loads(message)
+        except Exception:
+            payload = message
+        logging.info("WS message: %s", payload if isinstance(payload, dict) else str(payload)[:500])
+
+    def on_error(error):
+        logging.error("WS error: %s", error)
+
+    def on_close(status_code, msg):
+        logging.info("WS closed: code=%s msg=%s", status_code, msg)
+
+    try:
+        logging.info("Connecting WebSocket and subscribing to orderbook:%s", symbol)
+        client.connect(events=[f"order"], on_message=on_message, on_error=on_error, on_close=on_close)
+        logging.info("Listening for orderbook updates for 10 seconds...")
+        time.sleep(10)
+    except Exception as exc:
+        logging.exception("WebSocket error: %s", exc)
+    finally:
+        try:
+            client.disconnect()
+        except Exception:
+            pass
+
+
+if __name__ == "__main__":
+    main()
+
+

exir_py_lib-1.0.1/exir_py_lib.egg-info/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.4
+Name: exir-py-lib
+Version: 1.0.1
+Summary: Python client library for EXIR cryptocurrency exchange API
+Author-email: EXIR Team <support@exir.io>
+Maintainer-email: EXIR Team <support@exir.io>
+License-Expression: MIT
+Project-URL: Homepage, https://gitlab.com/exirorg/exir-py-lib
+Project-URL: Documentation, https://gitlab.com/exirorg/exir-py-lib#readme
+Project-URL: Repository, https://gitlab.com/exirorg/exir-py-lib.git
+Keywords: cryptocurrency,trading,exchange,api,websocket,exir
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+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: Topic :: Office/Business :: Financial :: Investment
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: requests<3,>=2.28
+Requires-Dist: websocket-client<2,>=1.6
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Dynamic: license-file
+
+## EXIR Python Client - Examples
+
+This repository contains a lightweight Python client in `index.py` and runnable examples under `example/` for:
+- **Public**: Fetching market data (e.g., ticker)
+- **Private**: Authenticated calls (user, balance, place orders)
+- **WebSocket**: Streaming market data (orderbook)
+
+### Requirements
+- Python 3.8+
+- Install dependencies:
+
+```bash
+python3 -m pip install -r requirements.txt
+```
+
+### Project layout
+- `index.py`: EXIR client (public, private, and WebSocket helpers)
+- `utils.py`: HTTP and auth utilities
+- `example/public.py`: Public ticker example
+- `example/balance.py`: Private user + balance example
+- `example/order.py`: Private create order example
+- `example/websocket.py`: WebSocket orderbook subscription example
+
+---
+
+## Public usage
+
+Fetch the ticker for `btc-usdt`:
+
+```bash
+python3 example/public.py
+```
+
+Example:
+
+```bash
+python3 example/public.py
+```
+
+---
+
+## Private usage (user, balance)
+
+Set your api keys:
+```bash
+EXIR_API_KEY=<your-api-key> \
+EXIR_API_SECRET=<your-api-secret> \
+```
+
+Notes:
+- Ensure your key has the required permissions (e.g., trading, read balance).
+- If IP whitelisting is enabled on the key, include your current IP.
+- Your system clock must be accurate; auth uses expiring signatures.
+
+---
+
+## Private usage (create order)
+
+Places a limit BUY order for 0.001 BTC at 50,000 USDT on `btc-usdt`:
+
+If you receive `401 Unauthorized` when creating orders:
+- Check key permissions and IP whitelist
+- Ensure your system clock is in sync
+
+---
+
+## WebSocket usage (orderbook)
+
+Subscribes to `orderbook:btc-usdt` and logs messages for ~10 seconds:
+
+Notes:
+- Public WS channels (e.g., `orderbook`, `trade`) do not require credentials, but the script will include them if provided.
+- The client automatically reconnects by default.

exir_py_lib-1.0.1/exir_py_lib.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+LICENSE
+MANIFEST.in
+README.md
+pyproject.toml
+requirements.txt
+example/balance.py
+example/order.py
+example/public.py
+example/ws.py
+exir_py_lib.egg-info/PKG-INFO
+exir_py_lib.egg-info/SOURCES.txt
+exir_py_lib.egg-info/dependency_links.txt
+exir_py_lib.egg-info/requires.txt
+exir_py_lib.egg-info/top_level.txt

exir_py_lib-1.0.1/exir_py_lib.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

exir_py_lib-1.0.1/exir_py_lib.egg-info/requires.txt

@@ -0,0 +1,9 @@
+requests<3,>=2.28
+websocket-client<2,>=1.6
+
+[dev]
+pytest>=7.0
+pytest-cov
+black
+flake8
+mypy

exir_py_lib-1.0.1/exir_py_lib.egg-info/top_level.txt

@@ -0,0 +1 @@
+

exir_py_lib-1.0.1/pyproject.toml

@@ -0,0 +1,66 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "exir-py-lib"
+version = "1.0.1"
+description = "Python client library for EXIR cryptocurrency exchange API"
+readme = "README.md"
+license = "MIT"
+authors = [
+    {name = "EXIR Team", email = "support@exir.io"}
+]
+maintainers = [
+    {name = "EXIR Team", email = "support@exir.io"}
+]
+keywords = ["cryptocurrency", "trading", "exchange", "api", "websocket", "exir"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.8",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Office/Business :: Financial :: Investment",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+requires-python = ">=3.8"
+dependencies = [
+    "requests>=2.28,<3",
+    "websocket-client>=1.6,<2",
+]
+
+[project.urls]
+Homepage = "https://gitlab.com/exirorg/exir-py-lib"
+Documentation = "https://gitlab.com/exirorg/exir-py-lib#readme"
+Repository = "https://gitlab.com/exirorg/exir-py-lib.git"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=7.0",
+    "pytest-cov",
+    "black",
+    "flake8",
+    "mypy",
+]
+
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["exir*"]
+
+[tool.setuptools.package-data]
+"*" = ["*.py", "*.md", "*.txt"]
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+python_files = ["test_*.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]

exir_py_lib-1.0.1/requirements.txt

@@ -0,0 +1,2 @@
+requests>=2.28,<3
+websocket-client>=1.6,<2

exir_py_lib-1.0.1/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+