Metadata-Version: 2.3
Name: ohlc-toolkit
Version: 0.2.0
Summary: A flexible toolkit for working with OHLC data and generating custom time frames from minute data.
License: MIT
Keywords: ohlc,price,candlestick,financial,market-data,time-series
Author: Mourits de Beer
Author-email: ff137@proton.me
Requires-Python: >=3.10,<4.0
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: Programming Language :: Python :: 3.13
Provides-Extra: ipyparallel
Requires-Dist: ipyparallel (>=9.0.0,<10.0.0) ; extra == "ipyparallel"
Requires-Dist: loguru (>=0.7.3)
Requires-Dist: numpy (>=2.2.2,<3.0.0)
Requires-Dist: orjson (>=3.10.15,<4.0.0)
Requires-Dist: pandas (>=2.2.2,<3.0.0)
Requires-Dist: pyarrow (>=19.0.0,<20.0.0)
Requires-Dist: tqdm (>=4.66.4,<5.0.0)
Project-URL: Repository, https://github.com/ff137/ohlc-toolkit
Description-Content-Type: text/markdown

# OHLC Toolkit

[![PyPI](https://img.shields.io/pypi/v/ohlc-toolkit)](https://pypi.org/project/ohlc-toolkit/)
![Python](https://img.shields.io/badge/python-3.12-blue.svg)
[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/license/MIT)

A flexible Python toolkit for working with OHLC (Open, High, Low, Close) market data.

## Features

- Read OHLC data from CSV files, with built-in data quality checks

Coming soon™️:

- Process high resolution data (e.g. 1-minute interval data) into any greater time frame
  (e.g. turn 1-minute or 1-hour data into 4-hour or 1-day data)
- Calculate future returns from OHLC data
- Compute technical indicators

## Examples

See the [examples](examples/README.md) directory for examples of how to use the toolkit.

## Installation

The project is available on [PyPI](https://pypi.org/project/ohlc-toolkit/):

```bash
pip install ohlc-toolkit
```

## Support

If you need any help or have any questions, please feel free to open an issue or contact me directly.

We hope this repo makes your life easier! If it does, please give us a star! ⭐

