exir-py-lib 1.0.1__py3-none-any.whl

exir_py_lib-1.0.1.dist-info/METADATA

@@ -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.dist-info/RECORD

@@ -0,0 +1,5 @@
+exir_py_lib-1.0.1.dist-info/licenses/LICENSE,sha256=UwKI_2kcMoxETm2FF6_rub3MiGLBXE2ybckamfIpxeE,1087
+exir_py_lib-1.0.1.dist-info/METADATA,sha256=IU21UbY480AQmh46_jLY7CHXvJ37ODNsQY-oHXzSlRA,3382
+exir_py_lib-1.0.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+exir_py_lib-1.0.1.dist-info/top_level.txt,sha256=AbpHGcgLb-kRsJGnwFEktk7uzpZOCcBY74-YBdrKVGs,1
+exir_py_lib-1.0.1.dist-info/RECORD,,

exir_py_lib-1.0.1.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

exir_py_lib-1.0.1.dist-info/licenses/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.dist-info/top_level.txt

@@ -0,0 +1 @@
+