pypsx 2.6.3__tar.gz → 2.7.0__tar.gz

{pypsx-2.6.3 → pypsx-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypsx
-Version: 2.6.3
+Version: 2.7.0
 Summary: Pakistan Stock Exchange (PSX) Trading SDK for Paper Trading and Backtesting
 Author: PyPSX Team
 License: Proprietary

{pypsx-2.6.3 → pypsx-2.7.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pypsx"
-version = "2.6.3"
+version = "2.7.0"
 description = "Pakistan Stock Exchange (PSX) Trading SDK for Paper Trading and Backtesting"
 readme = "README.md"
 requires-python = ">=3.10"

{pypsx-2.6.3 → pypsx-2.7.0}/pypsx/__init__.py

@@ -37,6 +37,15 @@ from .universe import (
 # from pypsx.utils. PyPSXError is the base class for every pypsx exception.
 from .utils.exceptions import PyPSXError, UniverseDataError
 
+# PSX history archive functions, imported on first use (see __getattr__ below).
+_ARCHIVE_NAMES = frozenset({
+    "ArchiveError", "RateLimitError", "get_historical", "get_corporate_actions", "get_announcements", "get_companies", "get_calendar",
+    "get_indices", "get_index_history", "get_index_members", "get_intraday_archive", "get_intraday_sessions",
+    "get_fundamentals", "get_futures_open_interest", "get_futures_position_limits", "get_var_haircuts",
+    "get_circuit_limits", "get_post_close", "get_block_trades", "get_margin_trading", "get_market_workbook",
+    "get_archive_status",
+})
+
 # Deprecated: Trader class for local execution (kept for backward compatibility)
 # Lazy imports to avoid loading trader_core (which imports backtesting engine) 
 # when backend only needs data services like PyPSXService
@@ -91,6 +100,12 @@ def __getattr__(name: str):
     # Simplified public API (pypsx.api) - one-line data fetching and backtesting.
     # BacktestResult is the documented return type of backtest(); users need it
     # for isinstance checks and type annotations.
+    # PSX history archive (pypsx/archive.py): a thin client for the server's /v1 archive API.
+    if name in _ARCHIVE_NAMES:
+        from . import archive
+        obj = getattr(archive, name)
+        setattr(module, name, obj)
+        return obj
     if name in (
         "download",
         "get_ohlcv",
@@ -118,7 +133,7 @@ def __getattr__(name: str):
 #     PortfolioService,
 # )
 
-__version__ = "2.6.3"
+__version__ = "2.7.0"
 
 __all__ = [
     # Primary API - account-aware client
@@ -148,6 +163,29 @@ __all__ = [
     "get_market_depth",
     "backtest",
     "BacktestResult",
+    # PSX history archive (1998-today history, corporate actions, indices, intraday archive, market activity)
+    "ArchiveError",
+    "RateLimitError",
+    "get_historical",
+    "get_corporate_actions",
+    "get_announcements",
+    "get_companies",
+    "get_calendar",
+    "get_indices",
+    "get_index_history",
+    "get_index_members",
+    "get_intraday_archive",
+    "get_intraday_sessions",
+    "get_fundamentals",
+    "get_futures_open_interest",
+    "get_futures_position_limits",
+    "get_var_haircuts",
+    "get_circuit_limits",
+    "get_post_close",
+    "get_block_trades",
+    "get_margin_trading",
+    "get_market_workbook",
+    "get_archive_status",
     # Utilities
     "indicators",
     "validation",

{pypsx-2.6.3 → pypsx-2.7.0}/pypsx/__init__.pyi

@@ -27,6 +27,7 @@ def download(
     end: str | None = ...,
     period: str | None = ...,
     interval: str = ...,
+    adjust_splits: bool = ...,
 ) -> _pd.DataFrame: ...
 def get_ohlcv(
     symbols,
@@ -34,6 +35,7 @@ def get_ohlcv(
     end: str | None = ...,
     period: str | None = ...,
     interval: str = ...,
+    adjust_splits: bool = ...,
 ) -> _pd.DataFrame: ...
 def get_intraday(
     symbols,
@@ -41,7 +43,40 @@ def get_intraday(
     end: str | None = ...,
     period: str | None = ...,
     interval: str = ...,
+    session_date: str | None = ...,
 ) -> _pd.DataFrame: ...
+
+# PSX history archive (pypsx/archive.py): thin client of the server's /v1 archive API.
+import datetime as _dt
+from typing import Any as _Any, Union as _Union
+_DateLike = _Union[str, _dt.date, _dt.datetime, None]
+class ArchiveError(Exception):
+    detail: str
+    status_code: int | None
+class RateLimitError(Exception):
+    retry_after: float | None
+    limit: _Any
+    resource: _Any
+def get_historical(symbol: str, start: _DateLike = ..., end: _DateLike = ..., adjust_splits: bool = ..., total_return: bool = ..., dividends: bool = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_corporate_actions(symbol: str | None = ..., start: _DateLike = ..., end: _DateLike = ..., kind: str | None = ..., include_quarantined: bool = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_announcements(symbol: str, start: _DateLike = ..., end: _DateLike = ..., contains: str | None = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_companies(q: str | None = ..., listed: bool | None = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_calendar(start: _DateLike = ..., end: _DateLike = ...) -> _pd.DataFrame: ...
+def get_indices() -> _pd.DataFrame: ...
+def get_index_history(index: str, start: _DateLike = ..., end: _DateLike = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_index_members(index: str, date: _DateLike = ...) -> _pd.DataFrame: ...
+def get_intraday_archive(symbol: str, session_date: _DateLike) -> _pd.DataFrame: ...
+def get_intraday_sessions(symbol: str) -> _pd.DataFrame: ...
+def get_fundamentals(symbol: str, statement: str | None = ..., wide: bool = ...) -> _pd.DataFrame: ...
+def get_futures_open_interest(symbol: str, start: _DateLike = ..., end: _DateLike = ..., date: _DateLike = ..., *, detail: bool = ..., max_rows: int = ...) -> _pd.DataFrame: ...
+def get_futures_position_limits(symbol: str, start: _DateLike = ..., end: _DateLike = ..., date: _DateLike = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_var_haircuts(symbol: str | None = ..., start: _DateLike = ..., end: _DateLike = ..., date: _DateLike = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_circuit_limits(symbol: str | None = ..., start: _DateLike = ..., end: _DateLike = ..., date: _DateLike = ..., market: str | None = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_post_close(symbol: str | None = ..., start: _DateLike = ..., end: _DateLike = ..., date: _DateLike = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_block_trades(date: _DateLike = ..., symbol: str | None = ..., start: _DateLike = ..., end: _DateLike = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_margin_trading(symbol: str | None = ..., start: _DateLike = ..., end: _DateLike = ..., date: _DateLike = ..., kind: str = ..., *, max_rows: int = ...) -> _pd.DataFrame: ...
+def get_market_workbook(year: int | None = ..., sheet: str | None = ...) -> _pd.DataFrame: ...
+def get_archive_status() -> dict[str, _Any]: ...
 def get_quote(symbol: str) -> dict: ...
 def get_market_depth(symbol: str) -> dict: ...
 def backtest(