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

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

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: pypsx-toolkit
-Version: 3.0.2
+Version: 3.0.4
 Summary: Pakistan Stock Exchange (PSX) data library with yfinance-like API
-Author-email: PyPSX Team <contact@pypsx.dev>
-Maintainer-email: PyPSX Team <contact@pypsx.dev>
+Author-email: PyPSX Team <pypsxofficial@gmail.com>
+Maintainer-email: PyPSX Team <pypsxofficial@gmail.com>
 License: Copyright (c) 2026 PyPSX Team. All rights reserved.
         
         This software and associated documentation files (the "Software") are the
@@ -32,8 +32,6 @@ Classifier: Intended Audience :: Financial and Insurance Industry
 Classifier: License :: Other/Proprietary License
 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
@@ -41,15 +39,16 @@ Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Topic :: Office/Business :: Financial
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Classifier: Topic :: Scientific/Engineering :: Information Analysis
-Requires-Python: >=3.8
+Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 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.0.0
+Requires-Dist: pandas<2.3.3,>=2.0.0
 Requires-Dist: loguru>=0.7.0
-Requires-Dist: numpy>=1.24.0
+Requires-Dist: numpy<2.3.0,>=1.24.0
+Requires-Dist: tqdm>=4.66.0
 Provides-Extra: plot
 Requires-Dist: matplotlib>=3.5.0; extra == "plot"
 Requires-Dist: seaborn>=0.11.0; extra == "plot"
@@ -67,7 +66,7 @@ Dynamic: license-file
 
 # pypsx-toolkit — Pakistan Stock Exchange Data Library
 
-A clean, simple Python library to fetch and analyze Pakistan Stock Exchange (PSX) data from official DPS endpoints. Get real-time market data, historical prices, and powerful analysis tools all in one package — no authentication required.
+A clean, simple Python library to fetch and analyze Pakistan Stock Exchange (PSX) market data. Get real-time market data, historical prices, and powerful analysis tools all in one package — no authentication required.
 
 ## Installation
 
@@ -505,17 +504,6 @@ historical = ticker.get_historical(
 print(historical.head())
 ```
 
-## Data Sources
-
-PyPSX Toolkit uses official Pakistan Stock Exchange DPS endpoints:
-- Market Watch: `https://dps.psx.com.pk/market-watch`
-- Sector Summary: `https://dps.psx.com.pk/sector-summary/sectorwise`
-- Indices: `https://dps.psx.com.pk/indices/{INDEX}`
-- Trading Board: `https://dps.psx.com.pk/trading-board/REG/main`
-- Performers: `https://dps.psx.com.pk/performers`
-- Timeseries: `https://dps.psx.com.pk/timeseries/int/{SYMBOL}`, `.../eod/{SYMBOL}`
-- Historical OHLCV: `https://dps.psx.com.pk/historical`
-
 ## Examples
 
 ### Example 1: Find Top Volume Stocks
@@ -604,6 +592,7 @@ 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)
 
@@ -649,6 +638,7 @@ 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-3.0.2 → pypsx_toolkit-3.0.4}/README.md

@@ -1,6 +1,6 @@
 # pypsx-toolkit — Pakistan Stock Exchange Data Library
 
-A clean, simple Python library to fetch and analyze Pakistan Stock Exchange (PSX) data from official DPS endpoints. Get real-time market data, historical prices, and powerful analysis tools all in one package — no authentication required.
+A clean, simple Python library to fetch and analyze Pakistan Stock Exchange (PSX) market data. Get real-time market data, historical prices, and powerful analysis tools all in one package — no authentication required.
 
 ## Installation
 
@@ -438,17 +438,6 @@ historical = ticker.get_historical(
 print(historical.head())
 ```
 
-## Data Sources
-
-PyPSX Toolkit uses official Pakistan Stock Exchange DPS endpoints:
-- Market Watch: `https://dps.psx.com.pk/market-watch`
-- Sector Summary: `https://dps.psx.com.pk/sector-summary/sectorwise`
-- Indices: `https://dps.psx.com.pk/indices/{INDEX}`
-- Trading Board: `https://dps.psx.com.pk/trading-board/REG/main`
-- Performers: `https://dps.psx.com.pk/performers`
-- Timeseries: `https://dps.psx.com.pk/timeseries/int/{SYMBOL}`, `.../eod/{SYMBOL}`
-- Historical OHLCV: `https://dps.psx.com.pk/historical`
-
 ## Examples
 
 ### Example 1: Find Top Volume Stocks
@@ -537,6 +526,7 @@ 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)
 
@@ -582,6 +572,7 @@ 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-3.0.2 → pypsx_toolkit-3.0.4}/pyproject.toml

@@ -4,16 +4,18 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pypsx-toolkit"
-version = "3.0.2"
+version = "3.0.4"
 description = "Pakistan Stock Exchange (PSX) data library with yfinance-like API"
 readme = "README.md"
-requires-python = ">=3.8"
+# 3.10 is the real floor: `pandas>=2.0` already excludes 3.8/3.9, and
+# core/utils.py uses PEP 604 (`int | None`) in a runtime signature.
+requires-python = ">=3.10"
 license = { file = "LICENSE" }
 authors = [
-  { name = "PyPSX Team", email = "contact@pypsx.dev" }
+  { name = "PyPSX Team", email = "pypsxofficial@gmail.com" }
 ]
 maintainers = [
-  { name = "PyPSX Team", email = "contact@pypsx.dev" }
+  { name = "PyPSX Team", email = "pypsxofficial@gmail.com" }
 ]
 keywords = ["psx", "pakistan", "stock", "finance", "data", "api", "pandas", "yfinance", "market-data"]
 classifiers = [
@@ -23,8 +25,6 @@ classifiers = [
   "License :: Other/Proprietary License",
   "Operating System :: OS Independent",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.8",
-  "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
@@ -38,9 +38,13 @@ dependencies = [
   "requests>=2.31.0",
   "beautifulsoup4>=4.12.0",
   "lxml>=4.9.0",
-  "pandas>=2.0.0",
+  "pandas>=2.0.0,<2.3.3",
   "loguru>=0.7.0",
-  "numpy>=1.24.0",
+  "numpy>=1.24.0,<2.3.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.
+  "tqdm>=4.66.0",
 ]
 
 [project.optional-dependencies]
@@ -61,8 +65,12 @@ Homepage = "https://pypsx.com"
 Documentation = "https://markets.pypsx.com/docs"
 Changelog = "https://markets.pypsx.com/docs/changelog"
 
-[project.scripts]
-pypsx-toolkit = "pypsx_toolkit:quick_start"
+# NOTE: no [project.scripts]. This previously declared
+#   pypsx-toolkit = "pypsx_toolkit:quick_start"
+# but `quick_start` does not exist anywhere in the package, so the installed
+# console script raised AttributeError on every invocation. This library has no
+# CLI; removing the entry point is the honest fix. If a CLI is wanted later,
+# implement the target function first.
 
 [tool.setuptools]
 include-package-data = true
@@ -152,8 +160,10 @@ markers = [
   "integration: marks tests as integration tests",
   "unit: marks tests as unit tests",
 ]
-filterwarnings = [
-  "ignore::DeprecationWarning",
-  "ignore::PendingDeprecationWarning",
-]
+# NOTE: deliberately no blanket `filterwarnings = ["ignore::DeprecationWarning"]`
+# here. The Colab-mirror suite (b2c/tests/colab_mirror/) runs under
+# `filterwarnings = error` because a warning in a notebook cell is a user-visible
+# defect. A blanket ignore at this level hides exactly the class of bug that
+# suite exists to catch. Allow-list individual warnings there, with an owner and
+# an expiry, instead of re-adding a catch-all.
 

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

@@ -2,9 +2,9 @@
 PSX yfinance-style API
 """
 
-__version__ = "3.0.2"
+__version__ = "3.0.4"
 __author__ = "PyPSX Team"
-__email__ = "pypsx@example.com"
+__email__ = "pypsxofficial@gmail.com"
 
 from pypsx_toolkit.ticker import PSXTicker, Ticker
 
@@ -37,6 +37,14 @@ from pypsx_toolkit.endpoints.sectors import get_sector_constituents as _get_sect
 from pypsx_toolkit.endpoints.compliant_listings import get_symbols_by_sector as _get_symbols_by_sector
 from pypsx_toolkit.endpoints.snapshot import get_snapshot
 
+# Financial reports. Implemented and working, but previously not reachable from
+# anywhere in the public surface.
+from pypsx_toolkit.endpoints.reports import get_reports
+
+# Cache control. Useful in notebooks, where a stale cached response is a common
+# source of "why is my data wrong" confusion.
+from pypsx_toolkit.core.cache import clear_pypsx_cache, get_cache_stats
+
 from pypsx_toolkit.market import (
     top_performers,
     sector_summary,
@@ -70,18 +78,29 @@ from pypsx_toolkit.models import (
     DividendHistory,
 )
 
-# Analysis module (optional - requires analysis package)
-try:
-    from pypsx_toolkit.analysis import (
-        interpret_stock,
-        sharpe_ratio,
-        rsi,
-        macd,
-        bollinger_bands,
-    )
-except ImportError:
-    # Analysis module not available
-    pass
+# Exceptions. Previously these were reachable only via the private
+# `pypsx_toolkit.core.errors` path, which the docs told users to import from.
+# Re-exported here as the supported location; the old path still works.
+from pypsx_toolkit.core.errors import (
+    PSXError,
+    PSXHTTPError,
+    PSXTimeoutError,
+    PSXNotFoundError,
+    PSXScopeError,
+)
+
+# Analysis module. This is NOT optional -- it depends only on pandas and numpy,
+# both hard requirements of this package. It was previously wrapped in a
+# `try/except ImportError: pass`, which silently turned any genuine bug inside
+# the analysis package into a confusing AttributeError at call time.
+from pypsx_toolkit import analysis
+from pypsx_toolkit.analysis import (
+    interpret_stock,
+    sharpe_ratio,
+    rsi,
+    macd,
+    bollinger_bands,
+)
 
 __all__ = [
     "__version__",
@@ -129,6 +148,14 @@ __all__ = [
     "get_sector_constituents",
     "get_symbols_by_sector",
     "get_snapshot",
+    "get_reports",
+    # Cache control
+    "clear_pypsx_cache",
+    "get_cache_stats",
+    # NOTE: `charts` is deliberately NOT listed here. It resolves lazily via
+    # __getattr__ and needs the optional `[plot]` extra, so including it would
+    # make `from pypsx_toolkit import *` raise ImportError on a plain install.
+    # Access it as `pypsx_toolkit.charts` (see the Charting docs).
     # Models
     "SymbolInfo",
     "SectorSummary",
@@ -147,8 +174,53 @@ __all__ = [
     "Announcement",
     "DividendInfo",
     "DividendHistory",
+    # Exceptions. Also available at the original `pypsx_toolkit.core.errors` path.
+    "PSXError",
+    "PSXHTTPError",
+    "PSXTimeoutError",
+    "PSXNotFoundError",
+    "PSXScopeError",
+    # Analysis. `analysis` is the submodule (documented usage is
+    # `import pypsx_toolkit.analysis as pa`); the rest are convenience
+    # re-exports that were importable before but absent from __all__.
+    "analysis",
+    "interpret_stock",
+    "sharpe_ratio",
+    "rsi",
+    "macd",
+    "bollinger_bands",
 ]
 
+# `market_watch_func` / `get_indices_func` are internal aliases created to avoid
+# colliding with the same-named api.py functions. They stay bound for backward
+# compatibility but are deliberately excluded from __all__ above -- they are not
+# part of the supported surface. Use `market_watch()` / `get_indices()`.
+
+
+def __getattr__(name: str):
+    """
+    Lazily expose `pypsx_toolkit.charts`.
+
+    The charting helpers need matplotlib/seaborn, which ship only under the
+    optional `[plot]` extra. Importing them eagerly would make a plain
+    `pip install pypsx-toolkit` fail at `import pypsx_toolkit`, so resolution is
+    deferred until first access and a missing extra produces an actionable
+    message instead of a bare ModuleNotFoundError.
+    """
+    if name == "charts":
+        import sys
+
+        try:
+            from pypsx_toolkit.endpoints import charts as _charts
+        except ImportError as exc:  # pragma: no cover - depends on install extras
+            raise ImportError(
+                "pypsx_toolkit.charts requires the optional plotting dependencies. "
+                "Install them with:  pip install 'pypsx-toolkit[plot]'"
+            ) from exc
+        setattr(sys.modules[__name__], "charts", _charts)
+        return _charts
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
 
 # Legacy compatibility wrappers used by audit script (clean outputs only)
 

{pypsx_toolkit-3.0.2 → pypsx_toolkit-3.0.4}/pypsx_toolkit/analysis/__init__.py

@@ -70,7 +70,16 @@ __all__ = [
     
     # Insight engine
     'interpret_stock', 'interpret_portfolio', 'detect_patterns',
-    'generate_trading_signals', 'market_sentiment_analysis'
+    'generate_trading_signals', 'market_sentiment_analysis',
+
+    # Composite helpers (defined in this module, below)
+    'quick_analysis', 'portfolio_analysis',
+
+    # Short aliases (defined at the bottom of this module). These are used in
+    # the published documentation, so they are part of the supported surface.
+    'ma', 'ema', 'bb', 'sharpe', 'sortino', 'calmar', 'cum_returns', 'max_dd',
+    'win_rate_pct', 'pl_ratio', 'recovery', 'perf_summary', 'interpret',
+    'patterns', 'signals', 'sentiment',
 ]
 
 

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

@@ -61,8 +61,6 @@ def get_intraday(symbol: str) -> pd.DataFrame:
     """
     Fetch intraday tick data for the last 2 trading days.
 
-    Runs on the user's local machine to distribute scraping traffic.
-
     Args:
         symbol: PSX ticker symbol.
 

pypsx_toolkit-3.0.4/setup.py

@@ -0,0 +1,103 @@
+"""
+Cython build configuration for pypsx.
+
+Compiles all implementation modules into platform-specific binary extensions
+(.pyd on Windows, .so on Linux/macOS). __init__.py, models.py, and constants.py
+are intentionally excluded so they remain as plain-text Python re-exporters.
+"""
+import os
+import glob
+from setuptools import setup, Extension, find_packages
+from setuptools.command.build_py import build_py as _build_py
+from Cython.Build import cythonize
+
+# Stems that must stay as plain Python (pickling, isinstance, re-exports)
+EXCLUDE_STEMS = {"__init__", "constants", "models"}
+
+# Folders to skip entirely
+EXCLUDE_DIRS = {"backend", "build", "dist", "tests", "__pycache__", ".git"}
+
+
+# os.name == "nt" does not imply MSVC -- CC/CXX may point at a mingw
+# toolchain (e.g. w64devkit) for local builds without Visual Studio, and
+# mingw's gcc/g++ reject MSVC-style "/O2" the same way MSVC would reject "-O2".
+_USING_MSVC = os.name == "nt" and "gcc" not in os.environ.get("CC", "").lower()
+_OPT_FLAG = "/O2" if _USING_MSVC else "-O2"
+
+
+def collect_extensions(pkg_root: str):
+    extensions = []
+    for path in glob.glob(f"{pkg_root}/**/*.py", recursive=True):
+        # Normalise separators
+        norm = path.replace("\\", "/")
+
+        # Skip excluded directories
+        parts = norm.split("/")
+        if any(p in EXCLUDE_DIRS for p in parts):
+            continue
+
+        stem = os.path.splitext(os.path.basename(path))[0]
+        if stem in EXCLUDE_STEMS:
+            continue
+
+        # Convert path to dotted module name (e.g. pypsx/core/fetchers.py -> pypsx.core.fetchers)
+        module = norm.replace("/", ".")[:-3]
+        extensions.append(
+            Extension(
+                module,
+                [path],
+                extra_compile_args=[_OPT_FLAG],
+            )
+        )
+    return extensions
+
+
+class build_py(_build_py):
+    """
+    Drop .py source for modules that get Cython-compiled, so wheels ship only
+    the compiled extension (+ .pyi stub) for them -- MANIFEST.in's
+    include/exclude rules only govern sdist content, NOT bdist_wheel, so
+    without this override every wheel ships the full readable .py source
+    right alongside the .pyd/.so, silently defeating the whole point of
+    compiling in the first place.
+    """
+
+    def find_package_modules(self, package, package_dir):
+        modules = super().find_package_modules(package, package_dir)
+        return [(pkg, mod, path) for (pkg, mod, path) in modules if mod in EXCLUDE_STEMS]
+
+
+def main():
+    extensions = collect_extensions("pypsx_toolkit")
+
+    setup(
+        cmdclass={"build_py": build_py},
+        packages=find_packages(
+            exclude=["backend*", "build*", "dist*", "tests*", "*.egg-info*"]
+        ),
+        ext_modules=cythonize(
+            extensions,
+            compiler_directives={
+                "language_level": "3",
+                # binding=True: wraps compiled functions so inspect.signature() works.
+                # Required if FastAPI or any DI framework introspects function args.
+                "binding": True,
+                # embedsignature=True: embeds the Python call signature in the docstring
+                # so IDEs can show it even when the .pyi stub is absent.
+                "embedsignature": True,
+            },
+            build_dir="build",
+            annotate=False,
+            nthreads=4,
+        ),
+        package_data={"": ["*.pyi", "py.typed"]},
+        zip_safe=False,
+    )
+
+
+if __name__ == "__main__":
+    # cythonize(nthreads=4) spawns a multiprocessing pool. On Windows
+    # (spawn start method) child processes reimport this file as __main__;
+    # without this guard, each child re-enters main() and re-spawns its own
+    # pool, crashing the whole build with BrokenProcessPool.
+    main()

pypsx_toolkit-3.0.2/setup.py

@@ -1,70 +0,0 @@
-"""
-Cython build configuration for pypsx.
-
-Compiles all implementation modules into platform-specific binary extensions
-(.pyd on Windows, .so on Linux/macOS). __init__.py, models.py, and constants.py
-are intentionally excluded so they remain as plain-text Python re-exporters.
-"""
-import os
-import glob
-from setuptools import setup, Extension, find_packages
-from Cython.Build import cythonize
-
-# Stems that must stay as plain Python (pickling, isinstance, re-exports)
-EXCLUDE_STEMS = {"__init__", "constants", "models"}
-
-# Folders to skip entirely
-EXCLUDE_DIRS = {"backend", "build", "dist", "tests", "__pycache__", ".git"}
-
-
-def collect_extensions(pkg_root: str):
-    extensions = []
-    for path in glob.glob(f"{pkg_root}/**/*.py", recursive=True):
-        # Normalise separators
-        norm = path.replace("\\", "/")
-
-        # Skip excluded directories
-        parts = norm.split("/")
-        if any(p in EXCLUDE_DIRS for p in parts):
-            continue
-
-        stem = os.path.splitext(os.path.basename(path))[0]
-        if stem in EXCLUDE_STEMS:
-            continue
-
-        # Convert path to dotted module name (e.g. pypsx/core/fetchers.py -> pypsx.core.fetchers)
-        module = norm.replace("/", ".")[:-3]
-        extensions.append(
-            Extension(
-                module,
-                [path],
-                extra_compile_args=["/O2"] if os.name == "nt" else ["-O2"],
-            )
-        )
-    return extensions
-
-
-extensions = collect_extensions("pypsx_toolkit")
-
-setup(
-    packages=find_packages(
-        exclude=["backend*", "build*", "dist*", "tests*", "*.egg-info*"]
-    ),
-    ext_modules=cythonize(
-        extensions,
-        compiler_directives={
-            "language_level": "3",
-            # binding=True: wraps compiled functions so inspect.signature() works.
-            # Required if FastAPI or any DI framework introspects function args.
-            "binding": True,
-            # embedsignature=True: embeds the Python call signature in the docstring
-            # so IDEs can show it even when the .pyi stub is absent.
-            "embedsignature": True,
-        },
-        build_dir="build",
-        annotate=False,
-        nthreads=4,
-    ),
-    package_data={"": ["*.pyi", "py.typed"]},
-    zip_safe=False,
-)