Metadata-Version: 2.1
Name: openyieldtables
Version: 2.60.0
Summary: 
Home-page: https://github.com/treely/openyieldtables
License: MIT
Author: Tree.ly
Author-email: hello@tree.ly
Maintainer: FMM
Maintainer-email: fmm@fmm.at
Requires-Python: >=3.9,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: pandas (>=2.2.1,<3.0.0)
Requires-Dist: pydantic (>=2.6.4,<3.0.0)
Project-URL: Documentation, https://openyieldtables.readthedocs.io
Project-URL: Repository, https://github.com/treely/openyieldtables
Description-Content-Type: text/markdown

<img src="https://cdn.tree.ly/assets/v4/yield-tables/logo_white_background.svg" alt="Yield Tables logo" width="280"/>

[![PyPI - Version](https://img.shields.io/pypi/v/openyieldtables)](https://pypi.org/project/openyieldtables/) [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/openyieldtables)](https://pypi.org/project/openyieldtables/) ![Test](https://github.com/github/docs/actions/workflows/test.yml/badge.svg) [![Documentation Status](https://readthedocs.org/projects/openyieldtables/badge/?version=latest)](https://openyieldtables.readthedocs.io/en/latest/?badge=latest)

An open source Python library for yield tables.

## Quickstart

Download the latest version of the library from [PyPI](https://pypi.org/project/openyieldtables/):

```bash
pip install openyieldtables
```

Import the library and load a yield table:

```python
from openyieldtables.yieldtables import (
    get_yield_table,
    get_yield_tables_meta,
)

# Get the metadata of all available yield tables
yield_tables_meta = get_yield_tables_meta()

# Get the data of a yield table by its ID
yield_table_data = get_yield_table(1)
```

## Documentation

You can find the documentation
[here](https://openyieldtables.readthedocs.io/en/latest/).

## Contributing

We are happy about every contribution! Please follow our
[contribution guideline](https://github.com/treely/openyieldtables/blob/main/CONTRIBUTING.md).

## About

`openyieldtables` is maintained by [Tree.ly](https://tree.ly) and
[FMM](https://www.fmm.at/).

