HedgeTech 0.0.0__py3-none-any.whl → 0.1.0__py3-none-any.whl

{hedgetech-0.0.0.dist-info → hedgetech-0.1.0.dist-info}/METADATA

@@ -1,7 +1,7 @@
 Metadata-Version: 2.4
 Name: HedgeTech
-Version: 0.0.0
-Summary: Core SDK for integrating with HedgeTech trading and market data APIs
+Version: 0.1.0
+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
                                    Version 2.0, January 2004
@@ -182,22 +182,184 @@ License:                                  Apache License
         
            Copyright 2025 HedgeTech
            Licensed under the Apache License, Version 2.0
-Project-URL: Homepage, https://github.com/HedgeTech-ir/HedgeTech
+Project-URL: Homepage, https://hedgetech.ir/landing/
 Project-URL: Documentation, https://github.com/HedgeTech-ir/HedgeTech/blob/main/README.md
 Project-URL: Repository, https://github.com/HedgeTech-ir/HedgeTech
-Keywords: hedge,finance,trading,oms,api,market-data,execution,orderbook,algo-trading,async,sdk
+Keywords: hedge,finance,financial-markets,stocks,equities,trading,algo-trading,algorithmic-trading,automated-trading,oms,order-management-system,execution,orderbook,real-time,high-frequency,portfolio-management,risk-management,market-data,exchange-api,sdk,python,async,websocket
 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: License :: OSI Approved :: Apache Software License
 Classifier: Operating System :: OS Independent
-Classifier: Development Status :: 3 - Alpha
+Classifier: Development Status :: 4 - Beta
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: Financial and Insurance Industry
-Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Office/Business :: Financial
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: System :: Networking
+Classifier: Topic :: Internet :: WWW/HTTP
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Framework :: AsyncIO
+Classifier: Typing :: Typed
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
 License-File: NOTICE
-Requires-Dist: httpx[http2]==0.28.1
+Requires-Dist: httpx[http2]<=0.28.1
+Requires-Dist: brotli<=1.2.0
+Requires-Dist: zstd<=1.5.7.2
+Requires-Dist: PyJWT<=2.10.1
+Requires-Dist: websockets<=15.0.1
 Dynamic: license-file
 
-HedgeTech
+# 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.
+
+> **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.
+
+## Features
+
+* Secure authentication with both async and sync clients.
+* Real-time and historical market data retrieval from TSE & IFB.
+* 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.
+
+## Installation
+
+Install HedgeTech SDK via PyPI:
+
+```
+pip install HedgeTech
+```
+
+### Updating the Package
+
+To update HedgeTech SDK to the latest version in your environment, use:
+
+```
+pip install --upgrade HedgeTech
+```
+
+## Usage
+
+The SDK exposes all major clients through the top-level modules, so you generally do **not** need to import internal implementation files directly.
+
+### Authentication
+
+> **Note:** Make sure to use the matching async or sync Auth client depending on your workflow.
+
+#### Async Authentication
+
+```python
+from HedgeTech.Auth import AuthAsyncClient
+
+auth_async_client = await AuthAsyncClient.login(
+    UserName_or_Email='<YOUR UserName_or_Email>',
+    Password='<YOUR Password>'
+)
+print(auth_async_client.token)
+```
+
+#### Sync Authentication
+
+```python
+from HedgeTech.Auth import AuthSyncClient
+
+auth_sync_client = AuthSyncClient.login(
+    UserName_or_Email='<YOUR UserName_or_Email>',
+    Password='<YOUR Password>'
+)
+print(auth_sync_client.token)
+```
+
+### DataEngine / TSE IFB
+
+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.
+
+> **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.
+
+#### Async Data Client
+
+```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']
+)
+print(data)
+
+# websocket Example
+
+async for update in client.websocket_by_name(
+    channels=["best-limit", "order-book"],
+    symbol_names=["فملی","اطلس"]
+):
+
+    print(update["data"])
+```
+
+#### Sync Data Client
+
+```python
+from HedgeTech.DataEngine import DataEngine_TseIfb_SyncClient
+
+client = DataEngine_TseIfb_SyncClient(auth_sync_client)
+data = client.historical_ohlcv_by_name(
+    symbolName='مهرگان',
+    start_timestamp=0,
+    end_timestamp='1763411432',
+    AdjustedPrice=True,
+    Resolution='D'
+)
+print(data)
+
+# websocket Example
+
+for update in client.websocket_by_isin(
+    channels=["best-limit", "order-book"],
+    symbol_isins=["IR1234567890"]
+):
+
+    print(update["data"])
+```
+
+## Important Notes for Users
+
+* 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.
+
+## 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.
+
+### HedgeTech.DataEngine
+
+Handles interactions with the Tehran Stock Exchange IFB and other engines. Provides:
+
+* 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.
+
+## 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.
+
+## License
+
+This project is licensed under the **Apache License 2.0**. See the LICENSE file for full details.
+
+## 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.

hedgetech-0.1.0.dist-info/RECORD

@@ -0,0 +1,16 @@
+HedgeTech/Auth/__AuthAsyncClient.py,sha256=ZWYTxg-idzFxOChbVvHbEmfZRMyiinI-yzPuWZGQeag,4850
+HedgeTech/Auth/__AuthSyncClient.py,sha256=e5KiQ9aQD-_ztUrLr_GP3EcCzCeS6_wLkdRzl_nQ8Y8,4804
+HedgeTech/Auth/__init__.py,sha256=2Ek8ZkhrRi0D7ewhMH4pyK0iqxe_FfpGBSEIu3-tsik,91
+HedgeTech/DataEngine/__init__.py,sha256=qoIZgB8J3UFDDGr0-ViiyEirTzcOy0hhL4a6E6rl2d8,94
+HedgeTech/DataEngine/__tse_ifb/__AsyncClient.py,sha256=8cBF_f5ekKyH9Xceb0fMdUK1sWyLQQlfp_LB1rMyrl0,60357
+HedgeTech/DataEngine/__tse_ifb/__SyncClient.py,sha256=84yexoW7Vb_sMlT3VnXTDPA7HGEfmkiC7AEYbryJF4Y,58431
+HedgeTech/DataEngine/__tse_ifb/__init__.py,sha256=fNfmOjNXiOYTAcOgIzSXP5J1XzyX4v5urviCSwYpoyY,111
+HedgeTech/DataEngine/__tse_ifb/__io_types/__init__.py,sha256=MRShofLnx6Qm0-olFt5CrJjjoNk-785BxUnO8VC1Clo,895
+HedgeTech/DataEngine/__tse_ifb/__io_types/__requests.py,sha256=x_Rc7afQahJpIq4beKctmmqRmTvipnViHICUZRj0Z-I,1601
+HedgeTech/DataEngine/__tse_ifb/__io_types/__response.py,sha256=pMzjM8biVuEya62MHGU4guUCqNmhOHOToGXLS21uxc0,70442
+hedgetech-0.1.0.dist-info/licenses/LICENSE,sha256=RzVH4fFelGlKDPcfQUnkbkri8Xu-bsauTM5FpraQ4NM,10251
+hedgetech-0.1.0.dist-info/licenses/NOTICE,sha256=as8VRMsbPsDe5W_cX1xPxPVHPDL8PqGGzHgn5IZF26U,171
+hedgetech-0.1.0.dist-info/METADATA,sha256=RCgXBFSp729u9TpsOsOHNoJ3LgKWnfL741iOKMiGnHo,18993
+hedgetech-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+hedgetech-0.1.0.dist-info/top_level.txt,sha256=dlpgpN4ktclL9B5cS_dchuncCOf5JYPs_bobRAw3-ng,10
+hedgetech-0.1.0.dist-info/RECORD,,

hedgetech-0.0.0.dist-info/RECORD

@@ -1,7 +0,0 @@
-HedgeTech/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-hedgetech-0.0.0.dist-info/licenses/LICENSE,sha256=RzVH4fFelGlKDPcfQUnkbkri8Xu-bsauTM5FpraQ4NM,10251
-hedgetech-0.0.0.dist-info/licenses/NOTICE,sha256=as8VRMsbPsDe5W_cX1xPxPVHPDL8PqGGzHgn5IZF26U,171
-hedgetech-0.0.0.dist-info/METADATA,sha256=qdCMsmkrWF4ASLXE3CyZmYHcTpdRQjwixqvfxR5Tujg,12725
-hedgetech-0.0.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-hedgetech-0.0.0.dist-info/top_level.txt,sha256=dlpgpN4ktclL9B5cS_dchuncCOf5JYPs_bobRAw3-ng,10
-hedgetech-0.0.0.dist-info/RECORD,,