diff --git a/examples/max_pain_readme.rst b/examples/max_pain_readme.rst index c24907a6..8b0b76bd 100644 --- a/examples/max_pain_readme.rst +++ b/examples/max_pain_readme.rst @@ -1,19 +1,29 @@ ## Max Pain Calculation for Deribit Options -This feature, which calculates the max pain point for options traded on the Deribit exchange using cryptofeed library. +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) +- 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) +- 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. +**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. +3. A message should be display, enter one of the expiration date + available. 4. The script should be up and running.