From c4b3d7109f88e3aa445b97168a8907d762de1efe Mon Sep 17 00:00:00 2001 From: Nelson Torres Date: Thu, 30 Jan 2025 02:56:32 +0000 Subject: [PATCH] Max pain docs. --- examples/max_pain_readme.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/examples/max_pain_readme.rst b/examples/max_pain_readme.rst index e69de29b..c24907a6 100644 --- a/examples/max_pain_readme.rst +++ b/examples/max_pain_readme.rst @@ -0,0 +1,19 @@ +## Max Pain Calculation for Deribit Options + +This feature, which calculates the max pain point for options traded on the Deribit exchange using cryptofeed library. + +- Functions in the api module for fetching options data from Deribit. [commit](https://pikers.dev/pikers/piker/commit/da55856dd2876291f55a06eb0561438a912d8241) + +- Compute the max pain point based on open interest data using deribit's api. [commit](https://pikers.dev/pikers/piker/commit/0d9d6e15ba0edeb662ec97f7599dd66af3046b94) + +### How to test it? + +**Before start:** in order to get this working with `uv`, you **must** use my `tractor` [fork](https://pikers.dev/ntorres/tractor/src/branch/aio_abandons) and this branch: `aio_abandons`, the reason is that I cherry-pick the `uv_migration` that guille made, for some reason that a didn't dive into, in my system y need tractor using `uv` too. quite hacky I guess. + +1. `uv lock` + +2. `uv run --no-dev python examples/max_pain.py` + +3. A message should be display, enter one of the expiration date available. + +4. The script should be up and running.