grvt-pysdk 0.1.0

GRVT Python SDK

GRVT Python SDK

---

Installation

pip install grvt-pysdk

Usage

There are various ways to use the GRVT Python SDK

• GRVT CCXT - CCXT compatible client for GRVT
• GRVT CCXT Pro - CCXT Pro compatible client for GRVT
• GRVT API Sync - Synchronous API client for GRVT
• GRVT API Async - Asynchronous API client for GRVT

Contributor's guide

Table of Contents

• Prerequisites
• Installation
• What's in the box ?
• Testing
• Docker

---

Prerequisites

• Python >=3.12.3 <3.13 (tested with 3.12.5)
• pre-commit
• uv >=0.3.3 (tested with 0.4.0)
• docker (optional)

---

Installation

1. Clone the git repository

   git clone https://github.com/grvt-technologies/grvt-pysdk.git
   

2. Go into the project directory

   cd grvt-pysdk/
   

3. Checkout working branch

   git checkout <branch>
   

4. Install dependencies

   make install
   

5. Enable pre-commit hooks

   pre-commit install
   

---

What's in the box ?

uv

uv is an extremely fast Python package and project manager, written in Rust.

pyproject.toml file (pyproject.toml): orchestrate your project and its dependencies uv.lock file (uv.lock): ensure that the package versions are consistent for everyone working on your project

For more configuration options and details, see the configuration docs.

pre-commit

pre-commit is a framework for managing and maintaining multi-language pre-commit hooks.

.pre-commit-config.yaml file (.pre-commit-config.yaml): describes what repositories and hooks are installed

For more configuration options and details, see the configuration docs.

ruff

ruff is an extremely fast Python linter, written in Rust.

Rules are defined in the pyproject.toml.

For more configuration options and details, see the configuration docs.

mypy

mypy is an optional static type checker for Python that aims to combine the benefits of dynamic (or "duck") typing and static typing.

Rules are defined in the pyproject.toml.

For more configuration options and details, see the configuration docs.

bandit

bandit is a tool designed to find common security issues in Python code.

Rules are defined in the pyproject.toml.

For more configuration options and details, see the configuration docs.

docformatter

docformatter is a tool designed to format docstrings to follow PEP 257.

Options are defined in the .pre-commit-config.yaml.

---

Testing

We are using pytest & pytest-cov to write tests.

To run tests with coverage:

make test

Output

collected 4 items                                                                                                                                                                                                        

tests/pysdk/test_grvt_api_async.py::test_get_all_instruments PASSED                                                                                                                                                [ 25%]
tests/pysdk/test_grvt_api_async.py::test_open_orders PASSED                                                                                                                                                        [ 50%]
tests/pysdk/test_grvt_api_sync.py::test_get_all_instruments PASSED                                                                                                                                                 [ 75%]
tests/pysdk/test_grvt_api_sync.py::test_open_orders PASSED                                                                                                                                                         [100%]

---------- coverage: platform darwin, python 3.12.5-final-0 ----------
Name                          Stmts   Miss  Cover
-------------------------------------------------
src/pysdk/__init__.py             1      0   100%
src/pysdk/grvt_api_async.py     152    113    26%
src/pysdk/grvt_api_base.py      158     75    53%
src/pysdk/grvt_api_sync.py      152    113    26%
src/pysdk/grvt_env.py            27      4    85%
src/pysdk/types.py              909      0   100%
-------------------------------------------------
TOTAL                          1399    305    78%


=================================================================================================== 4 passed in 1.20s ====================================================================================================

Makefile

We are using Makefile to manage the project.

To see the list of commands:

make

➜  grvt-pysdk git:(main) ✗ make
help                           Show this help
run                            Run the project
test                           Run the tests
precommit                      Run the pre-commit hooks
lint                           Run the linter
format                         Run the formatter
typecheck                      Run the type checker
security                       Run the security checker
clean                          Clean the project
install                        Install the project

---