Metadata-Version: 2.1
Name: hg_oap
Version: 0.1.9
Summary: A library to faciliate building order and pricing strategies
License: MIT
Keywords: reactive,graph,fpg,forward propogating graph,time series,functional reactive programming,order,pricing,oms
Author: Howard Henson
Author-email: howard@henson.me.uk
Requires-Python: >=3.11
Classifier: Development Status :: 3 - Alpha
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Dist: hgraph (>=0.3.24)
Requires-Dist: holidays (>=0.56)
Project-URL: Changelog, https://github.com/hhenson/hg_oap/blob/main/CHANGELOG.md
Project-URL: Documentation, https://github.com/hhenson/hg_oap/blob/main/docs/index.md
Project-URL: Homepage, https://github.com/hhenson/hg_oap
Project-URL: Issues, https://github.com/hhenson/hg_oap/blob/main/ISSUES.md
Project-URL: Repository, https://github.com/hhenson/hg_oap.git
Description-Content-Type: text/markdown

# HGraph Orders and Pricing Library

Provides a library, based on the hgraph functional reactive framework to
support creating order and pricing logic.

The core components of the library include:

* instruments
* positions
* portfolios
* orders
* pricing

This library is currently very green and is expected to have significant changes.


## Development

The project is currently configured to make use of [Poetry](https://python-poetry.org) for dependency management. 
Take a look at the website to see how best to install the tool.
Once you have checked out the project, you can install the project for development using the following command:

This is optional, but you can ensure python uses the version of python you require.

```bash
poetry env use 3.11
```

Then use the following command to install the project and it's depenencies:

```bash
poetry install
```

Then you can find the location of the installation using:

```bash
poetry env info
```

PyCharm can make use of poetry to ``setup`` the project.

### Run Tests

```bash
# No Coverage
poetry run pytest
```

```bash
# Generate Coverage Report
poetry run pytest --cov=your_package_name --cov-report=xml
```
