HedgeTech 0.2.2b0__tar.gz → 0.2.3__tar.gz

{hedgetech-0.2.2b0 → hedgetech-0.2.3}/HedgeTech/EmsEngine/__tse_ifb/__AsyncClient.py

@@ -169,7 +169,12 @@ class Order:
 
         Example
         -------
-        >>> await order.Edit(Price=105, Volume=15)
+        >>> await order.Edit(
+            Price = 105,
+            Volume = 15,
+            Order_ValidityType = 'GTD',
+            ValidityDate = 20271206
+        )
         """
         
         if self.OrderId is not None: 
@@ -405,6 +410,7 @@ class EmsEngine_TseIfb_AsyncClient:
     
     async def oms_login(
         self,
+        *,
         username: str,
         password: str,
         captcha_value: str,
@@ -433,7 +439,11 @@ class EmsEngine_TseIfb_AsyncClient:
 
         Example
         -------
-        >>> await client.oms_login("user123", "pass123", "abcd")
+        >>> await client.oms_login(
+            username = "user123",
+            password = "pass123",
+            captcha_value = "abcd"
+        )
         >>> print(client.oms_session)
         'session_token_here'
         """
@@ -509,7 +519,13 @@ class EmsEngine_TseIfb_AsyncClient:
 
         Example
         -------
-        >>> order = await client.Buy_by_Name(symbolName="اطلس", Price=100000, Volume=10)
+        >>> order = await client.Buy_by_Name(
+            symbolName="اطلس",
+            Price=100000,
+            Volume=10,
+            Order_ValidityType = 'DAY',
+            ValidityDate = 0
+        )
         >>> await order.send()
         """
         
@@ -581,7 +597,13 @@ class EmsEngine_TseIfb_AsyncClient:
 
         Example
         -------
-        >>> order = await client.Sell_by_Name(symbolName="اطلس", Price=100000, Volume=10)
+        >>> order = await client.Sell_by_Name(
+            symbolName="اطلس",
+            Price=100000,
+            Volume=10,
+            Order_ValidityType = 'DAY',
+            ValidityDate = 0
+        )
         >>> await order.send()
         """
         
@@ -652,7 +674,13 @@ class EmsEngine_TseIfb_AsyncClient:
 
         Example
         -------
-        >>> order = await client.Buy_by_isin(symbolIsin="اطلس", Price=100000, Volume=10)
+        >>> order = await client.Buy_by_isin(
+            symbolName="اطلس",
+            Price=100000,
+            Volume=10,
+            Order_ValidityType = 'DAY',
+            ValidityDate = 0
+        )
         >>> await order.send()
         """
         
@@ -723,7 +751,13 @@ class EmsEngine_TseIfb_AsyncClient:
 
         Example
         -------
-        >>> order = await client.Sell_by_isin(symbolIsin="اطلس", Price=100000, Volume=10)
+        >>> order = await client.Sell_by_isin(
+            symbolName="اطلس",
+            Price=100000,
+            Volume=10,
+            Order_ValidityType = 'DAY',
+            ValidityDate = 0
+        )
         >>> await order.send()
         """
         

{hedgetech-0.2.2b0 → hedgetech-0.2.3}/HedgeTech/EmsEngine/__tse_ifb/__SyncClient.py

@@ -181,7 +181,12 @@ class Order:
 
         Examples
         --------
-        >>> order.Edit(Price=12500, Volume=800)
+        >>> order.Edit(
+            Price = 105,
+            Volume = 15,
+            Order_ValidityType = 'GTD',
+            ValidityDate = 20271206
+        )
         """
         
         if self.OrderId is not None: 
@@ -436,6 +441,7 @@ class EmsEngine_TseIfb_SyncClient:
             
     def oms_login(
         self,
+        *,
         username: str,
         password: str,
         captcha_value: str,
@@ -465,7 +471,11 @@ class EmsEngine_TseIfb_SyncClient:
 
         Examples
         --------
-        >>> client.oms_login("user1", "pass123", "A7B9")
+        >>> client.oms_login(
+            username = "user123",
+            password = "pass123",
+            captcha_value = "abcd"
+        )
         """
         
         response = self.__AuthSyncClient.httpx_Client.post(
@@ -542,7 +552,9 @@ class EmsEngine_TseIfb_SyncClient:
         >>> order = client.Buy_by_Name(
         ...     symbolName="اهرم",
         ...     Price=12000,
-        ...     Volume=1000
+        ...     Volume=1000,
+        ...     Order_ValidityType = 'DAY',
+        ...     ValidityDate = 0
         ... )
         >>> order.send()
         """
@@ -615,7 +627,9 @@ class EmsEngine_TseIfb_SyncClient:
         >>> order = client.Sell_by_Name(
         ...     symbolName="اهرم",
         ...     Price=12000,
-        ...     Volume=1000
+        ...     Volume=1000,
+        ...     Order_ValidityType = 'DAY',
+        ...     ValidityDate = 0
         ... )
         >>> order.send()
         """
@@ -686,7 +700,9 @@ class EmsEngine_TseIfb_SyncClient:
         >>> order = client.Buy_by_isin(
         ...     symbolName="اهرم",
         ...     Price=12000,
-        ...     Volume=1000
+        ...     Volume=1000,
+        ...     Order_ValidityType = 'DAY',
+        ...     ValidityDate = 0
         ... )
         >>> order.send()
         """
@@ -757,7 +773,9 @@ class EmsEngine_TseIfb_SyncClient:
         >>> order = client.Sell_by_isin(
         ...     symbolName="اهرم",
         ...     Price=12000,
-        ...     Volume=1000
+        ...     Volume=1000,
+        ...     Order_ValidityType = 'DAY',
+        ...     ValidityDate = 0
         ... )
         >>> order.send()
         """

{hedgetech-0.2.2b0 → hedgetech-0.2.3}/HedgeTech.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: HedgeTech
-Version: 0.2.2b0
+Version: 0.2.3
 Summary: A unified, high-performance API layer that powers all trading infrastructure across the HedgeTech ecosystem, providing modular, scalable, and real-time interfaces for market data, order management, and execution systems.
 Author-email: "hedgetech.ir" <info@hedgetech.ir>
 License:                                  Apache License
@@ -193,7 +193,7 @@ Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 4 - Beta
+Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: Topic :: Office/Business :: Financial
@@ -217,232 +217,377 @@ Dynamic: license-file
 
 # HedgeTech Python SDK
 
-HedgeTech Python SDK is a professional, lightweight, and modular Python package designed to provide seamless access to HedgeTech services. The SDK is crafted for developers, data analysts, and algorithmic traders who want to interact with the Tehran Stock Exchange (TSE & IFB) using a clean, reliable, and easy-to-use API. It supports both synchronous and asynchronous workflows, offering maximum flexibility and performance for different application scenarios.
+HedgeTech Python SDK is a professional, lightweight, and modular Python
+package designed to provide seamless access to HedgeTech services. The
+SDK is crafted for developers, data analysts, and algorithmic traders
+who want to interact with the Tehran Stock Exchange (TSE & IFB) using a
+clean, reliable, and easy-to-use API.
 
-> **Note:** This SDK requires Python >= 3.10 and is currently in Beta. Some APIs may change in future releases, but it is stable enough for daily use.
+It supports both synchronous and asynchronous workflows, offering
+maximum flexibility and performance for different application scenarios.
+
+> **Note:** This SDK requires Python >= 3.10 and is production-ready.
+> Development Status: **5 - Production/Stable**.
+> The public APIs are stable and safe for long-term use.
+
+------------------------------------------------------------------------
 
 ## Features
 
-* Secure authentication with both async and sync clients.
-* Real-time and historical market data retrieval from TSE & IFB.
-* Full EMS Engine order management (buy/sell, edit, status, delete) for both Sync and Async workflows.
-* Modular and maintainable architecture, designed to support multiple engines (DataEngine engines, WebSocket clients, etc.).
-* Structured request and response types for robust data handling.
-* Fully asynchronous support for high-performance applications.
-* Easy to integrate into trading bots, analytics pipelines, dashboards, or WebSocket feeds.
+-   Secure authentication with async and sync clients.
+-   Real-time and historical market data from TSE & IFB.
+-   Full EMS Engine order lifecycle management.
+-   Modular architecture (Auth, DataEngine, EMSEngine).
+-   Structured request/response types.
+-   High-performance asyncio support.
+-   Easy integration with trading bots and dashboards.
+
+------------------------------------------------------------------------
 
 ## Installation
 
-Install HedgeTech SDK via PyPI:
+Install via PyPI:
 
-```
+``` bash
 pip install HedgeTech
 ```
 
-### Updating the Package
-
-To update HedgeTech SDK to the latest version in your environment, use:
+### Update
 
-```
+``` bash
 pip install --upgrade HedgeTech
 ```
 
-## Usage
+------------------------------------------------------------------------
+
+## Package Structure
 
-The SDK exposes all major clients through the top-level modules, so you generally do **not** need to import internal implementation files directly.
+    HedgeTech/
+     ├── Auth/
+     ├── DataEngine/
+     ├── EMSEngine/
+     └── __init__.py
+
+------------------------------------------------------------------------
 
 ## Authentication
 
-> **Note:** Make sure to use the matching async or sync Auth client depending on your workflow.
+All services require authentication.
+
+> Use matching Sync/Async clients.
 
 ### Async Authentication
 
-```python
+``` python
 from HedgeTech.Auth import AuthAsyncClient
 
 auth_async_client = await AuthAsyncClient.login(
-    UserName_or_Email='<YOUR UserName_or_Email>',
-    Password='<YOUR Password>'
+    UserName_or_Email="user@example.com",
+    Password="password"
 )
+
 print(auth_async_client.token)
 ```
 
 ### Sync Authentication
 
-```python
+``` python
 from HedgeTech.Auth import AuthSyncClient
 
 auth_sync_client = AuthSyncClient.login(
-    UserName_or_Email='<YOUR UserName_or_Email>',
-    Password='<YOUR Password>'
+    UserName_or_Email="user@example.com",
+    Password="password"
 )
+
 print(auth_sync_client.token)
 ```
 
-## DataEngine / TSE IFB
+------------------------------------------------------------------------
+
+## DataEngine (Market Data)
+
+The DataEngine module provides unified access to:
 
-The DataEngine is designed to support multiple engines in a modular way. Each engine provides its own async and sync clients, structured request and response types, and can be integrated with other engines such as WebSocket clients.
+-   Live market data
+-   Historical OHLCV
+-   Order books
+-   Best limits
+-   WebSocket streams
 
-> **Important Note on Sync vs Async:** All clients have the **same method names and behavior** in both Sync and Async versions. The only difference is how they execute: Sync runs in a blocking manner, while Async requires `await` and an event loop. This design allows you to switch between Sync and Async without changing the logic or input/output of your code.
+All engines follow identical Sync/Async APIs.
 
-### Async Data Client
+------------------------------------------------------------------------
 
-```python
+### Async Data Example
+
+``` python
 from HedgeTech.DataEngine import DataEngine_TseIfb_AsyncClient
 
 client = DataEngine_TseIfb_AsyncClient(auth_async_client)
+
 data = await client.live_best_limit_by_isin(
-    symbol_isins=['IRT1AHRM0001','IRO1IKCO0001']
+    symbol_isins=["IRT1AHRM0001","IRO1IKCO0001"]
 )
-print(data)
 
-# websocket Example
+print(data)
 
 async for update in client.websocket_by_name(
-    channels=["best-limit", "order-book"],
+    channels=["best-limit","order-book"],
     symbol_names=["فملی","اطلس"]
 ):
     print(update["data"])
 ```
 
-### Sync Data Client
+------------------------------------------------------------------------
 
-```python
+### Sync Data Example
+
+``` python
 from HedgeTech.DataEngine import DataEngine_TseIfb_SyncClient
 
 client = DataEngine_TseIfb_SyncClient(auth_sync_client)
+
 data = client.historical_ohlcv_by_name(
-    symbolName='مهرگان',
+    symbolName="مهرگان",
     start_timestamp=0,
-    end_timestamp='1763411432',
+    end_timestamp="1763411432",
     AdjustedPrice=True,
-    Resolution='D'
+    Resolution="D"
 )
-print(data)
 
-# websocket Example
+print(data)
 
 for update in client.websocket_by_isin(
-    channels=["best-limit", "order-book"],
+    channels=["best-limit","order-book"],
     symbol_isins=["IR1234567890"]
 ):
     print(update["data"])
 ```
 
-## EMS Engine / Order Management
+------------------------------------------------------------------------
+
+## EMSEngine (Order Management)
+
+The EMSEngine module handles complete order management.
+
+Supported markets: - TSE - IFB
+
+------------------------------------------------------------------------
+
+### EMSEngine Features
 
-The SDK provides full **order lifecycle management** for TSE/IFB markets. You can create, edit, delete, and check the status of buy/sell orders with both Sync and Async clients.
+-   Buy/Sell by Name or ISIN
+-   Edit Orders
+-   Cancel/Delete Orders
+-   Real-time Status
+-   Async/Sync Compatibility
+-   Order Object Lifecycle
 
-### Features
+------------------------------------------------------------------------
 
-* Create buy/sell orders by symbol name or ISIN.
-* Edit orders (price, volume, validity type/date).
-* Retrieve current order status including executed and remaining volume.
-* Delete/cancel orders.
-* Fully Async/Sync compatible with identical method names.
+## Order Lifecycle
 
-### Async Example
+1.  Create Order
+2.  Send
+3.  Monitor Status
+4.  Edit (Optional)
+5.  Settle or Delete
 
-```python
+------------------------------------------------------------------------
+
+## Async Trading Example
+
+``` python
 from HedgeTech.EMSEngine import EmsEngine_TseIfb_AsyncClient
 
-ems_client = EmsEngine_TseIfb_AsyncClient(auth_async_client)
+ems = EmsEngine_TseIfb_AsyncClient(auth_async_client)
 
-# Login to OMS
-await ems_client.oms_login("username", "password", "captcha_value")
+captcha = await ems.Get_Captcha("Omex | Parsian")
+captcha.show()
+
+await ems.oms_login(
+    username="user",
+    password="pass",
+    captcha_value="1234"
+)
 
-# Create a buy order
-order = await ems_client.Buy_by_Name(
+order = await ems.Buy_by_Name(
     symbolName="اطلس",
     Price=100000,
     Volume=10
 )
+
 await order.send()
 
-# Check status
 status = await order.Status()
 print(status)
 
-# Edit order
 await order.Edit(Price=105000, Volume=12)
 
-# Delete order
 await order.Delete()
-print(order.is_deleted)  # True
 ```
 
-### Sync Example
+------------------------------------------------------------------------
+
+## Sync Trading Example
 
-```python
+``` python
 from HedgeTech.EMSEngine import EmsEngine_TseIfb_SyncClient
 
-ems_client = EmsEngine_TseIfb_SyncClient(auth_sync_client)
+ems = EmsEngine_TseIfb_SyncClient(auth_sync_client)
 
-# Login to OMS
-ems_client.oms_login("username", "password", "captcha_value")
+captcha = ems.Get_Captcha("Omex | Parsian")
+captcha.show()
+
+ems.oms_login(
+    username="user",
+    password="pass",
+    captcha_value="1234"
+)
 
-# Create a sell order
-order = ems_client.Sell_by_Name(
+order = ems.Sell_by_Name(
     symbolName="فملی",
     Price=50000,
     Volume=5
 )
+
 order.send()
 
-# Check status
 status = order.Status()
 print(status)
 
-# Edit order
 order.Edit(Price=52000, Volume=6)
 
-# Delete order
 order.Delete()
-print(order.is_deleted)  # True
 ```
 
-> All methods for Async and Sync clients have the same parameters and naming for easy switching.
+------------------------------------------------------------------------
+
+## Unified API Design
+
+All Sync and Async clients share:
+
+-   Same method names
+-   Same parameters
+-   Same return types
+
+Only execution model differs.
+
+This enables seamless switching between modes.
+
+------------------------------------------------------------------------
+
+## Error Handling
+
+-   Invalid credentials raise ValueError
+-   Network errors should be handled by user
+-   Failed requests may return None
+
+Recommended: wrap calls in try/except.
+
+------------------------------------------------------------------------
+
+## Performance
+
+-   Non-blocking Async I/O
+-   Connection pooling
+-   Optimized request batching
+-   Suitable for HFT and Algo Trading
+
+------------------------------------------------------------------------
+
+## Security
+
+-   JWT Authentication
+-   Encrypted Transport (HTTPS)
+-   No password storage
+-   Session isolation
+
+------------------------------------------------------------------------
 
-## Important Notes for Users
+## Best Practices
 
-* This SDK requires Python >=3.10.
-* The SDK is currently in **Beta** — APIs may change in future releases, but it is usable for most workflows.
-* Always install dependencies with the specified versions to avoid compatibility issues.
-* Async clients require an asyncio event loop.
-* All main clients are exposed through top-level modules; you do not need to access internal files.
-* Keywords and classifiers are chosen to make the SDK easy to find for developers working in finance, trading, and data analysis.
+-   Refresh tokens regularly
+-   Monitor order status
+-   Avoid duplicate send()
+-   Validate inputs
+-   Log critical operations
+
+------------------------------------------------------------------------
 
 ## Modules Overview
 
 ### HedgeTech.Auth
 
-Handles authentication for all HedgeTech clients. The async (`AuthAsyncClient`) and sync (`AuthSyncClient`) clients are exposed through the top-level Auth module.
+Provides:
+
+-   AuthAsyncClient
+-   AuthSyncClient
+-   Token management
+-   Session handling
+
+------------------------------------------------------------------------
 
 ### HedgeTech.DataEngine
 
-Handles interactions with the Tehran Stock Exchange IFB and other engines. Provides:
+Provides:
+
+-   Market data APIs
+-   Historical data
+-   WebSocket feeds
+-   Modular engine design
 
-* Async and sync clients for fetching market data.
-* Structured request and response types for predictable and robust data handling.
-* Modular design that allows integration of additional engines, such as WebSocket clients or future data engines, without modifying the main interface.
+------------------------------------------------------------------------
 
 ### HedgeTech.EMSEngine
 
-Handles TSE/IFB order management (EMS Engine):
+Provides:
+
+-   EmsEngine_TseIfb_AsyncClient
+-   EmsEngine_TseIfb_SyncClient
+-   Order class
+-   Lifecycle management
+
+------------------------------------------------------------------------
+
+## Roadmap
+
+-   Auto session refresh
+-   Smart retry system
+-   Risk control module
+-   Order batching
+-   Metrics & Monitoring
+-   Strategy framework
 
-* `EmsEngine_TseIfb_AsyncClient` / `EmsEngine_TseIfb_SyncClient`
-* `Order` class for individual order lifecycle
-* Methods: `Buy_by_Name`, `Sell_by_Name`, `Buy_by_isin`, `Sell_by_isin`, `Edit`, `Status`, `Delete`
-* Fully compatible with both Async and Sync workflows
+------------------------------------------------------------------------
 
 ## Contributing
 
-We welcome contributions from the community! Please follow standard Python coding conventions, write clear documentation for any new features, and submit pull requests for improvements or bug fixes.
+We welcome contributions.
+
+Guidelines:
+
+-   Follow PEP8
+-   Add tests
+-   Update documentation
+-   Submit Pull Requests
+
+------------------------------------------------------------------------
 
 ## License
 
-This project is licensed under the **Apache License 2.0**. See the LICENSE file for full details.
+Licensed under Apache License 2.0.
+
+See LICENSE file.
+
+------------------------------------------------------------------------
 
 ## Support
 
-For questions or issues, please open a GitHub issue or contact the HedgeTech team directly. We aim to provide timely support and guidance for all developers using the SDK.
+GitHub Issues: https://github.com/HedgeTech-ir/HedgeTech/issues
+
+Email: info@hedgetech.ir
+
+------------------------------------------------------------------------
+
+© 2026 HedgeTech. All rights reserved.