Metadata-Version: 2.4
Name: polstr
Version: 0.1.1
Summary: Downloader for public POLSTR index data from GPW Benchmark.
Author: solek13
License-Expression: MIT
Project-URL: Homepage, https://github.com/solek13/polstr
Project-URL: Repository, https://github.com/solek13/polstr
Project-URL: Issues, https://github.com/solek13/polstr/issues
Keywords: polstr,gpw-benchmark,interest-rates,market-data,csv
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Financial and Insurance Industry
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
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: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Office/Business :: Financial
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: beautifulsoup4
Requires-Dist: pdfplumber
Requires-Dist: requests
Provides-Extra: dev
Requires-Dist: build>=1.2; extra == "dev"
Requires-Dist: twine>=5; extra == "dev"
Dynamic: license-file

# POLSTR data downloader

A small Python utility that downloads historical and current POLSTR index data
published by [GPW Benchmark](https://gpwbenchmark.pl/) and combines it into one
CSV file.

The generated CSV has these columns:

- `date`
- `polstr`
- `polstr_1m`
- `polstr_3m`
- `polstr_6m`
- `polstr_ci`

## Installation

From PyPI:

```console
python -m pip install polstr
```

Directly from GitHub:

```console
python -m pip install git+https://github.com/solek13/polstr.git
```

From a local checkout:

```console
python -m pip install -e .
```

## Usage

Update `polstr.csv` in the project directory:

```console
polstr
```

Other useful options:

```console
polstr --start-year 2024 --out my.csv
polstr --no-pdf
polstr --latest-only
polstr --full-refresh
```

The script can still be run directly from a checkout with
`python download_polstr.py`. Run `polstr --help` for the complete command
reference.

## Packaging

Build the source distribution and wheel locally:

```console
python -m pip install -e .[dev]
python -m build
python -m twine check dist/*
```

## Data source

The script downloads public POLSTR data from GPW Benchmark's yearly PDF files,
delayed-data page, and values-and-statistics page. Please consult GPW
Benchmark's website for the authoritative data and applicable terms of use.

## License

MIT License. See `LICENSE`.
