Incorrect Type in futures/market.py

[will-j-c]

Describe the bug
Not a bug per se as the library runs but "resolution" in the method get_ohlc() of Market has the wrong type declared ("int" instead of "str") causing false error detection in IDEs.

To Reproduce
Steps to reproduce the behavior:

Open a new file

from kraken.futures import Market

if __name__ == '__main__':
    x = Market().get_ohlc(tick_type="trade", symbol="PI_XBTUSD", resolution="1h")
    print(x)

For example, in Vs Code, the resolution parameter will cause the below error:

Argument of type "Literal['1h']" cannot be assigned to parameter "resolution" of type "int" in function "get_ohlc"
"Literal['1h']" is not assignable to "int"PylancereportArgumentType

Expected behavior
A string is the correct input so the error should not appear.

Additional context
This is a very quick fix, simply changing the type to "str" on line 86 of market.py.

I'm happy to do so in a PR and do some additional spot checks but wanted to raise the issue first given its a small issue.

[btschwertfeger]

Hey @will-j-c, the case is valid. Feel free to open a PR to address this issue.

[will-j-c]

I've read the contribution guidelines and readme but experiencing some issues setting up the dev environment.

A few questions:

• Is there a requirements.txt to install dependencies? I only see the dev dependencies.
• What commands do we need to run the tests? pytest results in a lot of errors
• Pre-commit doesn't install as a dev dependency so unclear how to proceed.
• Any other points to consider?

I've made the small change but want to run the tests etc first before opening the pull request.

[btschwertfeger]

I've read the contribution guidelines and readme but experiencing some issues setting up the dev environment.

A few questions:

• Is there a requirements.txt to install dependencies? I only see the dev dependencies.
• What commands do we need to run the tests? pytest results in a lot of errors
• Pre-commit doesn't install as a dev dependency so unclear how to proceed.
• Any other points to consider?

I've made the small change but want to run the tests etc first before opening the pull request.

I'm currently on holidays and will respond properly right after coming back mid Feb.

[will-j-c]

No problem, enjoy the holidays! Happy to collaborate more generally.

[btschwertfeger]

So, @will-j-c, I finally found time to answer your questions.

• the doc/requirements.txt file is only needed when building the documentation, usually within CI.
• the top-level requirements-dev.txt containts non-runtime dependencies used for testing. I'm now opening a PR to extend this file to include the package itself and the doc-requirements as well.
• Pre-commit is considered as system dependency as it its a tool usually used without being scoped to a single project. Thus it is not listed as dependency that is to be directly installed. (e.g. via uv tool install pre-commit or uv tool install prek and then running pre-commit install or prek install within the current repository)
• The tests run via pytest, while some are implemented in bash as well. You can run make test or simply check the CI workflow files on how to execute the tests yourself. This project is a basic Python project that can be simply installed, tested, and used as any other Python project:

  # assuming you are using uv instead of pip and virtualenv 
  uv venv venv
  source venv/bin/activate
  
  uv pip install -e . -r requirements-dev.txt # or simply `make dev`
  uv run pytest -vv tests/spot/<some-module.py>

Since your PR may only involve the change of a type annotation, your can most likely skip the pre-commit etc setup stuff as this is also checked during CI as well. If you really want to test everything, you would also need to setup your environment to contain all the API keys needed by the tests (make sure that they don't have trade permission!). But I don't think that this is necessary.

Just let me know if there is something missing.