Metadata-Version: 2.4
Name: divflowpsx
Version: 0.1.2
Summary: Delayed Pakistan Stock Exchange (PSX) market data for Python — DividendFlow
Author-email: DividendFlow PK <hello@dividendflow.pk>
License: MIT
Project-URL: Homepage, https://dividendflow.pk
Project-URL: Repository, https://github.com/AmmarJamshed/DividendFlowPK
Project-URL: Issues, https://github.com/AmmarJamshed/DividendFlowPK/issues
Keywords: PSX,Pakistan,stock,market,dividends,finance,delayed
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Office/Business :: Financial :: Investment
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pandas>=2.0
Requires-Dist: playwright>=1.40
Provides-Extra: dev
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Requires-Dist: pytest; extra == "dev"
Dynamic: license-file

# divflowpsx

Delayed **Pakistan Stock Exchange (PSX)** market data for Python, from [DividendFlow](https://dividendflow.pk).

> **Not for live trading.** Quotes are intentionally delayed by **at least 10 seconds**. For research and education only — not buy/sell advice.

## Install

```bash
pip install -U divflowpsx
```

That is enough. Playwright and Chromium are pulled in automatically (`playwright` is a package dependency; Chromium downloads on first `get_board()` / `get_payouts()` if missing).

### Google Colab

```python
!pip install -U divflowpsx

import divflowpsx
print(divflowpsx.__version__)  # 0.1.2+

board = divflowpsx.get_board()  # may download Chromium once, then scrape
print(board.head())
```

> First call can take a few minutes (browser download + PSX scrape) and is delayed ≥ 10 seconds.

## Quick start

```python
import divflowpsx

# Full board (DataFrame) — delayed ≥ 10s
board = divflowpsx.get_board()
print(board.head())

# Single symbol
q = divflowpsx.get_quote("HBL")
print(q)

# Session changes
movers = divflowpsx.get_changes()

# Dividend / payout announcements
payouts = divflowpsx.get_payouts()
```

### Custom delay / client

```python
from divflowpsx import Client

client = Client(delay_seconds=10)
df = client.get_board()
```

## Notes

- Data is scraped from the public PSX DPS portal (`dps.psx.com.pk`).
- Dependencies (`pandas`, `playwright`) install with pip; Chromium is auto-installed on first use.
- Requires network access on first scrape.

## License

MIT © DividendFlow PK
