pypsx-toolkit 3.0.4__tar.gz → 3.1.0__tar.gz

{pypsx_toolkit-3.0.4 → pypsx_toolkit-3.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pypsx-toolkit
-Version: 3.0.4
+Version: 3.1.0
 Summary: Pakistan Stock Exchange (PSX) data library with yfinance-like API
 Author-email: PyPSX Team <pypsxofficial@gmail.com>
 Maintainer-email: PyPSX Team <pypsxofficial@gmail.com>
@@ -35,6 +35,8 @@ 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: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Office/Business :: Financial
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
@@ -45,9 +47,9 @@ License-File: LICENSE
 Requires-Dist: requests>=2.31.0
 Requires-Dist: beautifulsoup4>=4.12.0
 Requires-Dist: lxml>=4.9.0
-Requires-Dist: pandas<2.3.3,>=2.0.0
+Requires-Dist: pandas<3.0.0,>=2.0.0
 Requires-Dist: loguru>=0.7.0
-Requires-Dist: numpy<2.3.0,>=1.24.0
+Requires-Dist: numpy<2.4.0,>=1.24.0
 Requires-Dist: tqdm>=4.66.0
 Provides-Extra: plot
 Requires-Dist: matplotlib>=3.5.0; extra == "plot"
@@ -217,7 +219,7 @@ ticker = pypsx_toolkit.PSXTicker("OGDC")
 - `ticker.history(period="1y", interval="1d")` - Get historical data
 - `ticker.intraday()` - Get intraday trades (last ~2 days)
 - `ticker.get_historical(start_date, end_date)` - Get full OHLCV data for date range
-- `ticker.dividends()` - Get dividend information (external source)
+- `ticker.dividends()` - Get dividend information
 - `ticker.announcements()` - Get company announcements
 - `ticker.orderbook()` - Get trading board data (bid/ask prices)
 
@@ -592,24 +594,25 @@ for insight in analysis["portfolio_insights"]:
 
 ### PSXTicker Class
 
-<!-- pypsx-test: skip: API signature reference, not executable code (shows type annotations in call position) -->
 ```python
-ticker = pypsx_toolkit.PSXTicker(symbol: str)
+import pypsx_toolkit
+
+ticker = pypsx_toolkit.PSXTicker("OGDC")
 
-# Properties
+# Properties (no parentheses)
 ticker.info                    # Dict with company info
 ticker.snapshot                # Dict with comprehensive snapshot data from all tabs
-ticker.fast_info              # Quick metrics dict
+ticker.fast_info               # Quick metrics dict
 
 # Methods
-ticker.history(period="1y", interval="1d")    # Historical data
-ticker.intraday()                             # Intraday trades
-ticker.get_historical(start_date, end_date)   # Full OHLCV data
-ticker.market_watch()                         # Market watch row
-ticker.sector()                               # Sector information
-ticker.orderbook()                            # Trading board data
-ticker.dividends()                            # DataFrame with dividends
-ticker.announcements()                        # DataFrame with announcements
+ticker.history(period="1y", interval="1d")            # Historical data
+ticker.intraday()                                     # Intraday trades
+ticker.get_historical("2024-01-01", "2024-12-31")     # Full OHLCV data
+ticker.market_watch()                                 # Market watch row
+ticker.sector()                                       # Sector information
+ticker.orderbook()                                    # Trading board data
+ticker.dividends()                                    # DataFrame with dividends
+ticker.announcements()                                # DataFrame with announcements
 ```
 
 ### Market Functions
@@ -638,11 +641,14 @@ pypsx_toolkit.get_snapshot(symbol)              # Get snapshot data from all tab
 
 ### Download Functions
 
-<!-- pypsx-test: skip: API signature reference; parameter names are placeholders, not bound values -->
 ```python
-pypsx_toolkit.download(symbols, period="1y", interval="1d")    # Batch download
-pypsx_toolkit.get_intraday_multiple(symbols)                   # Multiple intraday
-pypsx_toolkit.get_historical(symbol, start_date, end_date)    # Historical OHLCV
+import pypsx_toolkit
+
+symbols = ["OGDC", "HBL"]
+
+pypsx_toolkit.download(symbols, period="1y", interval="1d")         # Batch download
+pypsx_toolkit.get_intraday_multiple(symbols)                        # Multiple intraday
+pypsx_toolkit.get_historical("OGDC", "2024-01-01", "2024-12-31")    # Historical OHLCV
 ```
 
 ## Backward Compatibility
@@ -653,7 +659,7 @@ The library maintains backward compatibility:
 
 ## Notes
 
-- **Dividends**: PSX doesn't provide a dividends endpoint. The `dividends` property uses an external data source.
+- **Dividends**: dividend records use their own column naming, which differs from the conventions used elsewhere in the toolkit.
 - **Data Availability**: Some data may not be available when the market is closed.
 - **Symbol Names**: Use official PSX symbols (e.g., "OGDC", "PPL", "KEL").
 

{pypsx_toolkit-3.0.4 → pypsx_toolkit-3.1.0}/README.md

@@ -151,7 +151,7 @@ ticker = pypsx_toolkit.PSXTicker("OGDC")
 - `ticker.history(period="1y", interval="1d")` - Get historical data
 - `ticker.intraday()` - Get intraday trades (last ~2 days)
 - `ticker.get_historical(start_date, end_date)` - Get full OHLCV data for date range
-- `ticker.dividends()` - Get dividend information (external source)
+- `ticker.dividends()` - Get dividend information
 - `ticker.announcements()` - Get company announcements
 - `ticker.orderbook()` - Get trading board data (bid/ask prices)
 
@@ -526,24 +526,25 @@ for insight in analysis["portfolio_insights"]:
 
 ### PSXTicker Class
 
-<!-- pypsx-test: skip: API signature reference, not executable code (shows type annotations in call position) -->
 ```python
-ticker = pypsx_toolkit.PSXTicker(symbol: str)
+import pypsx_toolkit
+
+ticker = pypsx_toolkit.PSXTicker("OGDC")
 
-# Properties
+# Properties (no parentheses)
 ticker.info                    # Dict with company info
 ticker.snapshot                # Dict with comprehensive snapshot data from all tabs
-ticker.fast_info              # Quick metrics dict
+ticker.fast_info               # Quick metrics dict
 
 # Methods
-ticker.history(period="1y", interval="1d")    # Historical data
-ticker.intraday()                             # Intraday trades
-ticker.get_historical(start_date, end_date)   # Full OHLCV data
-ticker.market_watch()                         # Market watch row
-ticker.sector()                               # Sector information
-ticker.orderbook()                            # Trading board data
-ticker.dividends()                            # DataFrame with dividends
-ticker.announcements()                        # DataFrame with announcements
+ticker.history(period="1y", interval="1d")            # Historical data
+ticker.intraday()                                     # Intraday trades
+ticker.get_historical("2024-01-01", "2024-12-31")     # Full OHLCV data
+ticker.market_watch()                                 # Market watch row
+ticker.sector()                                       # Sector information
+ticker.orderbook()                                    # Trading board data
+ticker.dividends()                                    # DataFrame with dividends
+ticker.announcements()                                # DataFrame with announcements
 ```
 
 ### Market Functions
@@ -572,11 +573,14 @@ pypsx_toolkit.get_snapshot(symbol)              # Get snapshot data from all tab
 
 ### Download Functions
 
-<!-- pypsx-test: skip: API signature reference; parameter names are placeholders, not bound values -->
 ```python
-pypsx_toolkit.download(symbols, period="1y", interval="1d")    # Batch download
-pypsx_toolkit.get_intraday_multiple(symbols)                   # Multiple intraday
-pypsx_toolkit.get_historical(symbol, start_date, end_date)    # Historical OHLCV
+import pypsx_toolkit
+
+symbols = ["OGDC", "HBL"]
+
+pypsx_toolkit.download(symbols, period="1y", interval="1d")         # Batch download
+pypsx_toolkit.get_intraday_multiple(symbols)                        # Multiple intraday
+pypsx_toolkit.get_historical("OGDC", "2024-01-01", "2024-12-31")    # Historical OHLCV
 ```
 
 ## Backward Compatibility
@@ -587,7 +591,7 @@ The library maintains backward compatibility:
 
 ## Notes
 
-- **Dividends**: PSX doesn't provide a dividends endpoint. The `dividends` property uses an external data source.
+- **Dividends**: dividend records use their own column naming, which differs from the conventions used elsewhere in the toolkit.
 - **Data Availability**: Some data may not be available when the market is closed.
 - **Symbol Names**: Use official PSX symbols (e.g., "OGDC", "PPL", "KEL").
 

{pypsx_toolkit-3.0.4 → pypsx_toolkit-3.1.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pypsx-toolkit"
-version = "3.0.4"
+version = "3.1.0"
 description = "Pakistan Stock Exchange (PSX) data library with yfinance-like API"
 readme = "README.md"
 # 3.10 is the real floor: `pandas>=2.0` already excludes 3.8/3.9, and
@@ -28,6 +28,8 @@ classifiers = [
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Programming Language :: Python :: 3.14",
   "Programming Language :: Python :: 3 :: Only",
   "Topic :: Office/Business :: Financial",
   "Topic :: Software Development :: Libraries :: Python Modules",
@@ -38,9 +40,13 @@ dependencies = [
   "requests>=2.31.0",
   "beautifulsoup4>=4.12.0",
   "lxml>=4.9.0",
-  "pandas>=2.0.0,<2.3.3",
+  # See pypsx_dev/pyproject.toml's identical pins for the reasoning: the
+  # ceiling must not exclude the first cp314-wheel release (pandas 2.3.3,
+  # numpy 2.3.2), and is deliberately kept below pandas 3.0 (mandatory CoW +
+  # other breaking changes) pending its own review.
+  "pandas>=2.0.0,<3.0.0",
   "loguru>=0.7.0",
-  "numpy>=1.24.0,<2.3.0",
+  "numpy>=1.24.0,<2.4.0",
   # Imported by api.py, endpoints/historical.py and core/utils.py. Those imports
   # are try/except-guarded with a no-op fallback, but the fallback path is
   # untested and every target environment (including Colab) already ships tqdm.

{pypsx_toolkit-3.0.4 → pypsx_toolkit-3.1.0}/pypsx_toolkit/__init__.py

@@ -2,7 +2,7 @@
 PSX yfinance-style API
 """
 
-__version__ = "3.0.4"
+__version__ = "3.1.0"
 __author__ = "PyPSX Team"
 __email__ = "pypsxofficial@gmail.com"
 

{pypsx_toolkit-3.0.4 → pypsx_toolkit-3.1.0}/pypsx_toolkit/api.pyi

@@ -6,9 +6,10 @@ import pandas as pd
 
 def download(
     symbols: Union[str, List[str]],
-    period: str = "1mo",
+    period: str = "1y",
     interval: str = "1d",
     to_csv: Optional[str] = None,
+    show_progress: bool = True,
 ) -> pd.DataFrame:
     """
     Download historical OHLCV data for one or more PSX symbols (yfinance-style).
@@ -18,6 +19,8 @@ def download(
         period: Time period — "1d","5d","1mo","3mo","6mo","1y","2y","5y","10y","ytd","max".
         interval: Bar interval. Only "1d" is currently supported.
         to_csv: Optional path to save the result as CSV.
+        show_progress: Display a progress bar while fetching. Set False in
+            notebooks, reports or logs where the bar is just noise.
 
     Returns:
         For a single symbol: DataFrame with [Open, High, Low, Close, Volume, Change%].
@@ -73,12 +76,17 @@ def get_intraday(symbol: str) -> pd.DataFrame:
     ...
 
 
-def get_intraday_multiple(symbols: List[str]) -> pd.DataFrame:
+def get_intraday_multiple(
+    symbols: List[str],
+    show_progress: bool = True,
+) -> pd.DataFrame:
     """
     Fetch intraday tick data for multiple symbols in parallel.
 
     Args:
         symbols: List of PSX ticker symbols.
+        show_progress: Display a progress bar while fetching. Set False in
+            notebooks, reports or logs where the bar is just noise.
 
     Returns:
         Concatenated DataFrame with an additional "Symbol" column.

{pypsx_toolkit-3.0.4 → pypsx_toolkit-3.1.0}/setup.py

@@ -85,6 +85,27 @@ def main():
                 # embedsignature=True: embeds the Python call signature in the docstring
                 # so IDEs can show it even when the .pyi stub is absent.
                 "embedsignature": True,
+                # annotation_typing defaults to True, which makes Cython treat a
+                # PEP 484 parameter annotation like
+                # `def correlation_matrix(df_dict: Dict[str, pd.DataFrame])`
+                # as a `cdef dict` declaration and enforce it at the C level.
+                #
+                # Two problems, both COMPILED-ONLY -- they cannot reproduce from
+                # source, which is the worst possible failure mode here:
+                #
+                #  1. Cython's builtin-container coercion is exact-type-only, so
+                #     passing an OrderedDict/defaultdict/Counter to a
+                #     Dict[...]-annotated parameter raises TypeError even though
+                #     it is a perfectly good Mapping.
+                #  2. It pre-empts the library's own validation. The argument
+                #     checks in analysis/stats.py exist to say "correlation_matrix()
+                #     expects {symbol: DataFrame}, got a single DataFrame" -- but
+                #     with annotation_typing on, Cython rejects the call first with
+                #     a terse message naming neither the function nor the fix.
+                #
+                # pypsx set this to False for the same reason; the toolkit had
+                # been left on the default.
+                "annotation_typing": False,
             },
             build_dir="build",
             annotate=False,