Skip to content

Latest commit

 

History

History
62 lines (41 loc) · 1.23 KB

README.md

File metadata and controls

62 lines (41 loc) · 1.23 KB

DriftPy

DriftPy is the Python client for the Drift protocol. It allows you to trade and fetch data from Drift using Python.

Read the full SDK documentation here!

Installation

pip install driftpy

Note: requires Python >= 3.10.

SDK Examples

  • examples/ folder includes more examples of how to use the SDK including how to provide liquidity/become an lp, stake in the insurance fund, etc.

Setting Up Dev Env

bash setup.sh

Building the docs

Local Docs: mkdocs serve

Updating public docs: poetry run mkdocs gh-deploy --force

Releasing a new version of the package

Development

Ensure correct python version (using pyenv is recommended):

pyenv install 3.10.11
pyenv global 3.10.11
poetry env use $(pyenv which python)

Install dependencies:

poetry install

Run tests:

poetry run bash test.sh

Run Acceptance Tests

poetry run bash acceptance_test.sh