Metadata-Version: 2.5
Name: pse-sdk
Version: 2.0.0
Summary: Unofficial Python SDK for the PSE (Polskie Sieci Elektroenergetyczne) public REST API
Project-URL: Homepage, https://github.com/FranekGit/pse-python-sdk
Project-URL: Documentation, https://github.com/FranekGit/pse-python-sdk/blob/main/docs/usage.md
Project-URL: Changelog, https://github.com/FranekGit/pse-python-sdk/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/FranekGit/pse-python-sdk/issues
Author: FranekGit
License-Expression: MIT
License-File: LICENSE.md
Keywords: electricity,energy,poland,pse
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: Typing :: Typed
Requires-Python: >=3.10
Requires-Dist: requests>=2.28
Provides-Extra: pandas
Requires-Dist: pandas>=1.5; extra == 'pandas'
Description-Content-Type: text/markdown

<p align="center">
  <img src="https://raw.githubusercontent.com/FranekGit/pse-python-sdk/main/assets/pse_logo.png" alt="PSE Logo">
</p>

# pse-python-sdk

![Version](https://img.shields.io/badge/version-v2.0.0-blue)

Python SDK for the PSE (Polskie Sieci Elektroenergetyczne) public reporting API.

> API reference: https://api.raporty.pse.pl/app/home


> **Disclaimer:** not affiliated with PSE S.A.


## Installation

```bash
pip install pse-sdk
```

## Quick Start

```python
from pse_sdk import PSEClient

client = PSEClient()

# list[dict] with all columns
rows = client.fetch("price-cost", start="2025-10-01", end="2025-10-31")

# pd.DataFrame (requires pandas) with selected columns
df = client.fetch(
    "price-cost",
    start="2025-10-01",
    end="2025-10-31",
    columns=["cen_cost", "ckoeb_cost"],
    format="dataframe",
)
```

## Documentation

- [docs/usage.md](https://github.com/FranekGit/pse-python-sdk/blob/main/docs/usage.md): finding endpoints, date ranges, columns and
  output formats
- [docs/endpoints.md](https://github.com/FranekGit/pse-python-sdk/blob/main/docs/endpoints.md): all endpoints, their columns and
  types
